Merge "Hygiene: Use [i] instead of charAt(i) for string index access"
[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 * - Don't redirect anything with query parameters other than 'title' or 'action=view'.
283 *
284 * @return bool True if a redirect was set.
285 */
286 private function tryNormaliseRedirect( $title ) {
287 $request = $this->context->getRequest();
288 $output = $this->context->getOutput();
289
290 if ( $request->getVal( 'action', 'view' ) != 'view'
291 || $request->wasPosted()
292 || ( $request->getVal( 'title' ) !== null
293 && $title->getPrefixedDBkey() == $request->getVal( 'title' ) )
294 || count( $request->getValueNames( array( 'action', 'title' ) ) )
295 || !Hooks::run( 'TestCanonicalRedirect', array( $request, $title, $output ) )
296 ) {
297 return false;
298 }
299
300 if ( $title->isSpecialPage() ) {
301 list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
302 if ( $name ) {
303 $title = SpecialPage::getTitleFor( $name, $subpage );
304 }
305 }
306 // Redirect to canonical url, make it a 301 to allow caching
307 $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
308 if ( $targetUrl == $request->getFullRequestURL() ) {
309 $message = "Redirect loop detected!\n\n" .
310 "This means the wiki got confused about what page was " .
311 "requested; this sometimes happens when moving a wiki " .
312 "to a new server or changing the server configuration.\n\n";
313
314 if ( $this->config->get( 'UsePathInfo' ) ) {
315 $message .= "The wiki is trying to interpret the page " .
316 "title from the URL path portion (PATH_INFO), which " .
317 "sometimes fails depending on the web server. Try " .
318 "setting \"\$wgUsePathInfo = false;\" in your " .
319 "LocalSettings.php, or check that \$wgArticlePath " .
320 "is correct.";
321 } else {
322 $message .= "Your web server was detected as possibly not " .
323 "supporting URL path components (PATH_INFO) correctly; " .
324 "check your LocalSettings.php for a customized " .
325 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
326 "to true.";
327 }
328 throw new HttpError( 500, $message );
329 }
330 $output->setSquidMaxage( 1200 );
331 $output->redirect( $targetUrl, '301' );
332 return true;
333 }
334
335 /**
336 * Initialize the main Article object for "standard" actions (view, etc)
337 * Create an Article object for the page, following redirects if needed.
338 *
339 * @return mixed An Article, or a string to redirect to another URL
340 */
341 private function initializeArticle() {
342
343 $title = $this->context->getTitle();
344 if ( $this->context->canUseWikiPage() ) {
345 // Try to use request context wiki page, as there
346 // is already data from db saved in per process
347 // cache there from this->getAction() call.
348 $page = $this->context->getWikiPage();
349 $article = Article::newFromWikiPage( $page, $this->context );
350 } else {
351 // This case should not happen, but just in case.
352 $article = Article::newFromTitle( $title, $this->context );
353 $this->context->setWikiPage( $article->getPage() );
354 }
355
356 // NS_MEDIAWIKI has no redirects.
357 // It is also used for CSS/JS, so performance matters here...
358 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
359 return $article;
360 }
361
362 $request = $this->context->getRequest();
363
364 // Namespace might change when using redirects
365 // Check for redirects ...
366 $action = $request->getVal( 'action', 'view' );
367 $file = ( $title->getNamespace() == NS_FILE ) ? $article->getFile() : null;
368 if ( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
369 && !$request->getVal( 'oldid' ) // ... and are not old revisions
370 && !$request->getVal( 'diff' ) // ... and not when showing diff
371 && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
372 // ... and the article is not a non-redirect image page with associated file
373 && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
374 ) {
375 // Give extensions a change to ignore/handle redirects as needed
376 $ignoreRedirect = $target = false;
377
378 Hooks::run( 'InitializeArticleMaybeRedirect',
379 array( &$title, &$request, &$ignoreRedirect, &$target, &$article ) );
380
381 // Follow redirects only for... redirects.
382 // If $target is set, then a hook wanted to redirect.
383 if ( !$ignoreRedirect && ( $target || $article->isRedirect() ) ) {
384 // Is the target already set by an extension?
385 $target = $target ? $target : $article->followRedirect();
386 if ( is_string( $target ) ) {
387 if ( !$this->config->get( 'DisableHardRedirects' ) ) {
388 // we'll need to redirect
389 return $target;
390 }
391 }
392 if ( is_object( $target ) ) {
393 // Rewrite environment to redirected article
394 $rarticle = Article::newFromTitle( $target, $this->context );
395 $rarticle->loadPageData();
396 if ( $rarticle->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
397 $rarticle->setRedirectedFrom( $title );
398 $article = $rarticle;
399 $this->context->setTitle( $target );
400 $this->context->setWikiPage( $article->getPage() );
401 }
402 }
403 } else {
404 $this->context->setTitle( $article->getTitle() );
405 $this->context->setWikiPage( $article->getPage() );
406 }
407 }
408
409 return $article;
410 }
411
412 /**
413 * Perform one of the "standard" actions
414 *
415 * @param Page $page
416 * @param Title $requestTitle The original title, before any redirects were applied
417 */
418 private function performAction( Page $page, Title $requestTitle ) {
419
420 $request = $this->context->getRequest();
421 $output = $this->context->getOutput();
422 $title = $this->context->getTitle();
423 $user = $this->context->getUser();
424
425 if ( !Hooks::run( 'MediaWikiPerformAction',
426 array( $output, $page, $title, $user, $request, $this ) )
427 ) {
428 return;
429 }
430
431 $act = $this->getAction();
432
433 $action = Action::factory( $act, $page, $this->context );
434
435 if ( $action instanceof Action ) {
436 # Let Squid cache things if we can purge them.
437 if ( $this->config->get( 'UseSquid' ) &&
438 in_array(
439 // Use PROTO_INTERNAL because that's what getSquidURLs() uses
440 wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL ),
441 $requestTitle->getSquidURLs()
442 )
443 ) {
444 $output->setSquidMaxage( $this->config->get( 'SquidMaxage' ) );
445 }
446
447 $action->show();
448 return;
449 }
450
451 if ( Hooks::run( 'UnknownAction', array( $request->getVal( 'action', 'view' ), $page ) ) ) {
452 $output->setStatusCode( 404 );
453 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
454 }
455
456 }
457
458 /**
459 * Run the current MediaWiki instance; index.php just calls this
460 */
461 public function run() {
462 try {
463 $this->checkMaxLag();
464 try {
465 $this->main();
466 } catch ( ErrorPageError $e ) {
467 // Bug 62091: while exceptions are convenient to bubble up GUI errors,
468 // they are not internal application faults. As with normal requests, this
469 // should commit, print the output, do deferred updates, jobs, and profiling.
470 $this->doPreOutputCommit();
471 $e->report(); // display the GUI error
472 }
473 } catch ( Exception $e ) {
474 MWExceptionHandler::handleException( $e );
475 }
476
477 $this->doPostOutputShutdown( 'normal' );
478 }
479
480 /**
481 * This function commits all DB changes as needed before
482 * the user can receive a response (in case commit fails)
483 *
484 * @since 1.26
485 */
486 public function doPreOutputCommit() {
487 // Either all DBs should commit or none
488 ignore_user_abort( true );
489 wfGetLBFactory()->commitMasterChanges();
490 }
491
492 /**
493 * This function does work that can be done *after* the
494 * user gets the HTTP response so they don't block on it
495 *
496 * @param string $mode Use 'fast' to always skip job running
497 * @since 1.26
498 */
499 public function doPostOutputShutdown( $mode = 'normal' ) {
500 // Show profiling data if enabled
501 Profiler::instance()->logDataPageOutputOnly();
502
503 $that = $this;
504 $callback = function () use ( $that, $mode ) {
505 try {
506 // Assure deferred updates are not in the main transaction
507 wfGetLBFactory()->commitMasterChanges();
508 // Run jobs occasionally, if enabled
509 if ( $mode === 'normal' ) {
510 $that->triggerJobs();
511 }
512 // Do deferred updates and job insertion and final commit
513 $that->restInPeace();
514 } catch ( Exception $e ) {
515 MWExceptionHandler::handleException( $e );
516 }
517 };
518
519 if ( function_exists( 'register_postsend_function' ) ) {
520 // https://github.com/facebook/hhvm/issues/1230
521 register_postsend_function( $callback );
522 } else {
523 if ( function_exists( 'fastcgi_finish_request' ) ) {
524 fastcgi_finish_request();
525 } else {
526 // Either all DB and deferred updates should happen or none.
527 // The later should not be cancelled due to client disconnect.
528 ignore_user_abort( true );
529 }
530
531 $callback();
532 }
533 }
534
535 /**
536 * Checks if the request should abort due to a lagged server,
537 * for given maxlag parameter.
538 * @return bool
539 */
540 private function checkMaxLag() {
541 $maxLag = $this->context->getRequest()->getVal( 'maxlag' );
542 if ( !is_null( $maxLag ) ) {
543 list( $host, $lag ) = wfGetLB()->getMaxLag();
544 if ( $lag > $maxLag ) {
545 $resp = $this->context->getRequest()->response();
546 $resp->statusHeader( 503 );
547 $resp->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
548 $resp->header( 'X-Database-Lag: ' . intval( $lag ) );
549 $resp->header( 'Content-Type: text/plain' );
550 if ( $this->config->get( 'ShowHostnames' ) ) {
551 echo "Waiting for $host: $lag seconds lagged\n";
552 } else {
553 echo "Waiting for a database server: $lag seconds lagged\n";
554 }
555
556 exit;
557 }
558 }
559 return true;
560 }
561
562 private function main() {
563 global $wgTitle, $wgTrxProfilerLimits;
564
565 $request = $this->context->getRequest();
566
567 // Send Ajax requests to the Ajax dispatcher.
568 if ( $this->config->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
569 // Set a dummy title, because $wgTitle == null might break things
570 $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
571 . __METHOD__
572 );
573 $this->context->setTitle( $title );
574 $wgTitle = $title;
575
576 $dispatcher = new AjaxDispatcher( $this->config );
577 $dispatcher->performAction( $this->context->getUser() );
578 return;
579 }
580
581 // Get title from request parameters,
582 // is set on the fly by parseTitle the first time.
583 $title = $this->getTitle();
584 $action = $this->getAction();
585 $wgTitle = $title;
586
587 $trxProfiler = Profiler::instance()->getTransactionProfiler();
588 $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
589
590 // Aside from rollback, master queries should not happen on GET requests.
591 // Periodic or "in passing" updates on GET should use the job queue.
592 if ( !$request->wasPosted()
593 && in_array( $action, array( 'view', 'edit', 'history' ) )
594 ) {
595 $trxProfiler->setExpectations( $wgTrxProfilerLimits['GET'], __METHOD__ );
596 } else {
597 $trxProfiler->setExpectations( $wgTrxProfilerLimits['POST'], __METHOD__ );
598 }
599
600 // If the user has forceHTTPS set to true, or if the user
601 // is in a group requiring HTTPS, or if they have the HTTPS
602 // preference set, redirect them to HTTPS.
603 // Note: Do this after $wgTitle is setup, otherwise the hooks run from
604 // isLoggedIn() will do all sorts of weird stuff.
605 if (
606 $request->getProtocol() == 'http' &&
607 (
608 $request->getCookie( 'forceHTTPS', '' ) ||
609 // check for prefixed version for currently logged in users
610 $request->getCookie( 'forceHTTPS' ) ||
611 // Avoid checking the user and groups unless it's enabled.
612 (
613 $this->context->getUser()->isLoggedIn()
614 && $this->context->getUser()->requiresHTTPS()
615 )
616 )
617 ) {
618 $oldUrl = $request->getFullRequestURL();
619 $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
620
621 // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
622 if ( Hooks::run( 'BeforeHttpsRedirect', array( $this->context, &$redirUrl ) ) ) {
623
624 if ( $request->wasPosted() ) {
625 // This is weird and we'd hope it almost never happens. This
626 // means that a POST came in via HTTP and policy requires us
627 // redirecting to HTTPS. It's likely such a request is going
628 // to fail due to post data being lost, but let's try anyway
629 // and just log the instance.
630 //
631 // @todo FIXME: See if we could issue a 307 or 308 here, need
632 // to see how clients (automated & browser) behave when we do
633 wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
634 }
635 // Setup dummy Title, otherwise OutputPage::redirect will fail
636 $title = Title::newFromText( 'REDIR', NS_MAIN );
637 $this->context->setTitle( $title );
638 $output = $this->context->getOutput();
639 // Since we only do this redir to change proto, always send a vary header
640 $output->addVaryHeader( 'X-Forwarded-Proto' );
641 $output->redirect( $redirUrl );
642 $output->output();
643 return;
644 }
645 }
646
647 if ( $this->config->get( 'UseFileCache' ) && $title->getNamespace() >= 0 ) {
648 if ( HTMLFileCache::useFileCache( $this->context ) ) {
649 // Try low-level file cache hit
650 $cache = new HTMLFileCache( $title, $action );
651 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
652 // Check incoming headers to see if client has this cached
653 $timestamp = $cache->cacheTimestamp();
654 if ( !$this->context->getOutput()->checkLastModified( $timestamp ) ) {
655 $cache->loadFromFileCache( $this->context );
656 }
657 // Do any stats increment/watchlist stuff
658 // Assume we're viewing the latest revision (this should always be the case with file cache)
659 $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
660 // Tell OutputPage that output is taken care of
661 $this->context->getOutput()->disable();
662 return;
663 }
664 }
665 }
666
667 // Actually do the work of the request and build up any output
668 $this->performRequest();
669
670 // Now commit any transactions, so that unreported errors after
671 // output() don't roll back the whole DB transaction and so that
672 // we avoid having both success and error text in the response
673 $this->doPreOutputCommit();
674
675 // Output everything!
676 $this->context->getOutput()->output();
677 }
678
679 /**
680 * Ends this task peacefully
681 */
682 public function restInPeace() {
683 // Ignore things like master queries/connections on GET requests
684 // as long as they are in deferred updates (which catch errors).
685 Profiler::instance()->getTransactionProfiler()->resetExpectations();
686
687 // Do any deferred jobs
688 DeferredUpdates::doUpdates( 'commit' );
689
690 // Make sure any lazy jobs are pushed
691 JobQueueGroup::pushLazyJobs();
692
693 // Log profiling data, e.g. in the database or UDP
694 wfLogProfilingData();
695
696 // Commit and close up!
697 $factory = wfGetLBFactory();
698 $factory->commitMasterChanges();
699 $factory->shutdown();
700
701 wfDebug( "Request ended normally\n" );
702 }
703
704 /**
705 * Potentially open a socket and sent an HTTP request back to the server
706 * to run a specified number of jobs. This registers a callback to cleanup
707 * the socket once it's done.
708 */
709 public function triggerJobs() {
710 $jobRunRate = $this->config->get( 'JobRunRate' );
711 if ( $jobRunRate <= 0 || wfReadOnly() ) {
712 return;
713 } elseif ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
714 return; // recursion guard
715 }
716
717 if ( $jobRunRate < 1 ) {
718 $max = mt_getrandmax();
719 if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
720 return; // the higher the job run rate, the less likely we return here
721 }
722 $n = 1;
723 } else {
724 $n = intval( $jobRunRate );
725 }
726
727 $runJobsLogger = LoggerFactory::getInstance( 'runJobs' );
728
729 if ( !$this->config->get( 'RunJobsAsync' ) ) {
730 // Fall back to running the job here while the user waits
731 $runner = new JobRunner( $runJobsLogger );
732 $runner->run( array( 'maxJobs' => $n ) );
733 return;
734 }
735
736 try {
737 if ( !JobQueueGroup::singleton()->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
738 return; // do not send request if there are probably no jobs
739 }
740 } catch ( JobQueueError $e ) {
741 MWExceptionHandler::logException( $e );
742 return; // do not make the site unavailable
743 }
744
745 $query = array( 'title' => 'Special:RunJobs',
746 'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 );
747 $query['signature'] = SpecialRunJobs::getQuerySignature(
748 $query, $this->config->get( 'SecretKey' ) );
749
750 $errno = $errstr = null;
751 $info = wfParseUrl( $this->config->get( 'Server' ) );
752 MediaWiki\suppressWarnings();
753 $sock = fsockopen(
754 $info['host'],
755 isset( $info['port'] ) ? $info['port'] : 80,
756 $errno,
757 $errstr,
758 // If it takes more than 100ms to connect to ourselves there
759 // is a problem elsewhere.
760 0.1
761 );
762 MediaWiki\restoreWarnings();
763 if ( !$sock ) {
764 $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
765 // Fall back to running the job here while the user waits
766 $runner = new JobRunner( $runJobsLogger );
767 $runner->run( array( 'maxJobs' => $n ) );
768 return;
769 }
770
771 $url = wfAppendQuery( wfScript( 'index' ), $query );
772 $req = (
773 "POST $url HTTP/1.1\r\n" .
774 "Host: {$info['host']}\r\n" .
775 "Connection: Close\r\n" .
776 "Content-Length: 0\r\n\r\n"
777 );
778
779 $runJobsLogger->info( "Running $n job(s) via '$url'" );
780 // Send a cron API request to be performed in the background.
781 // Give up if this takes too long to send (which should be rare).
782 stream_set_timeout( $sock, 1 );
783 $bytes = fwrite( $sock, $req );
784 if ( $bytes !== strlen( $req ) ) {
785 $runJobsLogger->error( "Failed to start cron API (socket write error)" );
786 } else {
787 // Do not wait for the response (the script should handle client aborts).
788 // Make sure that we don't close before that script reaches ignore_user_abort().
789 $status = fgets( $sock );
790 if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
791 $runJobsLogger->error( "Failed to start cron API: received '$status'" );
792 }
793 }
794 fclose( $sock );
795 }
796 }