Merge "Change "Subject/headline" to "Subject""
[lhc/web/wiklou.git] / includes / MediaWiki.php
1 <?php
2 /**
3 * Helper class for the index.php entry point.
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 */
22
23 use MediaWiki\Logger\LoggerFactory;
24
25 /**
26 * The MediaWiki class is the helper class for the index.php entry point.
27 */
28 class MediaWiki {
29 /**
30 * @var IContextSource
31 */
32 private $context;
33
34 /**
35 * @var Config
36 */
37 private $config;
38
39 /**
40 * @param IContextSource|null $context
41 */
42 public function __construct( IContextSource $context = null ) {
43 if ( !$context ) {
44 $context = RequestContext::getMain();
45 }
46
47 $this->context = $context;
48 $this->config = $context->getConfig();
49 }
50
51 /**
52 * Parse the request to get the Title object
53 *
54 * @throws MalformedTitleException If a title has been provided by the user, but is invalid.
55 * @return Title Title object to be $wgTitle
56 */
57 private function parseTitle() {
58 global $wgContLang;
59
60 $request = $this->context->getRequest();
61 $curid = $request->getInt( 'curid' );
62 $title = $request->getVal( 'title' );
63 $action = $request->getVal( 'action' );
64
65 if ( $request->getCheck( 'search' ) ) {
66 // Compatibility with old search URLs which didn't use Special:Search
67 // Just check for presence here, so blank requests still
68 // show the search page when using ugly URLs (bug 8054).
69 $ret = SpecialPage::getTitleFor( 'Search' );
70 } elseif ( $curid ) {
71 // URLs like this are generated by RC, because rc_title isn't always accurate
72 $ret = Title::newFromID( $curid );
73 } else {
74 $ret = Title::newFromURL( $title );
75 // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
76 // in wikitext links to tell Parser to make a direct file link
77 if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA ) {
78 $ret = Title::makeTitle( NS_FILE, $ret->getDBkey() );
79 }
80 // Check variant links so that interwiki links don't have to worry
81 // about the possible different language variants
82 if ( count( $wgContLang->getVariants() ) > 1
83 && !is_null( $ret ) && $ret->getArticleID() == 0
84 ) {
85 $wgContLang->findVariantLink( $title, $ret );
86 }
87 }
88
89 // If title is not provided, always allow oldid and diff to set the title.
90 // If title is provided, allow oldid and diff to override the title, unless
91 // we are talking about a special page which might use these parameters for
92 // other purposes.
93 if ( $ret === null || !$ret->isSpecialPage() ) {
94 // We can have urls with just ?diff=,?oldid= or even just ?diff=
95 $oldid = $request->getInt( 'oldid' );
96 $oldid = $oldid ? $oldid : $request->getInt( 'diff' );
97 // Allow oldid to override a changed or missing title
98 if ( $oldid ) {
99 $rev = Revision::newFromId( $oldid );
100 $ret = $rev ? $rev->getTitle() : $ret;
101 }
102 }
103
104 // Use the main page as default title if nothing else has been provided
105 if ( $ret === null
106 && strval( $title ) === ''
107 && !$request->getCheck( 'curid' )
108 && $action !== 'delete'
109 ) {
110 $ret = Title::newMainPage();
111 }
112
113 if ( $ret === null || ( $ret->getDBkey() == '' && !$ret->isExternal() ) ) {
114 // If we get here, we definitely don't have a valid title; throw an exception.
115 // Try to get detailed invalid title exception first, fall back to MalformedTitleException.
116 Title::newFromTextThrow( $title );
117 throw new MalformedTitleException( 'badtitletext', $title );
118 }
119
120 return $ret;
121 }
122
123 /**
124 * Get the Title object that we'll be acting on, as specified in the WebRequest
125 * @return Title
126 */
127 public function getTitle() {
128 if ( !$this->context->hasTitle() ) {
129 try {
130 $this->context->setTitle( $this->parseTitle() );
131 } catch ( MalformedTitleException $ex ) {
132 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
133 }
134 }
135 return $this->context->getTitle();
136 }
137
138 /**
139 * Returns the name of the action that will be executed.
140 *
141 * @return string Action
142 */
143 public function getAction() {
144 static $action = null;
145
146 if ( $action === null ) {
147 $action = Action::getActionName( $this->context );
148 }
149
150 return $action;
151 }
152
153 /**
154 * Performs the request.
155 * - bad titles
156 * - read restriction
157 * - local interwiki redirects
158 * - redirect loop
159 * - special pages
160 * - normal pages
161 *
162 * @throws MWException|PermissionsError|BadTitleError|HttpError
163 * @return void
164 */
165 private function performRequest() {
166 global $wgTitle;
167
168 $request = $this->context->getRequest();
169 $requestTitle = $title = $this->context->getTitle();
170 $output = $this->context->getOutput();
171 $user = $this->context->getUser();
172
173 if ( $request->getVal( 'printable' ) === 'yes' ) {
174 $output->setPrintable();
175 }
176
177 $unused = null; // To pass it by reference
178 Hooks::run( 'BeforeInitialize', array( &$title, &$unused, &$output, &$user, $request, $this ) );
179
180 // Invalid titles. Bug 21776: The interwikis must redirect even if the page name is empty.
181 if ( is_null( $title ) || ( $title->getDBkey() == '' && !$title->isExternal() )
182 || $title->isSpecial( 'Badtitle' )
183 ) {
184 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
185 try {
186 $this->parseTitle();
187 } catch ( MalformedTitleException $ex ) {
188 throw new BadTitleError( $ex );
189 }
190 throw new BadTitleError();
191 }
192
193 // Check user's permissions to read this page.
194 // We have to check here to catch special pages etc.
195 // We will check again in Article::view().
196 $permErrors = $title->isSpecial( 'RunJobs' )
197 ? array() // relies on HMAC key signature alone
198 : $title->getUserPermissionsErrors( 'read', $user );
199 if ( count( $permErrors ) ) {
200 // Bug 32276: allowing the skin to generate output with $wgTitle or
201 // $this->context->title set to the input title would allow anonymous users to
202 // determine whether a page exists, potentially leaking private data. In fact, the
203 // curid and oldid request parameters would allow page titles to be enumerated even
204 // when they are not guessable. So we reset the title to Special:Badtitle before the
205 // permissions error is displayed.
206 //
207 // The skin mostly uses $this->context->getTitle() these days, but some extensions
208 // still use $wgTitle.
209
210 $badTitle = SpecialPage::getTitleFor( 'Badtitle' );
211 $this->context->setTitle( $badTitle );
212 $wgTitle = $badTitle;
213
214 throw new PermissionsError( 'read', $permErrors );
215 }
216
217 // Interwiki redirects
218 if ( $title->isExternal() ) {
219 $rdfrom = $request->getVal( 'rdfrom' );
220 if ( $rdfrom ) {
221 $url = $title->getFullURL( array( 'rdfrom' => $rdfrom ) );
222 } else {
223 $query = $request->getValues();
224 unset( $query['title'] );
225 $url = $title->getFullURL( $query );
226 }
227 // Check for a redirect loop
228 if ( !preg_match( '/^' . preg_quote( $this->config->get( 'Server' ), '/' ) . '/', $url )
229 && $title->isLocal()
230 ) {
231 // 301 so google et al report the target as the actual url.
232 $output->redirect( $url, 301 );
233 } else {
234 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
235 try {
236 $this->parseTitle();
237 } catch ( MalformedTitleException $ex ) {
238 throw new BadTitleError( $ex );
239 }
240 throw new BadTitleError();
241 }
242 // Handle any other redirects.
243 // Redirect loops, titleless URL, $wgUsePathInfo URLs, and URLs with a variant
244 } elseif ( !$this->tryNormaliseRedirect( $title ) ) {
245
246 // Special pages
247 if ( NS_SPECIAL == $title->getNamespace() ) {
248 // Actions that need to be made when we have a special pages
249 SpecialPageFactory::executePath( $title, $this->context );
250 } else {
251 // ...otherwise treat it as an article view. The article
252 // may still be a wikipage redirect to another article or URL.
253 $article = $this->initializeArticle();
254 if ( is_object( $article ) ) {
255 $this->performAction( $article, $requestTitle );
256 } elseif ( is_string( $article ) ) {
257 $output->redirect( $article );
258 } else {
259 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle()"
260 . " returned neither an object nor a URL" );
261 }
262 }
263 }
264 }
265
266 /**
267 * Handle redirects for uncanonical title requests.
268 *
269 * Handles:
270 * - Redirect loops.
271 * - No title in URL.
272 * - $wgUsePathInfo URLs.
273 * - URLs with a variant.
274 * - Other non-standard URLs (as long as they have no extra query parameters).
275 *
276 * Behaviour:
277 * - Normalise title values:
278 * /wiki/Foo%20Bar -> /wiki/Foo_Bar
279 * - Normalise empty title:
280 * /wiki/ -> /wiki/Main
281 * /w/index.php?title= -> /wiki/Main
282 * - Normalise non-standard title urls:
283 * /w/index.php?title=Foo_Bar -> /wiki/Foo_Bar
284 * - Don't redirect anything with query parameters other than 'title' or 'action=view'.
285 *
286 * @param Title $title
287 * @return bool True if a redirect was set.
288 * @throws HttpError
289 */
290 private function tryNormaliseRedirect( Title $title ) {
291 $request = $this->context->getRequest();
292 $output = $this->context->getOutput();
293
294 if ( $request->getVal( 'action', 'view' ) != 'view'
295 || $request->wasPosted()
296 || count( $request->getValueNames( array( 'action', 'title' ) ) )
297 || !Hooks::run( 'TestCanonicalRedirect', array( $request, $title, $output ) )
298 ) {
299 return false;
300 }
301
302 if ( $title->isSpecialPage() ) {
303 list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
304 if ( $name ) {
305 $title = SpecialPage::getTitleFor( $name, $subpage );
306 }
307 }
308 // Redirect to canonical url, make it a 301 to allow caching
309 $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
310
311 if ( $targetUrl != $request->getFullRequestURL() ) {
312 $output->setSquidMaxage( 1200 );
313 $output->redirect( $targetUrl, '301' );
314 return true;
315 }
316
317 // If there is no title, or the title is in a non-standard encoding, we demand
318 // a redirect. If cgi somehow changed the 'title' query to be non-standard while
319 // the url is standard, the server is misconfigured.
320 if ( $request->getVal( 'title' ) === null
321 || $title->getPrefixedDBkey() != $request->getVal( 'title' )
322 ) {
323 $message = "Redirect loop detected!\n\n" .
324 "This means the wiki got confused about what page was " .
325 "requested; this sometimes happens when moving a wiki " .
326 "to a new server or changing the server configuration.\n\n";
327
328 if ( $this->config->get( 'UsePathInfo' ) ) {
329 $message .= "The wiki is trying to interpret the page " .
330 "title from the URL path portion (PATH_INFO), which " .
331 "sometimes fails depending on the web server. Try " .
332 "setting \"\$wgUsePathInfo = false;\" in your " .
333 "LocalSettings.php, or check that \$wgArticlePath " .
334 "is correct.";
335 } else {
336 $message .= "Your web server was detected as possibly not " .
337 "supporting URL path components (PATH_INFO) correctly; " .
338 "check your LocalSettings.php for a customized " .
339 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
340 "to true.";
341 }
342 throw new HttpError( 500, $message );
343 }
344 return false;
345 }
346
347 /**
348 * Initialize the main Article object for "standard" actions (view, etc)
349 * Create an Article object for the page, following redirects if needed.
350 *
351 * @return mixed An Article, or a string to redirect to another URL
352 */
353 private function initializeArticle() {
354
355 $title = $this->context->getTitle();
356 if ( $this->context->canUseWikiPage() ) {
357 // Try to use request context wiki page, as there
358 // is already data from db saved in per process
359 // cache there from this->getAction() call.
360 $page = $this->context->getWikiPage();
361 $article = Article::newFromWikiPage( $page, $this->context );
362 } else {
363 // This case should not happen, but just in case.
364 $article = Article::newFromTitle( $title, $this->context );
365 $this->context->setWikiPage( $article->getPage() );
366 }
367
368 // Skip some unnecessary code if the content model doesn't support redirects
369 if ( !ContentHandler::getForTitle( $title )->supportsRedirects() ) {
370 return $article;
371 }
372
373 $request = $this->context->getRequest();
374
375 // Namespace might change when using redirects
376 // Check for redirects ...
377 $action = $request->getVal( 'action', 'view' );
378 $file = ( $title->getNamespace() == NS_FILE ) ? $article->getFile() : null;
379 if ( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
380 && !$request->getVal( 'oldid' ) // ... and are not old revisions
381 && !$request->getVal( 'diff' ) // ... and not when showing diff
382 && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
383 // ... and the article is not a non-redirect image page with associated file
384 && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
385 ) {
386 // Give extensions a change to ignore/handle redirects as needed
387 $ignoreRedirect = $target = false;
388
389 Hooks::run( 'InitializeArticleMaybeRedirect',
390 array( &$title, &$request, &$ignoreRedirect, &$target, &$article ) );
391
392 // Follow redirects only for... redirects.
393 // If $target is set, then a hook wanted to redirect.
394 if ( !$ignoreRedirect && ( $target || $article->isRedirect() ) ) {
395 // Is the target already set by an extension?
396 $target = $target ? $target : $article->followRedirect();
397 if ( is_string( $target ) ) {
398 if ( !$this->config->get( 'DisableHardRedirects' ) ) {
399 // we'll need to redirect
400 return $target;
401 }
402 }
403 if ( is_object( $target ) ) {
404 // Rewrite environment to redirected article
405 $rarticle = Article::newFromTitle( $target, $this->context );
406 $rarticle->loadPageData();
407 if ( $rarticle->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
408 $rarticle->setRedirectedFrom( $title );
409 $article = $rarticle;
410 $this->context->setTitle( $target );
411 $this->context->setWikiPage( $article->getPage() );
412 }
413 }
414 } else {
415 $this->context->setTitle( $article->getTitle() );
416 $this->context->setWikiPage( $article->getPage() );
417 }
418 }
419
420 return $article;
421 }
422
423 /**
424 * Perform one of the "standard" actions
425 *
426 * @param Page $page
427 * @param Title $requestTitle The original title, before any redirects were applied
428 */
429 private function performAction( Page $page, Title $requestTitle ) {
430
431 $request = $this->context->getRequest();
432 $output = $this->context->getOutput();
433 $title = $this->context->getTitle();
434 $user = $this->context->getUser();
435
436 if ( !Hooks::run( 'MediaWikiPerformAction',
437 array( $output, $page, $title, $user, $request, $this ) )
438 ) {
439 return;
440 }
441
442 $act = $this->getAction();
443
444 $action = Action::factory( $act, $page, $this->context );
445
446 if ( $action instanceof Action ) {
447 # Let Squid cache things if we can purge them.
448 if ( $this->config->get( 'UseSquid' ) &&
449 in_array(
450 // Use PROTO_INTERNAL because that's what getSquidURLs() uses
451 wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL ),
452 $requestTitle->getSquidURLs()
453 )
454 ) {
455 $output->setSquidMaxage( $this->config->get( 'SquidMaxage' ) );
456 }
457
458 $action->show();
459 return;
460 }
461
462 if ( Hooks::run( 'UnknownAction', array( $request->getVal( 'action', 'view' ), $page ) ) ) {
463 $output->setStatusCode( 404 );
464 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
465 }
466
467 }
468
469 /**
470 * Run the current MediaWiki instance; index.php just calls this
471 */
472 public function run() {
473 try {
474 try {
475 $this->main();
476 } catch ( ErrorPageError $e ) {
477 // Bug 62091: while exceptions are convenient to bubble up GUI errors,
478 // they are not internal application faults. As with normal requests, this
479 // should commit, print the output, do deferred updates, jobs, and profiling.
480 $this->doPreOutputCommit();
481 $e->report(); // display the GUI error
482 }
483 } catch ( Exception $e ) {
484 MWExceptionHandler::handleException( $e );
485 }
486
487 $this->doPostOutputShutdown( 'normal' );
488 }
489
490 /**
491 * This function commits all DB changes as needed before
492 * the user can receive a response (in case commit fails)
493 *
494 * @since 1.26
495 */
496 public function doPreOutputCommit() {
497 // Either all DBs should commit or none
498 ignore_user_abort( true );
499
500 // Commit all changes and record ChronologyProtector positions
501 $factory = wfGetLBFactory();
502 $factory->commitMasterChanges();
503 $factory->shutdown();
504
505 wfDebug( __METHOD__ . ' completed; all transactions committed' );
506
507 // Set a cookie to tell all CDN edge nodes to "stick" the user to the
508 // DC that handles this POST request (e.g. the "master" data center)
509 $request = $this->context->getRequest();
510 if ( $request->wasPosted() && $factory->hasOrMadeRecentMasterChanges() ) {
511 $expires = time() + $this->config->get( 'DataCenterUpdateStickTTL' );
512 $request->response()->setCookie( 'UseDC', 'master', $expires );
513 }
514
515 // Avoid letting a few seconds of slave lag cause a month of stale data
516 if ( $factory->laggedSlaveUsed() ) {
517 $maxAge = $this->config->get( 'CdnMaxageLagged' );
518 $this->context->getOutput()->lowerCdnMaxage( $maxAge );
519 wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
520 }
521 }
522
523 /**
524 * This function does work that can be done *after* the
525 * user gets the HTTP response so they don't block on it
526 *
527 * This manages deferred updates, job insertion,
528 * final commit, and the logging of profiling data
529 *
530 * @param string $mode Use 'fast' to always skip job running
531 * @since 1.26
532 */
533 public function doPostOutputShutdown( $mode = 'normal' ) {
534 // Show visible profiling data if enabled (which cannot be post-send)
535 Profiler::instance()->logDataPageOutputOnly();
536
537 $that = $this;
538 $callback = function () use ( $that, $mode ) {
539 try {
540 $that->restInPeace( $mode );
541 } catch ( Exception $e ) {
542 MWExceptionHandler::handleException( $e );
543 }
544 };
545
546 // Defer everything else...
547 if ( function_exists( 'register_postsend_function' ) ) {
548 // https://github.com/facebook/hhvm/issues/1230
549 register_postsend_function( $callback );
550 } else {
551 if ( function_exists( 'fastcgi_finish_request' ) ) {
552 fastcgi_finish_request();
553 } else {
554 // Either all DB and deferred updates should happen or none.
555 // The later should not be cancelled due to client disconnect.
556 ignore_user_abort( true );
557 }
558
559 $callback();
560 }
561 }
562
563 private function main() {
564 global $wgTitle, $wgTrxProfilerLimits;
565
566 $request = $this->context->getRequest();
567
568 // Send Ajax requests to the Ajax dispatcher.
569 if ( $this->config->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
570 // Set a dummy title, because $wgTitle == null might break things
571 $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
572 . __METHOD__
573 );
574 $this->context->setTitle( $title );
575 $wgTitle = $title;
576
577 $dispatcher = new AjaxDispatcher( $this->config );
578 $dispatcher->performAction( $this->context->getUser() );
579 return;
580 }
581
582 // Get title from request parameters,
583 // is set on the fly by parseTitle the first time.
584 $title = $this->getTitle();
585 $action = $this->getAction();
586 $wgTitle = $title;
587
588 $trxProfiler = Profiler::instance()->getTransactionProfiler();
589 $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
590
591 // Aside from rollback, master queries should not happen on GET requests.
592 // Periodic or "in passing" updates on GET should use the job queue.
593 if ( !$request->wasPosted()
594 && in_array( $action, array( 'view', 'edit', 'history' ) )
595 ) {
596 $trxProfiler->setExpectations( $wgTrxProfilerLimits['GET'], __METHOD__ );
597 } else {
598 $trxProfiler->setExpectations( $wgTrxProfilerLimits['POST'], __METHOD__ );
599 }
600
601 // If the user has forceHTTPS set to true, or if the user
602 // is in a group requiring HTTPS, or if they have the HTTPS
603 // preference set, redirect them to HTTPS.
604 // Note: Do this after $wgTitle is setup, otherwise the hooks run from
605 // isLoggedIn() will do all sorts of weird stuff.
606 if (
607 $request->getProtocol() == 'http' &&
608 (
609 $request->getCookie( 'forceHTTPS', '' ) ||
610 // check for prefixed version for currently logged in users
611 $request->getCookie( 'forceHTTPS' ) ||
612 // Avoid checking the user and groups unless it's enabled.
613 (
614 $this->context->getUser()->isLoggedIn()
615 && $this->context->getUser()->requiresHTTPS()
616 )
617 )
618 ) {
619 $oldUrl = $request->getFullRequestURL();
620 $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
621
622 // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
623 if ( Hooks::run( 'BeforeHttpsRedirect', array( $this->context, &$redirUrl ) ) ) {
624
625 if ( $request->wasPosted() ) {
626 // This is weird and we'd hope it almost never happens. This
627 // means that a POST came in via HTTP and policy requires us
628 // redirecting to HTTPS. It's likely such a request is going
629 // to fail due to post data being lost, but let's try anyway
630 // and just log the instance.
631 //
632 // @todo FIXME: See if we could issue a 307 or 308 here, need
633 // to see how clients (automated & browser) behave when we do
634 wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
635 }
636 // Setup dummy Title, otherwise OutputPage::redirect will fail
637 $title = Title::newFromText( 'REDIR', NS_MAIN );
638 $this->context->setTitle( $title );
639 $output = $this->context->getOutput();
640 // Since we only do this redir to change proto, always send a vary header
641 $output->addVaryHeader( 'X-Forwarded-Proto' );
642 $output->redirect( $redirUrl );
643 $output->output();
644 return;
645 }
646 }
647
648 if ( $this->config->get( 'UseFileCache' ) && $title->getNamespace() >= 0 ) {
649 if ( HTMLFileCache::useFileCache( $this->context ) ) {
650 // Try low-level file cache hit
651 $cache = new HTMLFileCache( $title, $action );
652 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
653 // Check incoming headers to see if client has this cached
654 $timestamp = $cache->cacheTimestamp();
655 if ( !$this->context->getOutput()->checkLastModified( $timestamp ) ) {
656 $cache->loadFromFileCache( $this->context );
657 }
658 // Do any stats increment/watchlist stuff
659 // Assume we're viewing the latest revision (this should always be the case with file cache)
660 $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
661 // Tell OutputPage that output is taken care of
662 $this->context->getOutput()->disable();
663 return;
664 }
665 }
666 }
667
668 // Actually do the work of the request and build up any output
669 $this->performRequest();
670
671 // Now commit any transactions, so that unreported errors after
672 // output() don't roll back the whole DB transaction and so that
673 // we avoid having both success and error text in the response
674 $this->doPreOutputCommit();
675
676 // Output everything!
677 $this->context->getOutput()->output();
678 }
679
680 /**
681 * Ends this task peacefully
682 * @param string $mode Use 'fast' to always skip job running
683 */
684 public function restInPeace( $mode = 'fast' ) {
685 // Assure deferred updates are not in the main transaction
686 wfGetLBFactory()->commitMasterChanges();
687
688 // Ignore things like master queries/connections on GET requests
689 // as long as they are in deferred updates (which catch errors).
690 Profiler::instance()->getTransactionProfiler()->resetExpectations();
691
692 // Do any deferred jobs
693 DeferredUpdates::doUpdates( 'commit', 'enqueue' );
694
695 // Make sure any lazy jobs are pushed
696 JobQueueGroup::pushLazyJobs();
697
698 // Now that everything specific to this request is done,
699 // try to occasionally run jobs (if enabled) from the queues
700 if ( $mode === 'normal' ) {
701 $this->triggerJobs();
702 }
703
704 // Log profiling data, e.g. in the database or UDP
705 wfLogProfilingData();
706
707 // Commit and close up!
708 $factory = wfGetLBFactory();
709 $factory->commitMasterChanges();
710 $factory->shutdown();
711
712 wfDebug( "Request ended normally\n" );
713 }
714
715 /**
716 * Potentially open a socket and sent an HTTP request back to the server
717 * to run a specified number of jobs. This registers a callback to cleanup
718 * the socket once it's done.
719 */
720 public function triggerJobs() {
721 $jobRunRate = $this->config->get( 'JobRunRate' );
722 if ( $jobRunRate <= 0 || wfReadOnly() ) {
723 return;
724 } elseif ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
725 return; // recursion guard
726 }
727
728 if ( $jobRunRate < 1 ) {
729 $max = mt_getrandmax();
730 if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
731 return; // the higher the job run rate, the less likely we return here
732 }
733 $n = 1;
734 } else {
735 $n = intval( $jobRunRate );
736 }
737
738 $runJobsLogger = LoggerFactory::getInstance( 'runJobs' );
739
740 if ( !$this->config->get( 'RunJobsAsync' ) ) {
741 // Fall back to running the job here while the user waits
742 $runner = new JobRunner( $runJobsLogger );
743 $runner->run( array( 'maxJobs' => $n ) );
744 return;
745 }
746
747 try {
748 if ( !JobQueueGroup::singleton()->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
749 return; // do not send request if there are probably no jobs
750 }
751 } catch ( JobQueueError $e ) {
752 MWExceptionHandler::logException( $e );
753 return; // do not make the site unavailable
754 }
755
756 $query = array( 'title' => 'Special:RunJobs',
757 'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 );
758 $query['signature'] = SpecialRunJobs::getQuerySignature(
759 $query, $this->config->get( 'SecretKey' ) );
760
761 $errno = $errstr = null;
762 $info = wfParseUrl( $this->config->get( 'Server' ) );
763 MediaWiki\suppressWarnings();
764 $sock = fsockopen(
765 $info['host'],
766 isset( $info['port'] ) ? $info['port'] : 80,
767 $errno,
768 $errstr,
769 // If it takes more than 100ms to connect to ourselves there
770 // is a problem elsewhere.
771 0.1
772 );
773 MediaWiki\restoreWarnings();
774 if ( !$sock ) {
775 $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
776 // Fall back to running the job here while the user waits
777 $runner = new JobRunner( $runJobsLogger );
778 $runner->run( array( 'maxJobs' => $n ) );
779 return;
780 }
781
782 $url = wfAppendQuery( wfScript( 'index' ), $query );
783 $req = (
784 "POST $url HTTP/1.1\r\n" .
785 "Host: {$info['host']}\r\n" .
786 "Connection: Close\r\n" .
787 "Content-Length: 0\r\n\r\n"
788 );
789
790 $runJobsLogger->info( "Running $n job(s) via '$url'" );
791 // Send a cron API request to be performed in the background.
792 // Give up if this takes too long to send (which should be rare).
793 stream_set_timeout( $sock, 1 );
794 $bytes = fwrite( $sock, $req );
795 if ( $bytes !== strlen( $req ) ) {
796 $runJobsLogger->error( "Failed to start cron API (socket write error)" );
797 } else {
798 // Do not wait for the response (the script should handle client aborts).
799 // Make sure that we don't close before that script reaches ignore_user_abort().
800 $status = fgets( $sock );
801 if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
802 $runJobsLogger->error( "Failed to start cron API: received '$status'" );
803 }
804 }
805 fclose( $sock );
806 }
807 }