MediaWiki  master
MediaWiki.php
Go to the documentation of this file.
1 <?php
30 
34 class MediaWiki {
38  private $context;
39 
43  private $config;
44 
48  private $action;
49 
53  public function __construct( IContextSource $context = null ) {
54  if ( !$context ) {
56  }
57 
58  $this->context = $context;
59  $this->config = $context->getConfig();
60  }
61 
68  private function parseTitle() {
69  $request = $this->context->getRequest();
70  $curid = $request->getInt( 'curid' );
71  $title = $request->getVal( 'title' );
72  $action = $request->getVal( 'action' );
73 
74  if ( $request->getCheck( 'search' ) ) {
75  // Compatibility with old search URLs which didn't use Special:Search
76  // Just check for presence here, so blank requests still
77  // show the search page when using ugly URLs (T10054).
78  $ret = SpecialPage::getTitleFor( 'Search' );
79  } elseif ( $curid ) {
80  // URLs like this are generated by RC, because rc_title isn't always accurate
81  $ret = Title::newFromID( $curid );
82  } else {
84  // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
85  // in wikitext links to tell Parser to make a direct file link
86  if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA ) {
87  $ret = Title::makeTitle( NS_FILE, $ret->getDBkey() );
88  }
89  $contLang = MediaWikiServices::getInstance()->getContentLanguage();
90  // Check variant links so that interwiki links don't have to worry
91  // about the possible different language variants
92  if (
93  $contLang->hasVariants() && !is_null( $ret ) && $ret->getArticleID() == 0
94  ) {
95  $contLang->findVariantLink( $title, $ret );
96  }
97  }
98 
99  // If title is not provided, always allow oldid and diff to set the title.
100  // If title is provided, allow oldid and diff to override the title, unless
101  // we are talking about a special page which might use these parameters for
102  // other purposes.
103  if ( $ret === null || !$ret->isSpecialPage() ) {
104  // We can have urls with just ?diff=,?oldid= or even just ?diff=
105  $oldid = $request->getInt( 'oldid' );
106  $oldid = $oldid ?: $request->getInt( 'diff' );
107  // Allow oldid to override a changed or missing title
108  if ( $oldid ) {
109  $rev = Revision::newFromId( $oldid );
110  $ret = $rev ? $rev->getTitle() : $ret;
111  }
112  }
113 
114  // Use the main page as default title if nothing else has been provided
115  if ( $ret === null
116  && strval( $title ) === ''
117  && !$request->getCheck( 'curid' )
118  && $action !== 'delete'
119  ) {
121  }
122 
123  if ( $ret === null || ( $ret->getDBkey() == '' && !$ret->isExternal() ) ) {
124  // If we get here, we definitely don't have a valid title; throw an exception.
125  // Try to get detailed invalid title exception first, fall back to MalformedTitleException.
127  throw new MalformedTitleException( 'badtitletext', $title );
128  }
129 
130  return $ret;
131  }
132 
137  public function getTitle() {
138  if ( !$this->context->hasTitle() ) {
139  try {
140  $this->context->setTitle( $this->parseTitle() );
141  } catch ( MalformedTitleException $ex ) {
142  $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
143  }
144  }
145  return $this->context->getTitle();
146  }
147 
153  public function getAction() {
154  if ( $this->action === null ) {
155  $this->action = Action::getActionName( $this->context );
156  }
157 
158  return $this->action;
159  }
160 
173  private function performRequest() {
174  global $wgTitle;
175 
176  $request = $this->context->getRequest();
177  $requestTitle = $title = $this->context->getTitle();
178  $output = $this->context->getOutput();
179  $user = $this->context->getUser();
180 
181  if ( $request->getVal( 'printable' ) === 'yes' ) {
182  $output->setPrintable();
183  }
184 
185  $unused = null; // To pass it by reference
186  Hooks::run( 'BeforeInitialize', [ &$title, &$unused, &$output, &$user, $request, $this ] );
187 
188  // Invalid titles. T23776: The interwikis must redirect even if the page name is empty.
189  if ( is_null( $title ) || ( $title->getDBkey() == '' && !$title->isExternal() )
190  || $title->isSpecial( 'Badtitle' )
191  ) {
192  $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
193  try {
194  $this->parseTitle();
195  } catch ( MalformedTitleException $ex ) {
196  throw new BadTitleError( $ex );
197  }
198  throw new BadTitleError();
199  }
200 
201  // Check user's permissions to read this page.
202  // We have to check here to catch special pages etc.
203  // We will check again in Article::view().
204  $permErrors = $title->isSpecial( 'RunJobs' )
205  ? [] // relies on HMAC key signature alone
206  : $title->getUserPermissionsErrors( 'read', $user );
207  if ( count( $permErrors ) ) {
208  // T34276: allowing the skin to generate output with $wgTitle or
209  // $this->context->title set to the input title would allow anonymous users to
210  // determine whether a page exists, potentially leaking private data. In fact, the
211  // curid and oldid request parameters would allow page titles to be enumerated even
212  // when they are not guessable. So we reset the title to Special:Badtitle before the
213  // permissions error is displayed.
214 
215  // The skin mostly uses $this->context->getTitle() these days, but some extensions
216  // still use $wgTitle.
217  $badTitle = SpecialPage::getTitleFor( 'Badtitle' );
218  $this->context->setTitle( $badTitle );
219  $wgTitle = $badTitle;
220 
221  throw new PermissionsError( 'read', $permErrors );
222  }
223 
224  // Interwiki redirects
225  if ( $title->isExternal() ) {
226  $rdfrom = $request->getVal( 'rdfrom' );
227  if ( $rdfrom ) {
228  $url = $title->getFullURL( [ 'rdfrom' => $rdfrom ] );
229  } else {
230  $query = $request->getValues();
231  unset( $query['title'] );
232  $url = $title->getFullURL( $query );
233  }
234  // Check for a redirect loop
235  if ( !preg_match( '/^' . preg_quote( $this->config->get( 'Server' ), '/' ) . '/', $url )
236  && $title->isLocal()
237  ) {
238  // 301 so google et al report the target as the actual url.
239  $output->redirect( $url, 301 );
240  } else {
241  $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
242  try {
243  $this->parseTitle();
244  } catch ( MalformedTitleException $ex ) {
245  throw new BadTitleError( $ex );
246  }
247  throw new BadTitleError();
248  }
249  // Handle any other redirects.
250  // Redirect loops, titleless URL, $wgUsePathInfo URLs, and URLs with a variant
251  } elseif ( !$this->tryNormaliseRedirect( $title ) ) {
252  // Prevent information leak via Special:MyPage et al (T109724)
253  $spFactory = MediaWikiServices::getInstance()->getSpecialPageFactory();
254  if ( $title->isSpecialPage() ) {
255  $specialPage = $spFactory->getPage( $title->getDBkey() );
256  if ( $specialPage instanceof RedirectSpecialPage ) {
257  $specialPage->setContext( $this->context );
258  if ( $this->config->get( 'HideIdentifiableRedirects' )
259  && $specialPage->personallyIdentifiableTarget()
260  ) {
261  list( , $subpage ) = $spFactory->resolveAlias( $title->getDBkey() );
262  $target = $specialPage->getRedirect( $subpage );
263  // target can also be true. We let that case fall through to normal processing.
264  if ( $target instanceof Title ) {
265  $query = $specialPage->getRedirectQuery() ?: [];
266  $request = new DerivativeRequest( $this->context->getRequest(), $query );
267  $request->setRequestURL( $this->context->getRequest()->getRequestURL() );
268  $this->context->setRequest( $request );
269  // Do not varnish cache these. May vary even for anons
270  $this->context->getOutput()->lowerCdnMaxage( 0 );
271  $this->context->setTitle( $target );
272  $wgTitle = $target;
273  // Reset action type cache. (Special pages have only view)
274  $this->action = null;
275  $title = $target;
276  $output->addJsConfigVars( [
277  'wgInternalRedirectTargetUrl' => $target->getFullURL( $query ),
278  ] );
279  $output->addModules( 'mediawiki.action.view.redirect' );
280  }
281  }
282  }
283  }
284 
285  // Special pages ($title may have changed since if statement above)
286  if ( $title->isSpecialPage() ) {
287  // Actions that need to be made when we have a special pages
288  $spFactory->executePath( $title, $this->context );
289  } else {
290  // ...otherwise treat it as an article view. The article
291  // may still be a wikipage redirect to another article or URL.
292  $article = $this->initializeArticle();
293  if ( is_object( $article ) ) {
294  $this->performAction( $article, $requestTitle );
295  } elseif ( is_string( $article ) ) {
296  $output->redirect( $article );
297  } else {
298  throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle()"
299  . " returned neither an object nor a URL" );
300  }
301  }
302  }
303  }
304 
327  private function tryNormaliseRedirect( Title $title ) {
328  $request = $this->context->getRequest();
329  $output = $this->context->getOutput();
330 
331  if ( $request->getVal( 'action', 'view' ) != 'view'
332  || $request->wasPosted()
333  || ( $request->getVal( 'title' ) !== null
334  && $title->getPrefixedDBkey() == $request->getVal( 'title' ) )
335  || count( $request->getValueNames( [ 'action', 'title' ] ) )
336  || !Hooks::run( 'TestCanonicalRedirect', [ $request, $title, $output ] )
337  ) {
338  return false;
339  }
340 
341  if ( $title->isSpecialPage() ) {
342  list( $name, $subpage ) = MediaWikiServices::getInstance()->getSpecialPageFactory()->
343  resolveAlias( $title->getDBkey() );
344  if ( $name ) {
345  $title = SpecialPage::getTitleFor( $name, $subpage );
346  }
347  }
348  // Redirect to canonical url, make it a 301 to allow caching
349  $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
350  if ( $targetUrl == $request->getFullRequestURL() ) {
351  $message = "Redirect loop detected!\n\n" .
352  "This means the wiki got confused about what page was " .
353  "requested; this sometimes happens when moving a wiki " .
354  "to a new server or changing the server configuration.\n\n";
355 
356  if ( $this->config->get( 'UsePathInfo' ) ) {
357  $message .= "The wiki is trying to interpret the page " .
358  "title from the URL path portion (PATH_INFO), which " .
359  "sometimes fails depending on the web server. Try " .
360  "setting \"\$wgUsePathInfo = false;\" in your " .
361  "LocalSettings.php, or check that \$wgArticlePath " .
362  "is correct.";
363  } else {
364  $message .= "Your web server was detected as possibly not " .
365  "supporting URL path components (PATH_INFO) correctly; " .
366  "check your LocalSettings.php for a customized " .
367  "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
368  "to true.";
369  }
370  throw new HttpError( 500, $message );
371  }
372  $output->setCdnMaxage( 1200 );
373  $output->redirect( $targetUrl, '301' );
374  return true;
375  }
376 
383  private function initializeArticle() {
384  $title = $this->context->getTitle();
385  if ( $this->context->canUseWikiPage() ) {
386  // Try to use request context wiki page, as there
387  // is already data from db saved in per process
388  // cache there from this->getAction() call.
389  $page = $this->context->getWikiPage();
390  } else {
391  // This case should not happen, but just in case.
392  // @TODO: remove this or use an exception
393  $page = WikiPage::factory( $title );
394  $this->context->setWikiPage( $page );
395  wfWarn( "RequestContext::canUseWikiPage() returned false" );
396  }
397 
398  // Make GUI wrapper for the WikiPage
399  $article = Article::newFromWikiPage( $page, $this->context );
400 
401  // Skip some unnecessary code if the content model doesn't support redirects
402  if ( !ContentHandler::getForTitle( $title )->supportsRedirects() ) {
403  return $article;
404  }
405 
406  $request = $this->context->getRequest();
407 
408  // Namespace might change when using redirects
409  // Check for redirects ...
410  $action = $request->getVal( 'action', 'view' );
411  $file = ( $page instanceof WikiFilePage ) ? $page->getFile() : null;
412  if ( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
413  && !$request->getVal( 'oldid' ) // ... and are not old revisions
414  && !$request->getVal( 'diff' ) // ... and not when showing diff
415  && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
416  // ... and the article is not a non-redirect image page with associated file
417  && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
418  ) {
419  // Give extensions a change to ignore/handle redirects as needed
420  $ignoreRedirect = $target = false;
421 
422  Hooks::run( 'InitializeArticleMaybeRedirect',
423  [ &$title, &$request, &$ignoreRedirect, &$target, &$article ] );
424  $page = $article->getPage(); // reflect any hook changes
425 
426  // Follow redirects only for... redirects.
427  // If $target is set, then a hook wanted to redirect.
428  if ( !$ignoreRedirect && ( $target || $page->isRedirect() ) ) {
429  // Is the target already set by an extension?
430  $target = $target ?: $page->followRedirect();
431  if ( is_string( $target ) ) {
432  if ( !$this->config->get( 'DisableHardRedirects' ) ) {
433  // we'll need to redirect
434  return $target;
435  }
436  }
437  if ( is_object( $target ) ) {
438  // Rewrite environment to redirected article
439  $rpage = WikiPage::factory( $target );
440  $rpage->loadPageData();
441  if ( $rpage->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
442  $rarticle = Article::newFromWikiPage( $rpage, $this->context );
443  $rarticle->setRedirectedFrom( $title );
444 
445  $article = $rarticle;
446  $this->context->setTitle( $target );
447  $this->context->setWikiPage( $article->getPage() );
448  }
449  }
450  } else {
451  // Article may have been changed by hook
452  $this->context->setTitle( $article->getTitle() );
453  $this->context->setWikiPage( $article->getPage() );
454  }
455  }
456 
457  return $article;
458  }
459 
466  private function performAction( Page $page, Title $requestTitle ) {
467  $request = $this->context->getRequest();
468  $output = $this->context->getOutput();
469  $title = $this->context->getTitle();
470  $user = $this->context->getUser();
471 
472  if ( !Hooks::run( 'MediaWikiPerformAction',
473  [ $output, $page, $title, $user, $request, $this ] )
474  ) {
475  return;
476  }
477 
478  $act = $this->getAction();
479  $action = Action::factory( $act, $page, $this->context );
480 
481  if ( $action instanceof Action ) {
482  // Narrow DB query expectations for this HTTP request
483  $trxLimits = $this->config->get( 'TrxProfilerLimits' );
484  $trxProfiler = Profiler::instance()->getTransactionProfiler();
485  if ( $request->wasPosted() && !$action->doesWrites() ) {
486  $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__ );
487  $request->markAsSafeRequest();
488  }
489 
490  # Let CDN cache things if we can purge them.
491  if ( $this->config->get( 'UseSquid' ) &&
492  in_array(
493  // Use PROTO_INTERNAL because that's what getCdnUrls() uses
494  wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL ),
495  $requestTitle->getCdnUrls()
496  )
497  ) {
498  $output->setCdnMaxage( $this->config->get( 'SquidMaxage' ) );
499  }
500 
501  $action->show();
502  return;
503  }
504 
505  // If we've not found out which action it is by now, it's unknown
506  $output->setStatusCode( 404 );
507  $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
508  }
509 
513  public function run() {
514  try {
515  $this->setDBProfilingAgent();
516  try {
517  $this->main();
518  } catch ( ErrorPageError $e ) {
519  // T64091: while exceptions are convenient to bubble up GUI errors,
520  // they are not internal application faults. As with normal requests, this
521  // should commit, print the output, do deferred updates, jobs, and profiling.
522  $this->doPreOutputCommit();
523  $e->report(); // display the GUI error
524  }
525  } catch ( Exception $e ) {
527  $action = $context->getRequest()->getVal( 'action', 'view' );
528  if (
529  $e instanceof DBConnectionError &&
530  $context->hasTitle() &&
531  $context->getTitle()->canExist() &&
532  in_array( $action, [ 'view', 'history' ], true ) &&
534  ) {
535  // Try to use any (even stale) file during outages...
537  if ( $cache->isCached() ) {
538  $cache->loadFromFileCache( $context, HTMLFileCache::MODE_OUTAGE );
540  exit;
541  }
542  }
543 
545  } catch ( Error $e ) {
546  // Type errors and such: at least handle it now and clean up the LBFactory state
548  }
549 
550  $this->doPostOutputShutdown( 'normal' );
551  }
552 
553  private function setDBProfilingAgent() {
555  // Add a comment for easy SHOW PROCESSLIST interpretation
556  $name = $this->context->getUser()->getName();
557  $services->getDBLoadBalancerFactory()->setAgentName(
558  mb_strlen( $name ) > 15 ? mb_substr( $name, 0, 15 ) . '...' : $name
559  );
560  }
561 
567  public function doPreOutputCommit( callable $postCommitWork = null ) {
568  self::preOutputCommit( $this->context, $postCommitWork );
569  }
570 
582  public static function preOutputCommit(
583  IContextSource $context, callable $postCommitWork = null
584  ) {
585  // Either all DBs should commit or none
586  ignore_user_abort( true );
587 
588  $config = $context->getConfig();
589  $request = $context->getRequest();
590  $output = $context->getOutput();
591  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
592 
593  // Commit all changes
594  $lbFactory->commitMasterChanges(
595  __METHOD__,
596  // Abort if any transaction was too big
597  [ 'maxWriteDuration' => $config->get( 'MaxUserDBWriteDuration' ) ]
598  );
599  wfDebug( __METHOD__ . ': primary transaction round committed' );
600 
601  // Run updates that need to block the user or affect output (this is the last chance)
603  wfDebug( __METHOD__ . ': pre-send deferred updates completed' );
604  // T214471: persist the session to avoid race conditions on subsequent requests
605  $request->getSession()->save();
606 
607  // Should the client return, their request should observe the new ChronologyProtector
608  // DB positions. This request might be on a foreign wiki domain, so synchronously update
609  // the DB positions in all datacenters to be safe. If this output is not a redirect,
610  // then OutputPage::output() will be relatively slow, meaning that running it in
611  // $postCommitWork should help mask the latency of those updates.
612  $flags = $lbFactory::SHUTDOWN_CHRONPROT_SYNC;
613  $strategy = 'cookie+sync';
614 
615  $allowHeaders = !( $output->isDisabled() || headers_sent() );
616  if ( $output->getRedirect() && $lbFactory->hasOrMadeRecentMasterChanges( INF ) ) {
617  // OutputPage::output() will be fast, so $postCommitWork is useless for masking
618  // the latency of synchronously updating the DB positions in all datacenters.
619  // Try to make use of the time the client spends following redirects instead.
620  $domainDistance = self::getUrlDomainDistance( $output->getRedirect() );
621  if ( $domainDistance === 'local' && $allowHeaders ) {
622  $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
623  $strategy = 'cookie'; // use same-domain cookie and keep the URL uncluttered
624  } elseif ( $domainDistance === 'remote' ) {
625  $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
626  $strategy = 'cookie+url'; // cross-domain cookie might not work
627  }
628  }
629 
630  // Record ChronologyProtector positions for DBs affected in this request at this point
631  $cpIndex = null;
632  $cpClientId = null;
633  $lbFactory->shutdown( $flags, $postCommitWork, $cpIndex, $cpClientId );
634  wfDebug( __METHOD__ . ': LBFactory shutdown completed' );
635 
636  if ( $cpIndex > 0 ) {
637  if ( $allowHeaders ) {
638  $now = time();
639  $expires = $now + ChronologyProtector::POSITION_COOKIE_TTL;
640  $options = [ 'prefix' => '' ];
641  $value = LBFactory::makeCookieValueFromCPIndex( $cpIndex, $now, $cpClientId );
642  $request->response()->setCookie( 'cpPosIndex', $value, $expires, $options );
643  }
644 
645  if ( $strategy === 'cookie+url' ) {
646  if ( $output->getRedirect() ) { // sanity
647  $safeUrl = $lbFactory->appendShutdownCPIndexAsQuery(
648  $output->getRedirect(),
649  $cpIndex
650  );
651  $output->redirect( $safeUrl );
652  } else {
653  $e = new LogicException( "No redirect; cannot append cpPosIndex parameter." );
655  }
656  }
657  }
658 
659  // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
660  // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
661  // ChronologyProtector works for cacheable URLs.
662  if ( $request->wasPosted() && $lbFactory->hasOrMadeRecentMasterChanges() ) {
663  $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
664  $options = [ 'prefix' => '' ];
665  $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
666  $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
667  }
668 
669  // Avoid letting a few seconds of replica DB lag cause a month of stale data. This logic is
670  // also intimately related to the value of $wgCdnReboundPurgeDelay.
671  if ( $lbFactory->laggedReplicaUsed() ) {
672  $maxAge = $config->get( 'CdnMaxageLagged' );
673  $output->lowerCdnMaxage( $maxAge );
674  $request->response()->header( "X-Database-Lagged: true" );
675  wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
676  }
677 
678  // Avoid long-term cache pollution due to message cache rebuild timeouts (T133069)
679  if ( MessageCache::singleton()->isDisabled() ) {
680  $maxAge = $config->get( 'CdnMaxageSubstitute' );
681  $output->lowerCdnMaxage( $maxAge );
682  $request->response()->header( "X-Response-Substitute: true" );
683  }
684  }
685 
690  private static function getUrlDomainDistance( $url ) {
691  $clusterWiki = WikiMap::getWikiFromUrl( $url );
692  if ( WikiMap::isCurrentWikiId( $clusterWiki ) ) {
693  return 'local'; // the current wiki
694  }
695  if ( $clusterWiki !== false ) {
696  return 'remote'; // another wiki in this cluster/farm
697  }
698 
699  return 'external';
700  }
701 
712  public function doPostOutputShutdown( $mode = 'normal' ) {
713  // Record backend request timing
714  $timing = $this->context->getTiming();
715  $timing->mark( 'requestShutdown' );
716 
717  // Perform the last synchronous operations...
718  try {
719  // Show visible profiling data if enabled (which cannot be post-send)
720  Profiler::instance()->logDataPageOutputOnly();
721  } catch ( Exception $e ) {
722  // An error may already have been shown in run(), so just log it to be safe
724  }
725 
726  // Disable WebResponse setters for post-send processing (T191537).
728 
729  $blocksHttpClient = true;
730  // Defer everything else if possible...
731  $callback = function () use ( $mode, &$blocksHttpClient ) {
732  try {
733  $this->restInPeace( $mode, $blocksHttpClient );
734  } catch ( Exception $e ) {
735  // If this is post-send, then displaying errors can cause broken HTML
737  }
738  };
739 
740  if ( function_exists( 'register_postsend_function' ) ) {
741  // https://github.com/facebook/hhvm/issues/1230
742  register_postsend_function( $callback );
744  $blocksHttpClient = false;
745  } else {
746  if ( function_exists( 'fastcgi_finish_request' ) ) {
747  fastcgi_finish_request();
749  $blocksHttpClient = false;
750  } else {
751  // Either all DB and deferred updates should happen or none.
752  // The latter should not be cancelled due to client disconnect.
753  ignore_user_abort( true );
754  }
755 
756  $callback();
757  }
758  }
759 
760  private function main() {
761  global $wgTitle;
762 
763  $output = $this->context->getOutput();
764  $request = $this->context->getRequest();
765 
766  // Send Ajax requests to the Ajax dispatcher.
767  if ( $request->getVal( 'action' ) === 'ajax' ) {
768  // Set a dummy title, because $wgTitle == null might break things
769  $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
770  . __METHOD__
771  );
772  $this->context->setTitle( $title );
773  $wgTitle = $title;
774 
775  $dispatcher = new AjaxDispatcher( $this->config );
776  $dispatcher->performAction( $this->context->getUser() );
777 
778  return;
779  }
780 
781  // Get title from request parameters,
782  // is set on the fly by parseTitle the first time.
783  $title = $this->getTitle();
784  $action = $this->getAction();
785  $wgTitle = $title;
786 
787  // Set DB query expectations for this HTTP request
788  $trxLimits = $this->config->get( 'TrxProfilerLimits' );
789  $trxProfiler = Profiler::instance()->getTransactionProfiler();
790  $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
791  if ( $request->hasSafeMethod() ) {
792  $trxProfiler->setExpectations( $trxLimits['GET'], __METHOD__ );
793  } else {
794  $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__ );
795  }
796 
797  // If the user has forceHTTPS set to true, or if the user
798  // is in a group requiring HTTPS, or if they have the HTTPS
799  // preference set, redirect them to HTTPS.
800  // Note: Do this after $wgTitle is setup, otherwise the hooks run from
801  // isLoggedIn() will do all sorts of weird stuff.
802  if (
803  $request->getProtocol() == 'http' &&
804  // switch to HTTPS only when supported by the server
805  preg_match( '#^https://#', wfExpandUrl( $request->getRequestURL(), PROTO_HTTPS ) ) &&
806  (
807  $request->getSession()->shouldForceHTTPS() ||
808  // Check the cookie manually, for paranoia
809  $request->getCookie( 'forceHTTPS', '' ) ||
810  // check for prefixed version that was used for a time in older MW versions
811  $request->getCookie( 'forceHTTPS' ) ||
812  // Avoid checking the user and groups unless it's enabled.
813  (
814  $this->context->getUser()->isLoggedIn()
815  && $this->context->getUser()->requiresHTTPS()
816  )
817  )
818  ) {
819  $oldUrl = $request->getFullRequestURL();
820  $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
821 
822  // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
823  if ( Hooks::run( 'BeforeHttpsRedirect', [ $this->context, &$redirUrl ] ) ) {
824  if ( $request->wasPosted() ) {
825  // This is weird and we'd hope it almost never happens. This
826  // means that a POST came in via HTTP and policy requires us
827  // redirecting to HTTPS. It's likely such a request is going
828  // to fail due to post data being lost, but let's try anyway
829  // and just log the instance.
830 
831  // @todo FIXME: See if we could issue a 307 or 308 here, need
832  // to see how clients (automated & browser) behave when we do
833  wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
834  }
835  // Setup dummy Title, otherwise OutputPage::redirect will fail
836  $title = Title::newFromText( 'REDIR', NS_MAIN );
837  $this->context->setTitle( $title );
838  // Since we only do this redir to change proto, always send a vary header
839  $output->addVaryHeader( 'X-Forwarded-Proto' );
840  $output->redirect( $redirUrl );
841  $output->output();
842 
843  return;
844  }
845  }
846 
847  if ( $title->canExist() && HTMLFileCache::useFileCache( $this->context ) ) {
848  // Try low-level file cache hit
850  if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
851  // Check incoming headers to see if client has this cached
852  $timestamp = $cache->cacheTimestamp();
853  if ( !$output->checkLastModified( $timestamp ) ) {
854  $cache->loadFromFileCache( $this->context );
855  }
856  // Do any stats increment/watchlist stuff, assuming user is viewing the
857  // latest revision (which should always be the case for file cache)
858  $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
859  // Tell OutputPage that output is taken care of
860  $output->disable();
861 
862  return;
863  }
864  }
865 
866  // Actually do the work of the request and build up any output
867  $this->performRequest();
868 
869  // GUI-ify and stash the page output in MediaWiki::doPreOutputCommit() while
870  // ChronologyProtector synchronizes DB positions or replicas across all datacenters.
871  $buffer = null;
872  $outputWork = function () use ( $output, &$buffer ) {
873  if ( $buffer === null ) {
874  $buffer = $output->output( true );
875  }
876 
877  return $buffer;
878  };
879 
880  // Now commit any transactions, so that unreported errors after
881  // output() don't roll back the whole DB transaction and so that
882  // we avoid having both success and error text in the response
883  $this->doPreOutputCommit( $outputWork );
884 
885  // Now send the actual output
886  print $outputWork();
887  }
888 
894  public function restInPeace( $mode = 'fast', $blocksHttpClient = true ) {
895  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
896  // Assure deferred updates are not in the main transaction
897  $lbFactory->commitMasterChanges( __METHOD__ );
898 
899  // Loosen DB query expectations since the HTTP client is unblocked
900  $trxProfiler = Profiler::instance()->getTransactionProfiler();
901  $trxProfiler->redefineExpectations(
902  $this->context->getRequest()->hasSafeMethod()
903  ? $this->config->get( 'TrxProfilerLimits' )['PostSend-GET']
904  : $this->config->get( 'TrxProfilerLimits' )['PostSend-POST'],
905  __METHOD__
906  );
907 
908  // Do any deferred jobs; preferring to run them now if a client will not wait on them
909  DeferredUpdates::doUpdates( $blocksHttpClient ? 'enqueue' : 'run' );
910 
911  // Now that everything specific to this request is done,
912  // try to occasionally run jobs (if enabled) from the queues
913  if ( $mode === 'normal' ) {
914  $this->triggerJobs();
915  }
916 
917  // Log profiling data, e.g. in the database or UDP
919 
920  // Commit and close up!
921  $lbFactory->commitMasterChanges( __METHOD__ );
922  $lbFactory->shutdown( LBFactory::SHUTDOWN_NO_CHRONPROT );
923 
924  wfDebug( "Request ended normally\n" );
925  }
926 
935  public static function emitBufferedStatsdData(
937  ) {
938  if ( $config->get( 'StatsdServer' ) && $stats->hasData() ) {
939  try {
940  $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
941  $statsdHost = $statsdServer[0];
942  $statsdPort = $statsdServer[1] ?? 8125;
943  $statsdSender = new SocketSender( $statsdHost, $statsdPort );
944  $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
945  $statsdClient->setSamplingRates( $config->get( 'StatsdSamplingRates' ) );
946  $statsdClient->send( $stats->getData() );
947 
948  $stats->clearData(); // empty buffer for the next round
949  } catch ( Exception $ex ) {
951  }
952  }
953  }
954 
960  public function triggerJobs() {
961  $jobRunRate = $this->config->get( 'JobRunRate' );
962  if ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
963  return; // recursion guard
964  } elseif ( $jobRunRate <= 0 || wfReadOnly() ) {
965  return;
966  }
967 
968  if ( $jobRunRate < 1 ) {
969  $max = mt_getrandmax();
970  if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
971  return; // the higher the job run rate, the less likely we return here
972  }
973  $n = 1;
974  } else {
975  $n = intval( $jobRunRate );
976  }
977 
978  $logger = LoggerFactory::getInstance( 'runJobs' );
979 
980  try {
981  if ( $this->config->get( 'RunJobsAsync' ) ) {
982  // Send an HTTP request to the job RPC entry point if possible
983  $invokedWithSuccess = $this->triggerAsyncJobs( $n, $logger );
984  if ( !$invokedWithSuccess ) {
985  // Fall back to blocking on running the job(s)
986  $logger->warning( "Jobs switched to blocking; Special:RunJobs disabled" );
987  $this->triggerSyncJobs( $n, $logger );
988  }
989  } else {
990  $this->triggerSyncJobs( $n, $logger );
991  }
992  } catch ( JobQueueError $e ) {
993  // Do not make the site unavailable (T88312)
995  }
996  }
997 
1002  private function triggerSyncJobs( $n, LoggerInterface $runJobsLogger ) {
1003  $trxProfiler = Profiler::instance()->getTransactionProfiler();
1004  $old = $trxProfiler->setSilenced( true );
1005  try {
1006  $runner = new JobRunner( $runJobsLogger );
1007  $runner->run( [ 'maxJobs' => $n ] );
1008  } finally {
1009  $trxProfiler->setSilenced( $old );
1010  }
1011  }
1012 
1018  private function triggerAsyncJobs( $n, LoggerInterface $runJobsLogger ) {
1019  // Do not send request if there are probably no jobs
1020  $group = JobQueueGroup::singleton();
1021  if ( !$group->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
1022  return true;
1023  }
1024 
1025  $query = [ 'title' => 'Special:RunJobs',
1026  'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 ];
1028  $query, $this->config->get( 'SecretKey' ) );
1029 
1030  $errno = $errstr = null;
1031  $info = wfParseUrl( $this->config->get( 'CanonicalServer' ) );
1032  $host = $info ? $info['host'] : null;
1033  $port = 80;
1034  if ( isset( $info['scheme'] ) && $info['scheme'] == 'https' ) {
1035  $host = "tls://" . $host;
1036  $port = 443;
1037  }
1038  if ( isset( $info['port'] ) ) {
1039  $port = $info['port'];
1040  }
1041 
1042  Wikimedia\suppressWarnings();
1043  $sock = $host ? fsockopen(
1044  $host,
1045  $port,
1046  $errno,
1047  $errstr,
1048  // If it takes more than 100ms to connect to ourselves there is a problem...
1049  0.100
1050  ) : false;
1051  Wikimedia\restoreWarnings();
1052 
1053  $invokedWithSuccess = true;
1054  if ( $sock ) {
1055  $special = MediaWikiServices::getInstance()->getSpecialPageFactory()->
1056  getPage( 'RunJobs' );
1057  $url = $special->getPageTitle()->getCanonicalURL( $query );
1058  $req = (
1059  "POST $url HTTP/1.1\r\n" .
1060  "Host: {$info['host']}\r\n" .
1061  "Connection: Close\r\n" .
1062  "Content-Length: 0\r\n\r\n"
1063  );
1064 
1065  $runJobsLogger->info( "Running $n job(s) via '$url'" );
1066  // Send a cron API request to be performed in the background.
1067  // Give up if this takes too long to send (which should be rare).
1068  stream_set_timeout( $sock, 2 );
1069  $bytes = fwrite( $sock, $req );
1070  if ( $bytes !== strlen( $req ) ) {
1071  $invokedWithSuccess = false;
1072  $runJobsLogger->error( "Failed to start cron API (socket write error)" );
1073  } else {
1074  // Do not wait for the response (the script should handle client aborts).
1075  // Make sure that we don't close before that script reaches ignore_user_abort().
1076  $start = microtime( true );
1077  $status = fgets( $sock );
1078  $sec = microtime( true ) - $start;
1079  if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
1080  $invokedWithSuccess = false;
1081  $runJobsLogger->error( "Failed to start cron API: received '$status' ($sec)" );
1082  }
1083  }
1084  fclose( $sock );
1085  } else {
1086  $invokedWithSuccess = false;
1087  $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
1088  }
1089 
1090  return $invokedWithSuccess;
1091  }
1092 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:128
Config $config
Definition: MediaWiki.php:43
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
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
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:1598
A statsd client that applies the sampling rate to the data items before sending them.
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
static newFromID( $id, $flags=0)
Create a new Title from an article ID.
Definition: Title.php:427
const NS_MAIN
Definition: Defines.php:64
register_postsend_function( $callback)
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
Definition: hhvm.php:25
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:597
triggerSyncJobs( $n, LoggerInterface $runJobsLogger)
Definition: MediaWiki.php:1002
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:1995
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2172
static instance()
Singleton.
Definition: Profiler.php:62
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
static useFileCache(IContextSource $context, $mode=self::MODE_NORMAL)
Check if pages can be cached for this request/user.
static factory( $action, Page $page, IContextSource $context=null)
Get an appropriate Action subclass for the given action.
Definition: Action.php:97
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1276
Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base reque...
wfLogProfilingData()
Page view caching in the file system.
$value
const NS_SPECIAL
Definition: Defines.php:53
const PROTO_CURRENT
Definition: Defines.php:222
static preOutputCommit(IContextSource $context, callable $postCommitWork=null)
This function commits all DB and session changes as needed before the client can receive a response (...
Definition: MediaWiki.php:582
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 MediaWikiServices
Definition: injection.txt:23
string $action
Cache what action this request is.
Definition: MediaWiki.php:48
doPostOutputShutdown( $mode='normal')
This function does work that can be done after the user gets the HTTP response so they don&#39;t block on...
Definition: MediaWiki.php:712
getAction()
Returns the name of the action that will be executed.
Definition: MediaWiki.php:153
initializeArticle()
Initialize the main Article object for "standard" actions (view, etc) Create an Article object for th...
Definition: MediaWiki.php:383
static rollbackMasterChangesAndLog( $e)
Roll back any open database transactions and log the stack trace of the exception.
A helper class for throttling authentication attempts.
__construct(IContextSource $context=null)
Definition: MediaWiki.php:53
setDBProfilingAgent()
Definition: MediaWiki.php:553
static getInstance()
Returns the global default instance of the top level service locator.
triggerAsyncJobs( $n, LoggerInterface $runJobsLogger)
Definition: MediaWiki.php:1018
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2220
Actions are things which can be done to pages (edit, delete, rollback, etc).
Definition: Action.php:39
Show an error that looks like an HTTP server error.
Definition: HttpError.php:30
getConfig()
Get the site configuration.
doPreOutputCommit(callable $postCommitWork=null)
Definition: MediaWiki.php:567
const PROTO_HTTPS
Definition: Defines.php:220
static getUrlDomainDistance( $url)
Definition: MediaWiki.php:690
wfReadOnly()
Check whether the wiki is in read-only mode.
static getMain()
Get the RequestContext object associated with the main request.
IContextSource $context
Definition: MediaWiki.php:38
Interface for configuration instances.
Definition: Config.php:28
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2220
An error page which can definitely be safely rendered using the OutputPage.
const PROTO_INTERNAL
Definition: Defines.php:224
getDBkey()
Get the main part with underscores.
Definition: Title.php:934
performAction(Page $page, Title $requestTitle)
Perform one of the "standard" actions.
Definition: MediaWiki.php:466
const NS_MEDIA
Definition: Defines.php:52
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static makeCookieValueFromCPIndex( $index, $time, $clientId)
Definition: LBFactory.php:684
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:3919
$cache
Definition: mcc.php:33
static logException( $e, $catcher=self::CAUGHT_BY_OTHER)
Log an exception to the exception log (if enabled).
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 & $options
Definition: hooks.txt:1995
parseTitle()
Parse the request to get the Title object.
Definition: MediaWiki.php:68
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
$buffer
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:935
getFullURL( $query='', $query2=false, $proto=PROTO_RELATIVE)
Get a real URL referring to this title, with interwiki link and fragment.
Definition: Title.php:1841
static getActionName(IContextSource $context)
Get the action that will be executed, not necessarily the one passed passed through the "action" requ...
Definition: Action.php:124
const NS_FILE
Definition: Defines.php:70
static handleException( $e)
Exception handler which simulates the appropriate catch() handling:
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:82
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:1779
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:960
static newFromTextThrow( $text, $defaultNamespace=NS_MAIN)
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null.
Definition: Title.php:313
Show an error page on a badtitle.
getTitle()
Get the Title object that we&#39;ll be acting on, as specified in the WebRequest.
Definition: MediaWiki.php:137
isSpecialPage()
Returns true if this is a special page.
Definition: Title.php:1092
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:545
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:989
static doUpdates( $mode='run', $stage=self::ALL)
Do any deferred updates and clear the list.
clearData()
Clear all buffered data from the factory.
run()
Run the current MediaWiki instance; index.php just calls this.
Definition: MediaWiki.php:513
static isCurrentWikiId( $wikiId)
Definition: WikiMap.php:320
performRequest()
Performs the request.
Definition: MediaWiki.php:173
static getHTML( $e)
If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error...
static newFromURL( $url)
THIS IS NOT THE FUNCTION YOU WANT.
Definition: Title.php:364
Job queue runner utility methods.
Definition: JobRunner.php:39
getData()
Return the buffered data from the factory.
static disableForPostSend()
Disable setters for post-send processing.
Definition: WebResponse.php:47
static emitBufferedStatsdData(IBufferingStatsdDataFactory $stats, Config $config)
Send out any buffered statsd data according to sampling rules.
Definition: MediaWiki.php:935
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
Show an error when a user tries to do something they do not have the necessary permissions for...
hasData()
Check whether this data factory has any buffered data.
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 singleton( $domain=false)
restInPeace( $mode='fast', $blocksHttpClient=true)
Ends this task peacefully.
Definition: MediaWiki.php:894
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static getQuerySignature(array $query, $secretKey)
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file & $article
Definition: hooks.txt:1486
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') $wgTitle
Definition: api.php:57
static newFromWikiPage(WikiPage $page, IContextSource $context)
Create an Article object of the appropriate class for the given page.
Definition: Article.php:192
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:118
static getWikiFromUrl( $url)
Definition: WikiMap.php:223
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2625
Object-Oriented Ajax functions.
static singleton()
Get the signleton instance of this class.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1486
tryNormaliseRedirect(Title $title)
Handle redirects for uncanonical title requests.
Definition: MediaWiki.php:327
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
getPrefixedDBkey()
Get the prefixed database key form.
Definition: Title.php:1612
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:280