MediaWiki  master
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 
323  private function tryNormaliseRedirect( Title $title ) {
324  $request = $this->context->getRequest();
325  $output = $this->context->getOutput();
326 
327  if ( $request->getVal( 'action', 'view' ) != 'view'
328  || $request->wasPosted()
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 
344  if ( $targetUrl != $request->getFullRequestURL() ) {
345  $output->setCdnMaxage( 1200 );
346  $output->redirect( $targetUrl, '301' );
347  return true;
348  }
349 
350  // If there is no title, or the title is in a non-standard encoding, we demand
351  // a redirect. If cgi somehow changed the 'title' query to be non-standard while
352  // the url is standard, the server is misconfigured.
353  if ( $request->getVal( 'title' ) === null
354  || $title->getPrefixedDBkey() != $request->getVal( 'title' )
355  ) {
356  $message = "Redirect loop detected!\n\n" .
357  "This means the wiki got confused about what page was " .
358  "requested; this sometimes happens when moving a wiki " .
359  "to a new server or changing the server configuration.\n\n";
360 
361  if ( $this->config->get( 'UsePathInfo' ) ) {
362  $message .= "The wiki is trying to interpret the page " .
363  "title from the URL path portion (PATH_INFO), which " .
364  "sometimes fails depending on the web server. Try " .
365  "setting \"\$wgUsePathInfo = false;\" in your " .
366  "LocalSettings.php, or check that \$wgArticlePath " .
367  "is correct.";
368  } else {
369  $message .= "Your web server was detected as possibly not " .
370  "supporting URL path components (PATH_INFO) correctly; " .
371  "check your LocalSettings.php for a customized " .
372  "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
373  "to true.";
374  }
375  throw new HttpError( 500, $message );
376  }
377  return false;
378  }
379 
386  private function initializeArticle() {
387  $title = $this->context->getTitle();
388  if ( $this->context->canUseWikiPage() ) {
389  // Try to use request context wiki page, as there
390  // is already data from db saved in per process
391  // cache there from this->getAction() call.
392  $page = $this->context->getWikiPage();
393  } else {
394  // This case should not happen, but just in case.
395  // @TODO: remove this or use an exception
397  $this->context->setWikiPage( $page );
398  wfWarn( "RequestContext::canUseWikiPage() returned false" );
399  }
400 
401  // Make GUI wrapper for the WikiPage
402  $article = Article::newFromWikiPage( $page, $this->context );
403 
404  // Skip some unnecessary code if the content model doesn't support redirects
405  if ( !ContentHandler::getForTitle( $title )->supportsRedirects() ) {
406  return $article;
407  }
408 
409  $request = $this->context->getRequest();
410 
411  // Namespace might change when using redirects
412  // Check for redirects ...
413  $action = $request->getVal( 'action', 'view' );
414  $file = ( $page instanceof WikiFilePage ) ? $page->getFile() : null;
415  if ( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
416  && !$request->getVal( 'oldid' ) // ... and are not old revisions
417  && !$request->getVal( 'diff' ) // ... and not when showing diff
418  && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
419  // ... and the article is not a non-redirect image page with associated file
420  && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
421  ) {
422  // Give extensions a change to ignore/handle redirects as needed
423  $ignoreRedirect = $target = false;
424 
425  Hooks::run( 'InitializeArticleMaybeRedirect',
426  [ &$title, &$request, &$ignoreRedirect, &$target, &$article ] );
427  $page = $article->getPage(); // reflect any hook changes
428 
429  // Follow redirects only for... redirects.
430  // If $target is set, then a hook wanted to redirect.
431  if ( !$ignoreRedirect && ( $target || $page->isRedirect() ) ) {
432  // Is the target already set by an extension?
433  $target = $target ? $target : $page->followRedirect();
434  if ( is_string( $target ) ) {
435  if ( !$this->config->get( 'DisableHardRedirects' ) ) {
436  // we'll need to redirect
437  return $target;
438  }
439  }
440  if ( is_object( $target ) ) {
441  // Rewrite environment to redirected article
442  $rpage = WikiPage::factory( $target );
443  $rpage->loadPageData();
444  if ( $rpage->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
445  $rarticle = Article::newFromWikiPage( $rpage, $this->context );
446  $rarticle->setRedirectedFrom( $title );
447 
448  $article = $rarticle;
449  $this->context->setTitle( $target );
450  $this->context->setWikiPage( $article->getPage() );
451  }
452  }
453  } else {
454  // Article may have been changed by hook
455  $this->context->setTitle( $article->getTitle() );
456  $this->context->setWikiPage( $article->getPage() );
457  }
458  }
459 
460  return $article;
461  }
462 
469  private function performAction( Page $page, Title $requestTitle ) {
470  $request = $this->context->getRequest();
471  $output = $this->context->getOutput();
472  $title = $this->context->getTitle();
473  $user = $this->context->getUser();
474 
475  if ( !Hooks::run( 'MediaWikiPerformAction',
476  [ $output, $page, $title, $user, $request, $this ] )
477  ) {
478  return;
479  }
480 
481  $act = $this->getAction();
482  $action = Action::factory( $act, $page, $this->context );
483 
484  if ( $action instanceof Action ) {
485  // Narrow DB query expectations for this HTTP request
486  $trxLimits = $this->config->get( 'TrxProfilerLimits' );
487  $trxProfiler = Profiler::instance()->getTransactionProfiler();
488  if ( $request->wasPosted() && !$action->doesWrites() ) {
489  $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__ );
490  $request->markAsSafeRequest();
491  }
492 
493  # Let CDN cache things if we can purge them.
494  if ( $this->config->get( 'UseSquid' ) &&
495  in_array(
496  // Use PROTO_INTERNAL because that's what getCdnUrls() uses
497  wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL ),
498  $requestTitle->getCdnUrls()
499  )
500  ) {
501  $output->setCdnMaxage( $this->config->get( 'SquidMaxage' ) );
502  }
503 
504  $action->show();
505  return;
506  }
507 
508  if ( Hooks::run( 'UnknownAction', [ $request->getVal( 'action', 'view' ), $page ] ) ) {
509  $output->setStatusCode( 404 );
510  $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
511  }
512  }
513 
517  public function run() {
518  try {
519  try {
520  $this->main();
521  } catch ( ErrorPageError $e ) {
522  // Bug 62091: while exceptions are convenient to bubble up GUI errors,
523  // they are not internal application faults. As with normal requests, this
524  // should commit, print the output, do deferred updates, jobs, and profiling.
525  $this->doPreOutputCommit();
526  $e->report(); // display the GUI error
527  }
528  } catch ( Exception $e ) {
530  }
531 
532  $this->doPostOutputShutdown( 'normal' );
533  }
534 
539  public function doPreOutputCommit() {
540  self::preOutputCommit( $this->context );
541  }
542 
550  public static function preOutputCommit( IContextSource $context ) {
551  // Either all DBs should commit or none
552  ignore_user_abort( true );
553 
554  $config = $context->getConfig();
555 
557  // Commit all changes
558  $factory->commitMasterChanges(
559  __METHOD__,
560  // Abort if any transaction was too big
561  [ 'maxWriteDuration' => $config->get( 'MaxUserDBWriteDuration' ) ]
562  );
563  // Record ChronologyProtector positions
564  $factory->shutdown();
565  wfDebug( __METHOD__ . ': all transactions committed' );
566 
568  wfDebug( __METHOD__ . ': pre-send deferred updates completed' );
569 
570  // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
571  // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
572  // ChronologyProtector works for cacheable URLs.
573  $request = $context->getRequest();
574  if ( $request->wasPosted() && $factory->hasOrMadeRecentMasterChanges() ) {
575  $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
576  $options = [ 'prefix' => '' ];
577  $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
578  $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
579  }
580 
581  // Avoid letting a few seconds of slave lag cause a month of stale data. This logic is
582  // also intimately related to the value of $wgCdnReboundPurgeDelay.
583  if ( $factory->laggedSlaveUsed() ) {
584  $maxAge = $config->get( 'CdnMaxageLagged' );
585  $context->getOutput()->lowerCdnMaxage( $maxAge );
586  $request->response()->header( "X-Database-Lagged: true" );
587  wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
588  }
589 
590  // Avoid long-term cache pollution due to message cache rebuild timeouts (T133069)
591  if ( MessageCache::singleton()->isDisabled() ) {
592  $maxAge = $config->get( 'CdnMaxageSubstitute' );
593  $context->getOutput()->lowerCdnMaxage( $maxAge );
594  $request->response()->header( "X-Response-Substitute: true" );
595  }
596  }
597 
608  public function doPostOutputShutdown( $mode = 'normal' ) {
609  $timing = $this->context->getTiming();
610  $timing->mark( 'requestShutdown' );
611 
612  // Show visible profiling data if enabled (which cannot be post-send)
613  Profiler::instance()->logDataPageOutputOnly();
614 
615  $that = $this;
616  $callback = function () use ( $that, $mode ) {
617  try {
618  $that->restInPeace( $mode );
619  } catch ( Exception $e ) {
621  }
622  };
623 
624  // Defer everything else...
625  if ( function_exists( 'register_postsend_function' ) ) {
626  // https://github.com/facebook/hhvm/issues/1230
627  register_postsend_function( $callback );
628  } else {
629  if ( function_exists( 'fastcgi_finish_request' ) ) {
630  fastcgi_finish_request();
631  } else {
632  // Either all DB and deferred updates should happen or none.
633  // The later should not be cancelled due to client disconnect.
634  ignore_user_abort( true );
635  }
636 
637  $callback();
638  }
639  }
640 
641  private function main() {
643 
644  $request = $this->context->getRequest();
645 
646  // Send Ajax requests to the Ajax dispatcher.
647  if ( $this->config->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
648  // Set a dummy title, because $wgTitle == null might break things
649  $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
650  . __METHOD__
651  );
652  $this->context->setTitle( $title );
653  $wgTitle = $title;
654 
655  $dispatcher = new AjaxDispatcher( $this->config );
656  $dispatcher->performAction( $this->context->getUser() );
657  return;
658  }
659 
660  // Get title from request parameters,
661  // is set on the fly by parseTitle the first time.
662  $title = $this->getTitle();
663  $action = $this->getAction();
664  $wgTitle = $title;
665 
666  // Set DB query expectations for this HTTP request
667  $trxLimits = $this->config->get( 'TrxProfilerLimits' );
668  $trxProfiler = Profiler::instance()->getTransactionProfiler();
669  $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
670  if ( $request->hasSafeMethod() ) {
671  $trxProfiler->setExpectations( $trxLimits['GET'], __METHOD__ );
672  } else {
673  $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__ );
674  }
675 
676  // If the user has forceHTTPS set to true, or if the user
677  // is in a group requiring HTTPS, or if they have the HTTPS
678  // preference set, redirect them to HTTPS.
679  // Note: Do this after $wgTitle is setup, otherwise the hooks run from
680  // isLoggedIn() will do all sorts of weird stuff.
681  if (
682  $request->getProtocol() == 'http' &&
683  // switch to HTTPS only when supported by the server
684  preg_match( '#^https://#', wfExpandUrl( $request->getRequestURL(), PROTO_HTTPS ) ) &&
685  (
686  $request->getSession()->shouldForceHTTPS() ||
687  // Check the cookie manually, for paranoia
688  $request->getCookie( 'forceHTTPS', '' ) ||
689  // check for prefixed version that was used for a time in older MW versions
690  $request->getCookie( 'forceHTTPS' ) ||
691  // Avoid checking the user and groups unless it's enabled.
692  (
693  $this->context->getUser()->isLoggedIn()
694  && $this->context->getUser()->requiresHTTPS()
695  )
696  )
697  ) {
698  $oldUrl = $request->getFullRequestURL();
699  $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
700 
701  // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
702  if ( Hooks::run( 'BeforeHttpsRedirect', [ $this->context, &$redirUrl ] ) ) {
703 
704  if ( $request->wasPosted() ) {
705  // This is weird and we'd hope it almost never happens. This
706  // means that a POST came in via HTTP and policy requires us
707  // redirecting to HTTPS. It's likely such a request is going
708  // to fail due to post data being lost, but let's try anyway
709  // and just log the instance.
710 
711  // @todo FIXME: See if we could issue a 307 or 308 here, need
712  // to see how clients (automated & browser) behave when we do
713  wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
714  }
715  // Setup dummy Title, otherwise OutputPage::redirect will fail
716  $title = Title::newFromText( 'REDIR', NS_MAIN );
717  $this->context->setTitle( $title );
718  $output = $this->context->getOutput();
719  // Since we only do this redir to change proto, always send a vary header
720  $output->addVaryHeader( 'X-Forwarded-Proto' );
721  $output->redirect( $redirUrl );
722  $output->output();
723  return;
724  }
725  }
726 
727  if ( $this->config->get( 'UseFileCache' ) && $title->getNamespace() >= 0 ) {
728  if ( HTMLFileCache::useFileCache( $this->context ) ) {
729  // Try low-level file cache hit
731  if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
732  // Check incoming headers to see if client has this cached
733  $timestamp = $cache->cacheTimestamp();
734  if ( !$this->context->getOutput()->checkLastModified( $timestamp ) ) {
735  $cache->loadFromFileCache( $this->context );
736  }
737  // Do any stats increment/watchlist stuff
738  // Assume we're viewing the latest revision (this should always be the case with file cache)
739  $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
740  // Tell OutputPage that output is taken care of
741  $this->context->getOutput()->disable();
742  return;
743  }
744  }
745  }
746 
747  // Actually do the work of the request and build up any output
748  $this->performRequest();
749 
750  // Now commit any transactions, so that unreported errors after
751  // output() don't roll back the whole DB transaction and so that
752  // we avoid having both success and error text in the response
753  $this->doPreOutputCommit();
754 
755  // Output everything!
756  $this->context->getOutput()->output();
757  }
758 
763  public function restInPeace( $mode = 'fast' ) {
764  // Assure deferred updates are not in the main transaction
765  wfGetLBFactory()->commitMasterChanges( __METHOD__ );
766 
767  // Loosen DB query expectations since the HTTP client is unblocked
768  $trxProfiler = Profiler::instance()->getTransactionProfiler();
769  $trxProfiler->resetExpectations();
770  $trxProfiler->setExpectations(
771  $this->config->get( 'TrxProfilerLimits' )['PostSend'],
772  __METHOD__
773  );
774 
775  // Do any deferred jobs
776  DeferredUpdates::doUpdates( 'enqueue' );
777 
778  // Make sure any lazy jobs are pushed
780 
781  // Now that everything specific to this request is done,
782  // try to occasionally run jobs (if enabled) from the queues
783  if ( $mode === 'normal' ) {
784  $this->triggerJobs();
785  }
786 
787  // Log profiling data, e.g. in the database or UDP
789 
790  // Commit and close up!
792  $factory->commitMasterChanges( __METHOD__ );
794 
795  wfDebug( "Request ended normally\n" );
796  }
797 
803  public function triggerJobs() {
804  $jobRunRate = $this->config->get( 'JobRunRate' );
805  if ( $jobRunRate <= 0 || wfReadOnly() ) {
806  return;
807  } elseif ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
808  return; // recursion guard
809  }
810 
811  if ( $jobRunRate < 1 ) {
812  $max = mt_getrandmax();
813  if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
814  return; // the higher the job run rate, the less likely we return here
815  }
816  $n = 1;
817  } else {
818  $n = intval( $jobRunRate );
819  }
820 
821  $runJobsLogger = LoggerFactory::getInstance( 'runJobs' );
822 
823  if ( !$this->config->get( 'RunJobsAsync' ) ) {
824  // Fall back to running the job here while the user waits
825  $runner = new JobRunner( $runJobsLogger );
826  $runner->run( [ 'maxJobs' => $n ] );
827  return;
828  }
829 
830  try {
831  if ( !JobQueueGroup::singleton()->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
832  return; // do not send request if there are probably no jobs
833  }
834  } catch ( JobQueueError $e ) {
836  return; // do not make the site unavailable
837  }
838 
839  $query = [ 'title' => 'Special:RunJobs',
840  'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 ];
842  $query, $this->config->get( 'SecretKey' ) );
843 
844  $errno = $errstr = null;
845  $info = wfParseUrl( $this->config->get( 'Server' ) );
846  MediaWiki\suppressWarnings();
847  $host = $info['host'];
848  $port = 80;
849  if ( isset( $info['scheme'] ) && $info['scheme'] == 'https' ) {
850  $host = "tls://" . $host;
851  $port = 443;
852  }
853  if ( isset( $info['port'] ) ) {
854  $port = $info['port'];
855  }
856  $sock = fsockopen(
857  $host,
858  $port,
859  $errno,
860  $errstr,
861  // If it takes more than 100ms to connect to ourselves there
862  // is a problem elsewhere.
863  0.1
864  );
865  MediaWiki\restoreWarnings();
866  if ( !$sock ) {
867  $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
868  // Fall back to running the job here while the user waits
869  $runner = new JobRunner( $runJobsLogger );
870  $runner->run( [ 'maxJobs' => $n ] );
871  return;
872  }
873 
874  $url = wfAppendQuery( wfScript( 'index' ), $query );
875  $req = (
876  "POST $url HTTP/1.1\r\n" .
877  "Host: {$info['host']}\r\n" .
878  "Connection: Close\r\n" .
879  "Content-Length: 0\r\n\r\n"
880  );
881 
882  $runJobsLogger->info( "Running $n job(s) via '$url'" );
883  // Send a cron API request to be performed in the background.
884  // Give up if this takes too long to send (which should be rare).
885  stream_set_timeout( $sock, 1 );
886  $bytes = fwrite( $sock, $req );
887  if ( $bytes !== strlen( $req ) ) {
888  $runJobsLogger->error( "Failed to start cron API (socket write error)" );
889  } else {
890  // Do not wait for the response (the script should handle client aborts).
891  // Make sure that we don't close before that script reaches ignore_user_abort().
892  $status = fgets( $sock );
893  if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
894  $runJobsLogger->error( "Failed to start cron API: received '$status'" );
895  }
896  }
897  fclose( $sock );
898  }
899 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:101
Config $config
Definition: MediaWiki.php:37
static newFromID($id, $flags=0)
Create a new Title from an article ID.
Definition: Title.php:396
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:608
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:1435
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
wfScript($script= 'index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
const NS_MAIN
Definition: Defines.php:69
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:548
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:80
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:1980
restInPeace($mode= 'fast')
Ends this task peacefully.
Definition: MediaWiki.php:763
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:265
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:386
The MediaWiki class is the helper class for the index.php entry point.
Definition: MediaWiki.php:28
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:256
Represents a title within MediaWiki.
Definition: Title.php:36
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 preOutputCommit(IContextSource $context)
This function commits all DB changes as needed before the user can receive a response (in case commit...
Definition: MediaWiki.php:550
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
const PROTO_HTTPS
Definition: Defines.php:263
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
wfAppendQuery($url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
An error page which can definitely be safely rendered using the OutputPage.
const PROTO_INTERNAL
Definition: Defines.php:267
getDBkey()
Get the main part with underscores.
Definition: Title.php:890
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:1020
performAction(Page $page, Title $requestTitle)
Perform one of the "standard" actions.
Definition: MediaWiki.php:469
const NS_MEDIA
Definition: Defines.php:57
Shortcut to construct a special page alias.
MediaWiki exception.
Definition: MWException.php:26
getCdnUrls()
Get a list of URLs to purge from the CDN cache when this page changes.
Definition: Title.php:3528
$cache
Definition: mcc.php:33
parseTitle()
Parse the request to get the Title object.
Definition: MediaWiki.php:62
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead.&$feedLinks conditions will AND in the final query as a Content object as a Content object $title
Definition: hooks.txt:312
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:1601
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:1816
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:803
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:286
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:1020
isSpecialPage()
Returns true if this is a special page.
Definition: Title.php:1026
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:981
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:2458
run()
Run the current MediaWiki instance; index.php just calls this.
Definition: MediaWiki.php:517
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:539
static newFromURL($url)
THIS IS NOT THE FUNCTION YOU WANT.
Definition: Title.php:333
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
static executePath(Title &$title, IContextSource &$context, $including=false, LinkRenderer $linkRenderer=null)
Execute a special page path.
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:1020
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.
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:503
Object-Oriented Ajax functions.
static singleton()
Get the signleton instance of this class.
tryNormaliseRedirect(Title $title)
Handle redirects for uncanonical title requests.
Definition: MediaWiki.php:323
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:2376
getPrefixedDBkey()
Get the prefixed database key form.
Definition: Title.php:1418
getFullURL($query= '', $query2=false, $proto=PROTO_RELATIVE)
Get a real URL referring to this title, with interwiki link and fragment.
Definition: Title.php:1647
getOutput()
Get the OutputPage object.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310