Merge "Fix positioning of jQuery.tipsy tooltip arrows"
[mediawiki.git] / includes / MediaWiki.php
blob3b5a1b107c9213060f89b70220ca54b12346ff13
1 <?php
2 /**
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
20 * @file
23 use MediaWiki\Logger\LoggerFactory;
25 /**
26 * The MediaWiki class is the helper class for the index.php entry point.
28 class MediaWiki {
29 /**
30 * @var IContextSource
32 private $context;
34 /**
35 * @var Config
37 private $config;
39 /**
40 * @var String Cache what action this request is
42 private $action;
44 /**
45 * @param IContextSource|null $context
47 public function __construct( IContextSource $context = null ) {
48 if ( !$context ) {
49 $context = RequestContext::getMain();
52 $this->context = $context;
53 $this->config = $context->getConfig();
56 /**
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() {
63 global $wgContLang;
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' );
75 } elseif ( $curid ) {
76 // URLs like this are generated by RC, because rc_title isn't always accurate
77 $ret = Title::newFromID( $curid );
78 } else {
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
89 ) {
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
97 // other purposes.
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
103 if ( $oldid ) {
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
110 if ( $ret === null
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 );
125 return $ret;
129 * Get the Title object that we'll be acting on, as specified in the WebRequest
130 * @return Title
132 public function getTitle() {
133 if ( !$this->context->hasTitle() ) {
134 try {
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.
158 * - bad titles
159 * - read restriction
160 * - local interwiki redirects
161 * - redirect loop
162 * - special pages
163 * - normal pages
165 * @throws MWException|PermissionsError|BadTitleError|HttpError
166 * @return void
168 private function performRequest() {
169 global $wgTitle;
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' ) );
188 try {
189 $this->parseTitle();
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' );
222 if ( $rdfrom ) {
223 $url = $title->getFullURL( array( 'rdfrom' => $rdfrom ) );
224 } else {
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 )
231 && $title->isLocal()
233 // 301 so google et al report the target as the actual url.
234 $output->redirect( $url, 301 );
235 } else {
236 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
237 try {
238 $this->parseTitle();
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 );
265 $wgTitle = $target;
266 // Reset action type cache. (Special pages have only view)
267 $this->action = null;
268 $title = $target;
269 $output->addJsConfigVars( array(
270 'wgInternalRedirectTargetUrl' => $target->getFullURL( $query ),
271 ) );
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 );
281 } else {
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 );
289 } else {
290 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle()"
291 . " returned neither an object nor a URL" );
298 * Handle redirects for uncanonical title requests.
300 * Handles:
301 * - Redirect loops.
302 * - No title in URL.
303 * - $wgUsePathInfo URLs.
304 * - URLs with a variant.
305 * - Other non-standard URLs (as long as they have no extra query parameters).
307 * Behaviour:
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.
319 * @throws HttpError
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 ) )
330 return false;
333 if ( $title->isSpecialPage() ) {
334 list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
335 if ( $name ) {
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' );
345 return true;
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 " .
365 "is correct.";
366 } else {
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 " .
371 "to true.";
373 throw new HttpError( 500, $message );
375 return false;
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 mixed An Article, or a string to redirect to another URL
384 private function initializeArticle() {
386 $title = $this->context->getTitle();
387 if ( $this->context->canUseWikiPage() ) {
388 // Try to use request context wiki page, as there
389 // is already data from db saved in per process
390 // cache there from this->getAction() call.
391 $page = $this->context->getWikiPage();
392 $article = Article::newFromWikiPage( $page, $this->context );
393 } else {
394 // This case should not happen, but just in case.
395 $article = Article::newFromTitle( $title, $this->context );
396 $this->context->setWikiPage( $article->getPage() );
399 // Skip some unnecessary code if the content model doesn't support redirects
400 if ( !ContentHandler::getForTitle( $title )->supportsRedirects() ) {
401 return $article;
404 $request = $this->context->getRequest();
406 // Namespace might change when using redirects
407 // Check for redirects ...
408 $action = $request->getVal( 'action', 'view' );
409 $file = ( $title->getNamespace() == NS_FILE ) ? $article->getFile() : null;
410 if ( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
411 && !$request->getVal( 'oldid' ) // ... and are not old revisions
412 && !$request->getVal( 'diff' ) // ... and not when showing diff
413 && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
414 // ... and the article is not a non-redirect image page with associated file
415 && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
417 // Give extensions a change to ignore/handle redirects as needed
418 $ignoreRedirect = $target = false;
420 Hooks::run( 'InitializeArticleMaybeRedirect',
421 array( &$title, &$request, &$ignoreRedirect, &$target, &$article ) );
423 // Follow redirects only for... redirects.
424 // If $target is set, then a hook wanted to redirect.
425 if ( !$ignoreRedirect && ( $target || $article->isRedirect() ) ) {
426 // Is the target already set by an extension?
427 $target = $target ? $target : $article->followRedirect();
428 if ( is_string( $target ) ) {
429 if ( !$this->config->get( 'DisableHardRedirects' ) ) {
430 // we'll need to redirect
431 return $target;
434 if ( is_object( $target ) ) {
435 // Rewrite environment to redirected article
436 $rarticle = Article::newFromTitle( $target, $this->context );
437 $rarticle->loadPageData();
438 if ( $rarticle->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
439 $rarticle->setRedirectedFrom( $title );
440 $article = $rarticle;
441 $this->context->setTitle( $target );
442 $this->context->setWikiPage( $article->getPage() );
445 } else {
446 $this->context->setTitle( $article->getTitle() );
447 $this->context->setWikiPage( $article->getPage() );
451 return $article;
455 * Perform one of the "standard" actions
457 * @param Page $page
458 * @param Title $requestTitle The original title, before any redirects were applied
460 private function performAction( Page $page, Title $requestTitle ) {
462 $request = $this->context->getRequest();
463 $output = $this->context->getOutput();
464 $title = $this->context->getTitle();
465 $user = $this->context->getUser();
467 if ( !Hooks::run( 'MediaWikiPerformAction',
468 array( $output, $page, $title, $user, $request, $this ) )
470 return;
473 $act = $this->getAction();
475 $action = Action::factory( $act, $page, $this->context );
477 if ( $action instanceof Action ) {
478 # Let CDN cache things if we can purge them.
479 if ( $this->config->get( 'UseSquid' ) &&
480 in_array(
481 // Use PROTO_INTERNAL because that's what getCdnUrls() uses
482 wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL ),
483 $requestTitle->getCdnUrls()
486 $output->setCdnMaxage( $this->config->get( 'SquidMaxage' ) );
489 $action->show();
490 return;
493 if ( Hooks::run( 'UnknownAction', array( $request->getVal( 'action', 'view' ), $page ) ) ) {
494 $output->setStatusCode( 404 );
495 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
501 * Run the current MediaWiki instance; index.php just calls this
503 public function run() {
504 try {
505 try {
506 $this->main();
507 } catch ( ErrorPageError $e ) {
508 // Bug 62091: while exceptions are convenient to bubble up GUI errors,
509 // they are not internal application faults. As with normal requests, this
510 // should commit, print the output, do deferred updates, jobs, and profiling.
511 $this->doPreOutputCommit();
512 $e->report(); // display the GUI error
514 } catch ( Exception $e ) {
515 MWExceptionHandler::handleException( $e );
518 $this->doPostOutputShutdown( 'normal' );
522 * @see MediaWiki::preOutputCommit()
523 * @since 1.26
525 public function doPreOutputCommit() {
526 self::preOutputCommit( $this->context );
530 * This function commits all DB changes as needed before
531 * the user can receive a response (in case commit fails)
533 * @param IContextSource $context
534 * @since 1.27
536 public static function preOutputCommit( IContextSource $context ) {
537 // Either all DBs should commit or none
538 ignore_user_abort( true );
540 $config = $context->getConfig();
542 $factory = wfGetLBFactory();
543 // Check if any transaction was too big
544 $limit = $config->get( 'MaxUserDBWriteDuration' );
545 $factory->forEachLB( function ( LoadBalancer $lb ) use ( $limit ) {
546 $lb->forEachOpenConnection( function ( IDatabase $db ) use ( $limit ) {
547 $time = $db->pendingWriteQueryDuration();
548 if ( $limit > 0 && $time > $limit ) {
549 throw new DBTransactionError(
550 $db,
551 wfMessage( 'transaction-duration-limit-exceeded', $time, $limit )->text()
554 } );
555 } );
556 // Commit all changes
557 $factory->commitMasterChanges( __METHOD__ );
558 // Record ChronologyProtector positions
559 $factory->shutdown();
560 wfDebug( __METHOD__ . ': all transactions committed' );
562 DeferredUpdates::doUpdates( 'enqueue', DeferredUpdates::PRESEND );
563 wfDebug( __METHOD__ . ': pre-send deferred updates completed' );
565 // Set a cookie to tell all CDN edge nodes to "stick" the user to the
566 // DC that handles this POST request (e.g. the "master" data center)
567 $request = $context->getRequest();
568 if ( $request->wasPosted() && $factory->hasOrMadeRecentMasterChanges() ) {
569 $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
570 $request->response()->setCookie( 'UseDC', 'master', $expires, array( 'prefix' => '' ) );
573 // Avoid letting a few seconds of slave lag cause a month of stale data
574 if ( $factory->laggedSlaveUsed() ) {
575 $maxAge = $config->get( 'CdnMaxageLagged' );
576 $context->getOutput()->lowerCdnMaxage( $maxAge );
577 $request->response()->header( "X-Database-Lagged: true" );
578 wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
583 * This function does work that can be done *after* the
584 * user gets the HTTP response so they don't block on it
586 * This manages deferred updates, job insertion,
587 * final commit, and the logging of profiling data
589 * @param string $mode Use 'fast' to always skip job running
590 * @since 1.26
592 public function doPostOutputShutdown( $mode = 'normal' ) {
593 $timing = $this->context->getTiming();
594 $timing->mark( 'requestShutdown' );
596 // Show visible profiling data if enabled (which cannot be post-send)
597 Profiler::instance()->logDataPageOutputOnly();
599 $that = $this;
600 $callback = function () use ( $that, $mode ) {
601 try {
602 $that->restInPeace( $mode );
603 } catch ( Exception $e ) {
604 MWExceptionHandler::handleException( $e );
608 // Defer everything else...
609 if ( function_exists( 'register_postsend_function' ) ) {
610 // https://github.com/facebook/hhvm/issues/1230
611 register_postsend_function( $callback );
612 } else {
613 if ( function_exists( 'fastcgi_finish_request' ) ) {
614 fastcgi_finish_request();
615 } else {
616 // Either all DB and deferred updates should happen or none.
617 // The later should not be cancelled due to client disconnect.
618 ignore_user_abort( true );
621 $callback();
625 private function main() {
626 global $wgTitle, $wgTrxProfilerLimits;
628 $request = $this->context->getRequest();
630 // Send Ajax requests to the Ajax dispatcher.
631 if ( $this->config->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
632 // Set a dummy title, because $wgTitle == null might break things
633 $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
634 . __METHOD__
636 $this->context->setTitle( $title );
637 $wgTitle = $title;
639 $dispatcher = new AjaxDispatcher( $this->config );
640 $dispatcher->performAction( $this->context->getUser() );
641 return;
644 // Get title from request parameters,
645 // is set on the fly by parseTitle the first time.
646 $title = $this->getTitle();
647 $action = $this->getAction();
648 $wgTitle = $title;
650 $trxProfiler = Profiler::instance()->getTransactionProfiler();
651 $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
653 if ( $request->wasPosted() ) {
654 $trxProfiler->setExpectations( $wgTrxProfilerLimits['POST'], __METHOD__ );
655 } else {
656 $trxProfiler->setExpectations( $wgTrxProfilerLimits['GET'], __METHOD__ );
659 // If the user has forceHTTPS set to true, or if the user
660 // is in a group requiring HTTPS, or if they have the HTTPS
661 // preference set, redirect them to HTTPS.
662 // Note: Do this after $wgTitle is setup, otherwise the hooks run from
663 // isLoggedIn() will do all sorts of weird stuff.
664 if (
665 $request->getProtocol() == 'http' &&
667 $request->getCookie( 'forceHTTPS', '' ) ||
668 // check for prefixed version for currently logged in users
669 $request->getCookie( 'forceHTTPS' ) ||
670 // Avoid checking the user and groups unless it's enabled.
672 $this->context->getUser()->isLoggedIn()
673 && $this->context->getUser()->requiresHTTPS()
677 $oldUrl = $request->getFullRequestURL();
678 $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
680 // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
681 if ( Hooks::run( 'BeforeHttpsRedirect', array( $this->context, &$redirUrl ) ) ) {
683 if ( $request->wasPosted() ) {
684 // This is weird and we'd hope it almost never happens. This
685 // means that a POST came in via HTTP and policy requires us
686 // redirecting to HTTPS. It's likely such a request is going
687 // to fail due to post data being lost, but let's try anyway
688 // and just log the instance.
690 // @todo FIXME: See if we could issue a 307 or 308 here, need
691 // to see how clients (automated & browser) behave when we do
692 wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
694 // Setup dummy Title, otherwise OutputPage::redirect will fail
695 $title = Title::newFromText( 'REDIR', NS_MAIN );
696 $this->context->setTitle( $title );
697 $output = $this->context->getOutput();
698 // Since we only do this redir to change proto, always send a vary header
699 $output->addVaryHeader( 'X-Forwarded-Proto' );
700 $output->redirect( $redirUrl );
701 $output->output();
702 return;
706 if ( $this->config->get( 'UseFileCache' ) && $title->getNamespace() >= 0 ) {
707 if ( HTMLFileCache::useFileCache( $this->context ) ) {
708 // Try low-level file cache hit
709 $cache = new HTMLFileCache( $title, $action );
710 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
711 // Check incoming headers to see if client has this cached
712 $timestamp = $cache->cacheTimestamp();
713 if ( !$this->context->getOutput()->checkLastModified( $timestamp ) ) {
714 $cache->loadFromFileCache( $this->context );
716 // Do any stats increment/watchlist stuff
717 // Assume we're viewing the latest revision (this should always be the case with file cache)
718 $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
719 // Tell OutputPage that output is taken care of
720 $this->context->getOutput()->disable();
721 return;
726 // Actually do the work of the request and build up any output
727 $this->performRequest();
729 // Now commit any transactions, so that unreported errors after
730 // output() don't roll back the whole DB transaction and so that
731 // we avoid having both success and error text in the response
732 $this->doPreOutputCommit();
734 // Output everything!
735 $this->context->getOutput()->output();
739 * Ends this task peacefully
740 * @param string $mode Use 'fast' to always skip job running
742 public function restInPeace( $mode = 'fast' ) {
743 // Assure deferred updates are not in the main transaction
744 wfGetLBFactory()->commitMasterChanges( __METHOD__ );
746 // Ignore things like master queries/connections on GET requests
747 // as long as they are in deferred updates (which catch errors).
748 Profiler::instance()->getTransactionProfiler()->resetExpectations();
750 // Do any deferred jobs
751 DeferredUpdates::doUpdates( 'enqueue' );
753 // Make sure any lazy jobs are pushed
754 JobQueueGroup::pushLazyJobs();
756 // Now that everything specific to this request is done,
757 // try to occasionally run jobs (if enabled) from the queues
758 if ( $mode === 'normal' ) {
759 $this->triggerJobs();
762 // Log profiling data, e.g. in the database or UDP
763 wfLogProfilingData();
765 // Commit and close up!
766 $factory = wfGetLBFactory();
767 $factory->commitMasterChanges( __METHOD__ );
768 $factory->shutdown( LBFactory::SHUTDOWN_NO_CHRONPROT );
770 wfDebug( "Request ended normally\n" );
774 * Potentially open a socket and sent an HTTP request back to the server
775 * to run a specified number of jobs. This registers a callback to cleanup
776 * the socket once it's done.
778 public function triggerJobs() {
779 $jobRunRate = $this->config->get( 'JobRunRate' );
780 if ( $jobRunRate <= 0 || wfReadOnly() ) {
781 return;
782 } elseif ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
783 return; // recursion guard
786 if ( $jobRunRate < 1 ) {
787 $max = mt_getrandmax();
788 if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
789 return; // the higher the job run rate, the less likely we return here
791 $n = 1;
792 } else {
793 $n = intval( $jobRunRate );
796 $runJobsLogger = LoggerFactory::getInstance( 'runJobs' );
798 if ( !$this->config->get( 'RunJobsAsync' ) ) {
799 // Fall back to running the job here while the user waits
800 $runner = new JobRunner( $runJobsLogger );
801 $runner->run( array( 'maxJobs' => $n ) );
802 return;
805 try {
806 if ( !JobQueueGroup::singleton()->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
807 return; // do not send request if there are probably no jobs
809 } catch ( JobQueueError $e ) {
810 MWExceptionHandler::logException( $e );
811 return; // do not make the site unavailable
814 $query = array( 'title' => 'Special:RunJobs',
815 'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 );
816 $query['signature'] = SpecialRunJobs::getQuerySignature(
817 $query, $this->config->get( 'SecretKey' ) );
819 $errno = $errstr = null;
820 $info = wfParseUrl( $this->config->get( 'Server' ) );
821 MediaWiki\suppressWarnings();
822 $sock = fsockopen(
823 $info['host'],
824 isset( $info['port'] ) ? $info['port'] : 80,
825 $errno,
826 $errstr,
827 // If it takes more than 100ms to connect to ourselves there
828 // is a problem elsewhere.
831 MediaWiki\restoreWarnings();
832 if ( !$sock ) {
833 $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
834 // Fall back to running the job here while the user waits
835 $runner = new JobRunner( $runJobsLogger );
836 $runner->run( array( 'maxJobs' => $n ) );
837 return;
840 $url = wfAppendQuery( wfScript( 'index' ), $query );
841 $req = (
842 "POST $url HTTP/1.1\r\n" .
843 "Host: {$info['host']}\r\n" .
844 "Connection: Close\r\n" .
845 "Content-Length: 0\r\n\r\n"
848 $runJobsLogger->info( "Running $n job(s) via '$url'" );
849 // Send a cron API request to be performed in the background.
850 // Give up if this takes too long to send (which should be rare).
851 stream_set_timeout( $sock, 1 );
852 $bytes = fwrite( $sock, $req );
853 if ( $bytes !== strlen( $req ) ) {
854 $runJobsLogger->error( "Failed to start cron API (socket write error)" );
855 } else {
856 // Do not wait for the response (the script should handle client aborts).
857 // Make sure that we don't close before that script reaches ignore_user_abort().
858 $status = fgets( $sock );
859 if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
860 $runJobsLogger->error( "Failed to start cron API: received '$status'" );
863 fclose( $sock );