MediaWiki  1.27.2
MediaWiki.php
Go to the documentation of this file.
1 <?php
24 
28 class MediaWiki {
32  private $context;
33 
37  private $config;
38 
42  private $action;
43 
47  public function __construct( IContextSource $context = null ) {
48  if ( !$context ) {
50  }
51 
52  $this->context = $context;
53  $this->config = $context->getConfig();
54  }
55 
62  private function parseTitle() {
64 
65  $request = $this->context->getRequest();
66  $curid = $request->getInt( 'curid' );
67  $title = $request->getVal( 'title' );
68  $action = $request->getVal( 'action' );
69 
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 {
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() );
84  }
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 );
91  }
92  }
93 
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;
106  }
107  }
108 
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'
114  ) {
116  }
117 
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.
122  throw new MalformedTitleException( 'badtitletext', $title );
123  }
124 
125  return $ret;
126  }
127 
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' ) );
138  }
139  }
140  return $this->context->getTitle();
141  }
142 
148  public function getAction() {
149  if ( $this->action === null ) {
150  $this->action = Action::getActionName( $this->context );
151  }
152 
153  return $this->action;
154  }
155 
168  private function performRequest() {
170 
171  $request = $this->context->getRequest();
172  $requestTitle = $title = $this->context->getTitle();
173  $output = $this->context->getOutput();
174  $user = $this->context->getUser();
175 
176  if ( $request->getVal( 'printable' ) === 'yes' ) {
177  $output->setPrintable();
178  }
179 
180  $unused = null; // To pass it by reference
181  Hooks::run( 'BeforeInitialize', [ &$title, &$unused, &$output, &$user, $request, $this ] );
182 
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' )
186  ) {
187  $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
188  try {
189  $this->parseTitle();
190  } catch ( MalformedTitleException $ex ) {
191  throw new BadTitleError( $ex );
192  }
193  throw new BadTitleError();
194  }
195 
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  ? [] // 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.
209 
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;
215 
216  throw new PermissionsError( 'read', $permErrors );
217  }
218 
219  // Interwiki redirects
220  if ( $title->isExternal() ) {
221  $rdfrom = $request->getVal( 'rdfrom' );
222  if ( $rdfrom ) {
223  $url = $title->getFullURL( [ 'rdfrom' => $rdfrom ] );
224  } else {
225  $query = $request->getValues();
226  unset( $query['title'] );
227  $url = $title->getFullURL( $query );
228  }
229  // Check for a redirect loop
230  if ( !preg_match( '/^' . preg_quote( $this->config->get( 'Server' ), '/' ) . '/', $url )
231  && $title->isLocal()
232  ) {
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 );
241  }
242  throw new BadTitleError();
243  }
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  $specialPage->setContext( $this->context );
252  if ( $this->config->get( 'HideIdentifiableRedirects' )
253  && $specialPage->personallyIdentifiableTarget()
254  ) {
255  list( , $subpage ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
256  $target = $specialPage->getRedirect( $subpage );
257  // target can also be true. We let that case fall through to normal processing.
258  if ( $target instanceof Title ) {
259  $query = $specialPage->getRedirectQuery() ?: [];
260  $request = new DerivativeRequest( $this->context->getRequest(), $query );
261  $request->setRequestURL( $this->context->getRequest()->getRequestURL() );
262  $this->context->setRequest( $request );
263  // Do not varnish cache these. May vary even for anons
264  $this->context->getOutput()->lowerCdnMaxage( 0 );
265  $this->context->setTitle( $target );
266  $wgTitle = $target;
267  // Reset action type cache. (Special pages have only view)
268  $this->action = null;
269  $title = $target;
271  'wgInternalRedirectTargetUrl' => $target->getFullURL( $query ),
272  ] );
273  $output->addModules( 'mediawiki.action.view.redirect' );
274  }
275  }
276  }
277  }
278 
279  // Special pages ($title may have changed since if statement above)
280  if ( NS_SPECIAL == $title->getNamespace() ) {
281  // Actions that need to be made when we have a special pages
282  SpecialPageFactory::executePath( $title, $this->context );
283  } else {
284  // ...otherwise treat it as an article view. The article
285  // may still be a wikipage redirect to another article or URL.
286  $article = $this->initializeArticle();
287  if ( is_object( $article ) ) {
288  $this->performAction( $article, $requestTitle );
289  } elseif ( is_string( $article ) ) {
290  $output->redirect( $article );
291  } else {
292  throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle()"
293  . " returned neither an object nor a URL" );
294  }
295  }
296  }
297  }
298 
321  private function tryNormaliseRedirect( Title $title ) {
322  $request = $this->context->getRequest();
323  $output = $this->context->getOutput();
324 
325  if ( $request->getVal( 'action', 'view' ) != 'view'
326  || $request->wasPosted()
327  || ( $request->getVal( 'title' ) !== null
328  && $title->getPrefixedDBkey() == $request->getVal( 'title' ) )
329  || count( $request->getValueNames( [ 'action', 'title' ] ) )
330  || !Hooks::run( 'TestCanonicalRedirect', [ $request, $title, $output ] )
331  ) {
332  return false;
333  }
334 
335  if ( $title->isSpecialPage() ) {
336  list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
337  if ( $name ) {
338  $title = SpecialPage::getTitleFor( $name, $subpage );
339  }
340  }
341  // Redirect to canonical url, make it a 301 to allow caching
342  $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
343  if ( $targetUrl == $request->getFullRequestURL() ) {
344  $message = "Redirect loop detected!\n\n" .
345  "This means the wiki got confused about what page was " .
346  "requested; this sometimes happens when moving a wiki " .
347  "to a new server or changing the server configuration.\n\n";
348 
349  if ( $this->config->get( 'UsePathInfo' ) ) {
350  $message .= "The wiki is trying to interpret the page " .
351  "title from the URL path portion (PATH_INFO), which " .
352  "sometimes fails depending on the web server. Try " .
353  "setting \"\$wgUsePathInfo = false;\" in your " .
354  "LocalSettings.php, or check that \$wgArticlePath " .
355  "is correct.";
356  } else {
357  $message .= "Your web server was detected as possibly not " .
358  "supporting URL path components (PATH_INFO) correctly; " .
359  "check your LocalSettings.php for a customized " .
360  "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
361  "to true.";
362  }
363  throw new HttpError( 500, $message );
364  }
365  $output->setSquidMaxage( 1200 );
366  $output->redirect( $targetUrl, '301' );
367  return true;
368  }
369 
376  private function initializeArticle() {
377  $title = $this->context->getTitle();
378  if ( $this->context->canUseWikiPage() ) {
379  // Try to use request context wiki page, as there
380  // is already data from db saved in per process
381  // cache there from this->getAction() call.
382  $page = $this->context->getWikiPage();
383  } else {
384  // This case should not happen, but just in case.
385  // @TODO: remove this or use an exception
387  $this->context->setWikiPage( $page );
388  wfWarn( "RequestContext::canUseWikiPage() returned false" );
389  }
390 
391  // Make GUI wrapper for the WikiPage
392  $article = Article::newFromWikiPage( $page, $this->context );
393 
394  // Skip some unnecessary code if the content model doesn't support redirects
395  if ( !ContentHandler::getForTitle( $title )->supportsRedirects() ) {
396  return $article;
397  }
398 
399  $request = $this->context->getRequest();
400 
401  // Namespace might change when using redirects
402  // Check for redirects ...
403  $action = $request->getVal( 'action', 'view' );
404  $file = ( $page instanceof WikiFilePage ) ? $page->getFile() : null;
405  if ( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
406  && !$request->getVal( 'oldid' ) // ... and are not old revisions
407  && !$request->getVal( 'diff' ) // ... and not when showing diff
408  && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
409  // ... and the article is not a non-redirect image page with associated file
410  && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
411  ) {
412  // Give extensions a change to ignore/handle redirects as needed
413  $ignoreRedirect = $target = false;
414 
415  Hooks::run( 'InitializeArticleMaybeRedirect',
416  [ &$title, &$request, &$ignoreRedirect, &$target, &$article ] );
417  $page = $article->getPage(); // reflect any hook changes
418 
419  // Follow redirects only for... redirects.
420  // If $target is set, then a hook wanted to redirect.
421  if ( !$ignoreRedirect && ( $target || $page->isRedirect() ) ) {
422  // Is the target already set by an extension?
423  $target = $target ? $target : $page->followRedirect();
424  if ( is_string( $target ) ) {
425  if ( !$this->config->get( 'DisableHardRedirects' ) ) {
426  // we'll need to redirect
427  return $target;
428  }
429  }
430  if ( is_object( $target ) ) {
431  // Rewrite environment to redirected article
432  $rpage = WikiPage::factory( $target );
433  $rpage->loadPageData();
434  if ( $rpage->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
435  $rarticle = Article::newFromWikiPage( $rpage, $this->context );
436  $rarticle->setRedirectedFrom( $title );
437 
438  $article = $rarticle;
439  $this->context->setTitle( $target );
440  $this->context->setWikiPage( $article->getPage() );
441  }
442  }
443  } else {
444  // Article may have been changed by hook
445  $this->context->setTitle( $article->getTitle() );
446  $this->context->setWikiPage( $article->getPage() );
447  }
448  }
449 
450  return $article;
451  }
452 
459  private function performAction( Page $page, Title $requestTitle ) {
460  $request = $this->context->getRequest();
461  $output = $this->context->getOutput();
462  $title = $this->context->getTitle();
463  $user = $this->context->getUser();
464 
465  if ( !Hooks::run( 'MediaWikiPerformAction',
466  [ $output, $page, $title, $user, $request, $this ] )
467  ) {
468  return;
469  }
470 
471  $act = $this->getAction();
472  $action = Action::factory( $act, $page, $this->context );
473 
474  if ( $action instanceof Action ) {
475  // Narrow DB query expectations for this HTTP request
476  $trxLimits = $this->config->get( 'TrxProfilerLimits' );
477  $trxProfiler = Profiler::instance()->getTransactionProfiler();
478  if ( $request->wasPosted() && !$action->doesWrites() ) {
479  $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__ );
480  }
481 
482  # Let CDN cache things if we can purge them.
483  if ( $this->config->get( 'UseSquid' ) &&
484  in_array(
485  // Use PROTO_INTERNAL because that's what getCdnUrls() uses
486  wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL ),
487  $requestTitle->getCdnUrls()
488  )
489  ) {
490  $output->setCdnMaxage( $this->config->get( 'SquidMaxage' ) );
491  }
492 
493  $action->show();
494  return;
495  }
496 
497  if ( Hooks::run( 'UnknownAction', [ $request->getVal( 'action', 'view' ), $page ] ) ) {
498  $output->setStatusCode( 404 );
499  $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
500  }
501  }
502 
506  public function run() {
507  try {
508  try {
509  $this->main();
510  } catch ( ErrorPageError $e ) {
511  // Bug 62091: while exceptions are convenient to bubble up GUI errors,
512  // they are not internal application faults. As with normal requests, this
513  // should commit, print the output, do deferred updates, jobs, and profiling.
514  $this->doPreOutputCommit();
515  $e->report(); // display the GUI error
516  }
517  } catch ( Exception $e ) {
519  }
520 
521  $this->doPostOutputShutdown( 'normal' );
522  }
523 
528  public function doPreOutputCommit() {
529  self::preOutputCommit( $this->context );
530  }
531 
539  public static function preOutputCommit( IContextSource $context ) {
540  // Either all DBs should commit or none
541  ignore_user_abort( true );
542 
543  $config = $context->getConfig();
544 
546  // Commit all changes
547  $factory->commitMasterChanges(
548  __METHOD__,
549  // Abort if any transaction was too big
550  [ 'maxWriteDuration' => $config->get( 'MaxUserDBWriteDuration' ) ]
551  );
552  // Record ChronologyProtector positions
553  $factory->shutdown();
554  wfDebug( __METHOD__ . ': all transactions committed' );
555 
557  wfDebug( __METHOD__ . ': pre-send deferred updates completed' );
558 
559  // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
560  // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
561  // ChronologyProtector works for cacheable URLs.
562  $request = $context->getRequest();
563  if ( $request->wasPosted() && $factory->hasOrMadeRecentMasterChanges() ) {
564  $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
565  $options = [ 'prefix' => '' ];
566  $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
567  $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
568  }
569 
570  // Avoid letting a few seconds of slave lag cause a month of stale data. This logic is
571  // also intimately related to the value of $wgCdnReboundPurgeDelay.
572  if ( $factory->laggedSlaveUsed() ) {
573  $maxAge = $config->get( 'CdnMaxageLagged' );
574  $context->getOutput()->lowerCdnMaxage( $maxAge );
575  $request->response()->header( "X-Database-Lagged: true" );
576  wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
577  }
578 
579  // Avoid long-term cache pollution due to message cache rebuild timeouts (T133069)
580  if ( MessageCache::singleton()->isDisabled() ) {
581  $maxAge = $config->get( 'CdnMaxageSubstitute' );
582  $context->getOutput()->lowerCdnMaxage( $maxAge );
583  $request->response()->header( "X-Response-Substitute: true" );
584  }
585  }
586 
597  public function doPostOutputShutdown( $mode = 'normal' ) {
598  $timing = $this->context->getTiming();
599  $timing->mark( 'requestShutdown' );
600 
601  // Show visible profiling data if enabled (which cannot be post-send)
602  Profiler::instance()->logDataPageOutputOnly();
603 
604  $that = $this;
605  $callback = function () use ( $that, $mode ) {
606  try {
607  $that->restInPeace( $mode );
608  } catch ( Exception $e ) {
610  }
611  };
612 
613  // Defer everything else...
614  if ( function_exists( 'register_postsend_function' ) ) {
615  // https://github.com/facebook/hhvm/issues/1230
616  register_postsend_function( $callback );
617  } else {
618  if ( function_exists( 'fastcgi_finish_request' ) ) {
619  fastcgi_finish_request();
620  } else {
621  // Either all DB and deferred updates should happen or none.
622  // The later should not be cancelled due to client disconnect.
623  ignore_user_abort( true );
624  }
625 
626  $callback();
627  }
628  }
629 
630  private function main() {
632 
633  $request = $this->context->getRequest();
634 
635  // Send Ajax requests to the Ajax dispatcher.
636  if ( $this->config->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
637  // Set a dummy title, because $wgTitle == null might break things
638  $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
639  . __METHOD__
640  );
641  $this->context->setTitle( $title );
642  $wgTitle = $title;
643 
644  $dispatcher = new AjaxDispatcher( $this->config );
645  $dispatcher->performAction( $this->context->getUser() );
646  return;
647  }
648 
649  // Get title from request parameters,
650  // is set on the fly by parseTitle the first time.
651  $title = $this->getTitle();
652  $action = $this->getAction();
653  $wgTitle = $title;
654 
655  // Set DB query expectations for this HTTP request
656  $trxLimits = $this->config->get( 'TrxProfilerLimits' );
657  $trxProfiler = Profiler::instance()->getTransactionProfiler();
658  $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
659  if ( $request->wasPosted() ) {
660  $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__ );
661  } else {
662  $trxProfiler->setExpectations( $trxLimits['GET'], __METHOD__ );
663  }
664 
665  // If the user has forceHTTPS set to true, or if the user
666  // is in a group requiring HTTPS, or if they have the HTTPS
667  // preference set, redirect them to HTTPS.
668  // Note: Do this after $wgTitle is setup, otherwise the hooks run from
669  // isLoggedIn() will do all sorts of weird stuff.
670  if (
671  $request->getProtocol() == 'http' &&
672  (
673  $request->getSession()->shouldForceHTTPS() ||
674  // Check the cookie manually, for paranoia
675  $request->getCookie( 'forceHTTPS', '' ) ||
676  // check for prefixed version that was used for a time in older MW versions
677  $request->getCookie( 'forceHTTPS' ) ||
678  // Avoid checking the user and groups unless it's enabled.
679  (
680  $this->context->getUser()->isLoggedIn()
681  && $this->context->getUser()->requiresHTTPS()
682  )
683  )
684  ) {
685  $oldUrl = $request->getFullRequestURL();
686  $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
687 
688  // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
689  if ( Hooks::run( 'BeforeHttpsRedirect', [ $this->context, &$redirUrl ] ) ) {
690 
691  if ( $request->wasPosted() ) {
692  // This is weird and we'd hope it almost never happens. This
693  // means that a POST came in via HTTP and policy requires us
694  // redirecting to HTTPS. It's likely such a request is going
695  // to fail due to post data being lost, but let's try anyway
696  // and just log the instance.
697 
698  // @todo FIXME: See if we could issue a 307 or 308 here, need
699  // to see how clients (automated & browser) behave when we do
700  wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
701  }
702  // Setup dummy Title, otherwise OutputPage::redirect will fail
703  $title = Title::newFromText( 'REDIR', NS_MAIN );
704  $this->context->setTitle( $title );
705  $output = $this->context->getOutput();
706  // Since we only do this redir to change proto, always send a vary header
707  $output->addVaryHeader( 'X-Forwarded-Proto' );
708  $output->redirect( $redirUrl );
709  $output->output();
710  return;
711  }
712  }
713 
714  if ( $this->config->get( 'UseFileCache' ) && $title->getNamespace() >= 0 ) {
715  if ( HTMLFileCache::useFileCache( $this->context ) ) {
716  // Try low-level file cache hit
718  if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
719  // Check incoming headers to see if client has this cached
720  $timestamp = $cache->cacheTimestamp();
721  if ( !$this->context->getOutput()->checkLastModified( $timestamp ) ) {
722  $cache->loadFromFileCache( $this->context );
723  }
724  // Do any stats increment/watchlist stuff
725  // Assume we're viewing the latest revision (this should always be the case with file cache)
726  $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
727  // Tell OutputPage that output is taken care of
728  $this->context->getOutput()->disable();
729  return;
730  }
731  }
732  }
733 
734  // Actually do the work of the request and build up any output
735  $this->performRequest();
736 
737  // Now commit any transactions, so that unreported errors after
738  // output() don't roll back the whole DB transaction and so that
739  // we avoid having both success and error text in the response
740  $this->doPreOutputCommit();
741 
742  // Output everything!
743  $this->context->getOutput()->output();
744  }
745 
750  public function restInPeace( $mode = 'fast' ) {
751  // Assure deferred updates are not in the main transaction
752  wfGetLBFactory()->commitMasterChanges( __METHOD__ );
753 
754  // Ignore things like master queries/connections on GET requests
755  // as long as they are in deferred updates (which catch errors).
756  Profiler::instance()->getTransactionProfiler()->resetExpectations();
757 
758  // Do any deferred jobs
759  DeferredUpdates::doUpdates( 'enqueue' );
760 
761  // Make sure any lazy jobs are pushed
763 
764  // Now that everything specific to this request is done,
765  // try to occasionally run jobs (if enabled) from the queues
766  if ( $mode === 'normal' ) {
767  $this->triggerJobs();
768  }
769 
770  // Log profiling data, e.g. in the database or UDP
772 
773  // Commit and close up!
775  $factory->commitMasterChanges( __METHOD__ );
777 
778  wfDebug( "Request ended normally\n" );
779  }
780 
786  public function triggerJobs() {
787  $jobRunRate = $this->config->get( 'JobRunRate' );
788  if ( $jobRunRate <= 0 || wfReadOnly() ) {
789  return;
790  } elseif ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
791  return; // recursion guard
792  }
793 
794  if ( $jobRunRate < 1 ) {
795  $max = mt_getrandmax();
796  if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
797  return; // the higher the job run rate, the less likely we return here
798  }
799  $n = 1;
800  } else {
801  $n = intval( $jobRunRate );
802  }
803 
804  $runJobsLogger = LoggerFactory::getInstance( 'runJobs' );
805 
806  // Fall back to running the job(s) while the user waits if needed
807  if ( !$this->config->get( 'RunJobsAsync' ) ) {
808  $runner = new JobRunner( $runJobsLogger );
809  $runner->run( [ 'maxJobs' => $n ] );
810  return;
811  }
812 
813  // Do not send request if there are probably no jobs
814  try {
815  $group = JobQueueGroup::singleton();
816  if ( !$group->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
817  return;
818  }
819  } catch ( JobQueueError $e ) {
821  return; // do not make the site unavailable
822  }
823 
824  $query = [ 'title' => 'Special:RunJobs',
825  'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 ];
827  $query, $this->config->get( 'SecretKey' ) );
828 
829  $errno = $errstr = null;
830  $info = wfParseUrl( $this->config->get( 'CanonicalServer' ) );
831  $host = $info ? $info['host'] : null;
832  $port = 80;
833  if ( isset( $info['scheme'] ) && $info['scheme'] == 'https' ) {
834  $host = "tls://" . $host;
835  $port = 443;
836  }
837  if ( isset( $info['port'] ) ) {
838  $port = $info['port'];
839  }
840 
841  MediaWiki\suppressWarnings();
842  $sock = $host ? fsockopen(
843  $host,
844  $port,
845  $errno,
846  $errstr,
847  // If it takes more than 100ms to connect to ourselves there is a problem...
848  0.100
849  ) : false;
850  MediaWiki\restoreWarnings();
851 
852  $invokedWithSuccess = true;
853  if ( $sock ) {
854  $special = SpecialPageFactory::getPage( 'RunJobs' );
855  $url = $special->getPageTitle()->getCanonicalURL( $query );
856  $req = (
857  "POST $url HTTP/1.1\r\n" .
858  "Host: {$info['host']}\r\n" .
859  "Connection: Close\r\n" .
860  "Content-Length: 0\r\n\r\n"
861  );
862 
863  $runJobsLogger->info( "Running $n job(s) via '$url'" );
864  // Send a cron API request to be performed in the background.
865  // Give up if this takes too long to send (which should be rare).
866  stream_set_timeout( $sock, 2 );
867  $bytes = fwrite( $sock, $req );
868  if ( $bytes !== strlen( $req ) ) {
869  $invokedWithSuccess = false;
870  $runJobsLogger->error( "Failed to start cron API (socket write error)" );
871  } else {
872  // Do not wait for the response (the script should handle client aborts).
873  // Make sure that we don't close before that script reaches ignore_user_abort().
874  $start = microtime( true );
875  $status = fgets( $sock );
876  $sec = microtime( true ) - $start;
877  if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
878  $invokedWithSuccess = false;
879  $runJobsLogger->error( "Failed to start cron API: received '$status' ($sec)" );
880  }
881  }
882  fclose( $sock );
883  } else {
884  $invokedWithSuccess = false;
885  $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
886  }
887 
888  // Fall back to running the job(s) while the user waits if needed
889  if ( !$invokedWithSuccess ) {
890  $runJobsLogger->warning( "Jobs switched to blocking; Special:RunJobs disabled" );
891 
892  $runner = new JobRunner( $runJobsLogger );
893  $runner->run( [ 'maxJobs' => $n ] );
894  }
895  }
896 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:99
Config $config
Definition: MediaWiki.php:37
static newFromID($id, $flags=0)
Create a new Title from an article ID.
Definition: Title.php:417
this hook is for auditing only RecentChangesLinked and Watchlist $special
Definition: hooks.txt:965
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
Interface for objects which can provide a MediaWiki context on request.
doPostOutputShutdown($mode= 'normal')
This function does work that can be done after the user gets the HTTP response so they don't block on...
Definition: MediaWiki.php:597
static doUpdates($mode= 'run', $type=self::ALL)
Do any deferred updates and clear the list.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1418
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
const NS_MAIN
Definition: Defines.php:69
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:569
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name.
Definition: SpecialPage.php:75
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:1932
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1798
restInPeace($mode= 'fast')
Ends this task peacefully.
Definition: MediaWiki.php:750
static instance()
Singleton.
Definition: Profiler.php:60
Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base reque...
wfLogProfilingData()
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function array $article
Definition: hooks.txt:78
Page view caching in the file system.
const NS_SPECIAL
Definition: Defines.php:58
const PROTO_CURRENT
Definition: Defines.php:264
getAction()
Returns the name of the action that will be executed.
Definition: MediaWiki.php:148
initializeArticle()
Initialize the main Article object for "standard" actions (view, etc) Create an Article object for th...
Definition: MediaWiki.php:376
static handleException($e)
Exception handler which simulates the appropriate catch() handling:
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:277
A helper class for throttling authentication attempts.
Represents a title within MediaWiki.
Definition: Title.php:34
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
__construct(IContextSource $context=null)
Definition: MediaWiki.php:47
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
static useFileCache(IContextSource $context)
Check if pages can be cached for this request/user.
static executePath(Title &$title, IContextSource &$context, $including=false)
Execute a special page path.
static preOutputCommit(IContextSource $context)
This function commits all DB changes as needed before the user can receive a response (in case commit...
Definition: MediaWiki.php:539
static pushLazyJobs()
Push all jobs buffered via lazyPush() into their respective queues.
get($name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
$factory
static factory($action, Page $page, IContextSource $context=null)
Get an appropriate Action subclass for the given action.
Definition: Action.php:95
Actions are things which can be done to pages (edit, delete, rollback, etc).
Definition: Action.php:37
Show an error that looks like an HTTP server error.
Definition: HttpError.php:30
getRequest()
Get the WebRequest object.
static getPage($name)
Find the object with a given name and return it (or NULL)
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
getConfig()
Get the site configuration.
const SHUTDOWN_NO_CHRONPROT
Definition: LBFactory.php:47
Interface for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
Definition: Page.php:24
wfReadOnly()
Check whether the wiki is in read-only mode.
static getMain()
Static methods.
IContextSource $context
Definition: MediaWiki.php:32
An error page which can definitely be safely rendered using the OutputPage.
const PROTO_INTERNAL
Definition: Defines.php:266
getDBkey()
Get the main part with underscores.
Definition: Title.php:911
wfWarn($msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
if($limit) $timestamp
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1004
performAction(Page $page, Title $requestTitle)
Perform one of the "standard" actions.
Definition: MediaWiki.php:459
const NS_MEDIA
Definition: Defines.php:57
Shortcut to construct a special page alias.
getCdnUrls()
Get a list of URLs to purge from the CDN cache when this page changes.
Definition: Title.php:3572
$cache
Definition: mcc.php:33
parseTitle()
Parse the request to get the Title object.
Definition: MediaWiki.php:62
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
static getActionName(IContextSource $context)
Get the action that will be executed, not necessarily the one passed passed through the "action" requ...
Definition: Action.php:122
const NS_FILE
Definition: Defines.php:75
addModules($modules)
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1584
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
Special handling for file pages.
triggerJobs()
Potentially open a socket and sent an HTTP request back to the server to run a specified number of jo...
Definition: MediaWiki.php:786
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
static singleton($wiki=false)
Show an error page on a badtitle.
getTitle()
Get the Title object that we'll be acting on, as specified in the WebRequest.
Definition: MediaWiki.php:132
String $action
Cache what action this request is.
Definition: MediaWiki.php:42
static newFromTextThrow($text, $defaultNamespace=NS_MAIN)
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null.
Definition: Title.php:307
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
Definition: hooks.txt:1004
isSpecialPage()
Returns true if this is a special page.
Definition: Title.php:1045
static newFromId($id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:99
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
this hook is for auditing only $req
Definition: hooks.txt:965
wfGetLBFactory()
Get the load balancer factory object.
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2418
run()
Run the current MediaWiki instance; index.php just calls this.
Definition: MediaWiki.php:506
performRequest()
Performs the request.
Definition: MediaWiki.php:168
static resolveAlias($alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
Job queue runner utility methods.
Definition: JobRunner.php:34
doPreOutputCommit()
Definition: MediaWiki.php:528
action
static newFromURL($url)
THIS IS NOT THE FUNCTION YOU WANT.
Definition: Title.php:354
Show an error when a user tries to do something they do not have the necessary permissions for...
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1004
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method.MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances.The"Spi"in MediaWiki\Logger\Spi stands for"service provider interface".An SPI is an API intended to be implemented or extended by a third party.This software design pattern is intended to enable framework extension and replaceable components.It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki.The service provider interface allows the backend logging library to be implemented in multiple ways.The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime.This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance.Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
static getQuerySignature(array $query, $secretKey)
getOutput()
Get the OutputPage object.
addJsConfigVars($keys, $value=null)
Add one or more variables to be set in mw.config in JavaScript.
if(!$wgRequest->checkUrlExtension()) if(!$wgEnableAPI) $wgTitle
Definition: api.php:57
static logException($e)
Log an exception to the exception log (if enabled).
static newFromWikiPage(WikiPage $page, IContextSource $context)
Create an Article object of the appropriate class for the given page.
Definition: Article.php:146
wfParseUrl($url)
parse_url() work-alike, but non-broken.
getRequest()
Get the WebRequest object.
Object-Oriented Ajax functions.
static & makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:524
static singleton()
Get the signleton instance of this class.
tryNormaliseRedirect(Title $title)
Handle redirects for uncanonical title requests.
Definition: MediaWiki.php:321
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2338
getPrefixedDBkey()
Get the prefixed database key form.
Definition: Title.php:1437
getFullURL($query= '', $query2=false, $proto=PROTO_RELATIVE)
Get a real URL referring to this title, with interwiki link and fragment.
Definition: Title.php:1666
getOutput()
Get the OutputPage object.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310