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