MediaWiki  1.30.0
MediaWiki.php
Go to the documentation of this file.
1 <?php
24 use Psr\Log\LoggerInterface;
29 
33 class MediaWiki {
37  private $context;
38 
42  private $config;
43 
47  private $action;
48 
52  public function __construct( IContextSource $context = null ) {
53  if ( !$context ) {
55  }
56 
57  $this->context = $context;
58  $this->config = $context->getConfig();
59  }
60 
67  private function parseTitle() {
69 
70  $request = $this->context->getRequest();
71  $curid = $request->getInt( 'curid' );
72  $title = $request->getVal( 'title' );
73  $action = $request->getVal( 'action' );
74 
75  if ( $request->getCheck( 'search' ) ) {
76  // Compatibility with old search URLs which didn't use Special:Search
77  // Just check for presence here, so blank requests still
78  // show the search page when using ugly URLs (T10054).
79  $ret = SpecialPage::getTitleFor( 'Search' );
80  } elseif ( $curid ) {
81  // URLs like this are generated by RC, because rc_title isn't always accurate
82  $ret = Title::newFromID( $curid );
83  } else {
85  // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
86  // in wikitext links to tell Parser to make a direct file link
87  if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA ) {
88  $ret = Title::makeTitle( NS_FILE, $ret->getDBkey() );
89  }
90  // Check variant links so that interwiki links don't have to worry
91  // about the possible different language variants
92  if ( count( $wgContLang->getVariants() ) > 1
93  && !is_null( $ret ) && $ret->getArticleID() == 0
94  ) {
95  $wgContLang->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 ? $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() {
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  if ( $title->isSpecialPage() ) {
254  $specialPage = SpecialPageFactory::getPage( $title->getDBkey() );
255  if ( $specialPage instanceof RedirectSpecialPage ) {
256  $specialPage->setContext( $this->context );
257  if ( $this->config->get( 'HideIdentifiableRedirects' )
258  && $specialPage->personallyIdentifiableTarget()
259  ) {
260  list( , $subpage ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
261  $target = $specialPage->getRedirect( $subpage );
262  // target can also be true. We let that case fall through to normal processing.
263  if ( $target instanceof Title ) {
264  $query = $specialPage->getRedirectQuery() ?: [];
265  $request = new DerivativeRequest( $this->context->getRequest(), $query );
266  $request->setRequestURL( $this->context->getRequest()->getRequestURL() );
267  $this->context->setRequest( $request );
268  // Do not varnish cache these. May vary even for anons
269  $this->context->getOutput()->lowerCdnMaxage( 0 );
270  $this->context->setTitle( $target );
271  $wgTitle = $target;
272  // Reset action type cache. (Special pages have only view)
273  $this->action = null;
274  $title = $target;
275  $output->addJsConfigVars( [
276  'wgInternalRedirectTargetUrl' => $target->getFullURL( $query ),
277  ] );
278  $output->addModules( 'mediawiki.action.view.redirect' );
279  }
280  }
281  }
282  }
283 
284  // Special pages ($title may have changed since if statement above)
285  if ( $title->isSpecialPage() ) {
286  // Actions that need to be made when we have a special pages
287  SpecialPageFactory::executePath( $title, $this->context );
288  } else {
289  // ...otherwise treat it as an article view. The article
290  // may still be a wikipage redirect to another article or URL.
291  $article = $this->initializeArticle();
292  if ( is_object( $article ) ) {
293  $this->performAction( $article, $requestTitle );
294  } elseif ( is_string( $article ) ) {
295  $output->redirect( $article );
296  } else {
297  throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle()"
298  . " returned neither an object nor a URL" );
299  }
300  }
301  }
302  }
303 
326  private function tryNormaliseRedirect( Title $title ) {
327  $request = $this->context->getRequest();
328  $output = $this->context->getOutput();
329 
330  if ( $request->getVal( 'action', 'view' ) != 'view'
331  || $request->wasPosted()
332  || ( $request->getVal( 'title' ) !== null
333  && $title->getPrefixedDBkey() == $request->getVal( 'title' ) )
334  || count( $request->getValueNames( [ 'action', 'title' ] ) )
335  || !Hooks::run( 'TestCanonicalRedirect', [ $request, $title, $output ] )
336  ) {
337  return false;
338  }
339 
340  if ( $title->isSpecialPage() ) {
341  list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
342  if ( $name ) {
343  $title = SpecialPage::getTitleFor( $name, $subpage );
344  }
345  }
346  // Redirect to canonical url, make it a 301 to allow caching
347  $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
348  if ( $targetUrl == $request->getFullRequestURL() ) {
349  $message = "Redirect loop detected!\n\n" .
350  "This means the wiki got confused about what page was " .
351  "requested; this sometimes happens when moving a wiki " .
352  "to a new server or changing the server configuration.\n\n";
353 
354  if ( $this->config->get( 'UsePathInfo' ) ) {
355  $message .= "The wiki is trying to interpret the page " .
356  "title from the URL path portion (PATH_INFO), which " .
357  "sometimes fails depending on the web server. Try " .
358  "setting \"\$wgUsePathInfo = false;\" in your " .
359  "LocalSettings.php, or check that \$wgArticlePath " .
360  "is correct.";
361  } else {
362  $message .= "Your web server was detected as possibly not " .
363  "supporting URL path components (PATH_INFO) correctly; " .
364  "check your LocalSettings.php for a customized " .
365  "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
366  "to true.";
367  }
368  throw new HttpError( 500, $message );
369  }
370  $output->setSquidMaxage( 1200 );
371  $output->redirect( $targetUrl, '301' );
372  return true;
373  }
374 
381  private function initializeArticle() {
382  $title = $this->context->getTitle();
383  if ( $this->context->canUseWikiPage() ) {
384  // Try to use request context wiki page, as there
385  // is already data from db saved in per process
386  // cache there from this->getAction() call.
387  $page = $this->context->getWikiPage();
388  } else {
389  // This case should not happen, but just in case.
390  // @TODO: remove this or use an exception
391  $page = WikiPage::factory( $title );
392  $this->context->setWikiPage( $page );
393  wfWarn( "RequestContext::canUseWikiPage() returned false" );
394  }
395 
396  // Make GUI wrapper for the WikiPage
397  $article = Article::newFromWikiPage( $page, $this->context );
398 
399  // Skip some unnecessary code if the content model doesn't support redirects
400  if ( !ContentHandler::getForTitle( $title )->supportsRedirects() ) {
401  return $article;
402  }
403 
404  $request = $this->context->getRequest();
405 
406  // Namespace might change when using redirects
407  // Check for redirects ...
408  $action = $request->getVal( 'action', 'view' );
409  $file = ( $page instanceof WikiFilePage ) ? $page->getFile() : null;
410  if ( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
411  && !$request->getVal( 'oldid' ) // ... and are not old revisions
412  && !$request->getVal( 'diff' ) // ... and not when showing diff
413  && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
414  // ... and the article is not a non-redirect image page with associated file
415  && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
416  ) {
417  // Give extensions a change to ignore/handle redirects as needed
418  $ignoreRedirect = $target = false;
419 
420  Hooks::run( 'InitializeArticleMaybeRedirect',
421  [ &$title, &$request, &$ignoreRedirect, &$target, &$article ] );
422  $page = $article->getPage(); // reflect any hook changes
423 
424  // Follow redirects only for... redirects.
425  // If $target is set, then a hook wanted to redirect.
426  if ( !$ignoreRedirect && ( $target || $page->isRedirect() ) ) {
427  // Is the target already set by an extension?
428  $target = $target ? $target : $page->followRedirect();
429  if ( is_string( $target ) ) {
430  if ( !$this->config->get( 'DisableHardRedirects' ) ) {
431  // we'll need to redirect
432  return $target;
433  }
434  }
435  if ( is_object( $target ) ) {
436  // Rewrite environment to redirected article
437  $rpage = WikiPage::factory( $target );
438  $rpage->loadPageData();
439  if ( $rpage->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
440  $rarticle = Article::newFromWikiPage( $rpage, $this->context );
441  $rarticle->setRedirectedFrom( $title );
442 
443  $article = $rarticle;
444  $this->context->setTitle( $target );
445  $this->context->setWikiPage( $article->getPage() );
446  }
447  }
448  } else {
449  // Article may have been changed by hook
450  $this->context->setTitle( $article->getTitle() );
451  $this->context->setWikiPage( $article->getPage() );
452  }
453  }
454 
455  return $article;
456  }
457 
464  private function performAction( Page $page, Title $requestTitle ) {
465  $request = $this->context->getRequest();
466  $output = $this->context->getOutput();
467  $title = $this->context->getTitle();
468  $user = $this->context->getUser();
469 
470  if ( !Hooks::run( 'MediaWikiPerformAction',
471  [ $output, $page, $title, $user, $request, $this ] )
472  ) {
473  return;
474  }
475 
476  $act = $this->getAction();
477  $action = Action::factory( $act, $page, $this->context );
478 
479  if ( $action instanceof Action ) {
480  // Narrow DB query expectations for this HTTP request
481  $trxLimits = $this->config->get( 'TrxProfilerLimits' );
482  $trxProfiler = Profiler::instance()->getTransactionProfiler();
483  if ( $request->wasPosted() && !$action->doesWrites() ) {
484  $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__ );
485  $request->markAsSafeRequest();
486  }
487 
488  # Let CDN cache things if we can purge them.
489  if ( $this->config->get( 'UseSquid' ) &&
490  in_array(
491  // Use PROTO_INTERNAL because that's what getCdnUrls() uses
492  wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL ),
493  $requestTitle->getCdnUrls()
494  )
495  ) {
496  $output->setCdnMaxage( $this->config->get( 'SquidMaxage' ) );
497  }
498 
499  $action->show();
500  return;
501  }
502  // NOTE: deprecated hook. Add to $wgActions instead
503  if ( Hooks::run(
504  'UnknownAction',
505  [
506  $request->getVal( 'action', 'view' ),
507  $page
508  ],
509  '1.19'
510  ) ) {
511  $output->setStatusCode( 404 );
512  $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
513  }
514  }
515 
519  public function run() {
520  try {
521  $this->setDBProfilingAgent();
522  try {
523  $this->main();
524  } catch ( ErrorPageError $e ) {
525  // T64091: while exceptions are convenient to bubble up GUI errors,
526  // they are not internal application faults. As with normal requests, this
527  // should commit, print the output, do deferred updates, jobs, and profiling.
528  $this->doPreOutputCommit();
529  $e->report(); // display the GUI error
530  }
531  } catch ( Exception $e ) {
533  $action = $context->getRequest()->getVal( 'action', 'view' );
534  if (
535  $e instanceof DBConnectionError &&
536  $context->hasTitle() &&
537  $context->getTitle()->canExist() &&
538  in_array( $action, [ 'view', 'history' ], true ) &&
540  ) {
541  // Try to use any (even stale) file during outages...
543  if ( $cache->isCached() ) {
544  $cache->loadFromFileCache( $context, HTMLFileCache::MODE_OUTAGE );
546  exit;
547  }
548  }
549 
551  }
552 
553  $this->doPostOutputShutdown( 'normal' );
554  }
555 
556  private function setDBProfilingAgent() {
558  // Add a comment for easy SHOW PROCESSLIST interpretation
559  $name = $this->context->getUser()->getName();
560  $services->getDBLoadBalancerFactory()->setAgentName(
561  mb_strlen( $name ) > 15 ? mb_substr( $name, 0, 15 ) . '...' : $name
562  );
563  }
564 
570  public function doPreOutputCommit( callable $postCommitWork = null ) {
571  self::preOutputCommit( $this->context, $postCommitWork );
572  }
573 
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 
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 
605  // Decide when clients block on ChronologyProtector DB position writes
606  $urlDomainDistance = (
607  $request->wasPosted() &&
608  $output->getRedirect() &&
609  $lbFactory->hasOrMadeRecentMasterChanges( INF )
610  ) ? self::getUrlDomainDistance( $output->getRedirect() ) : false;
611 
612  $allowHeaders = !( $output->isDisabled() || headers_sent() );
613  if ( $urlDomainDistance === 'local' || $urlDomainDistance === 'remote' ) {
614  // OutputPage::output() will be fast; $postCommitWork will not be useful for
615  // masking the latency of syncing DB positions accross all datacenters synchronously.
616  // Instead, make use of the RTT time of the client follow redirects.
617  $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
618  $cpPosTime = microtime( true );
619  // Client's next request should see 1+ positions with this DBMasterPos::asOf() time
620  if ( $urlDomainDistance === 'local' && $allowHeaders ) {
621  // Client will stay on this domain, so set an unobtrusive cookie
622  $expires = time() + ChronologyProtector::POSITION_TTL;
623  $options = [ 'prefix' => '' ];
624  $request->response()->setCookie( 'cpPosTime', $cpPosTime, $expires, $options );
625  } else {
626  // Cookies may not work across wiki domains, so use a URL parameter
627  $safeUrl = $lbFactory->appendPreShutdownTimeAsQuery(
628  $output->getRedirect(),
629  $cpPosTime
630  );
631  $output->redirect( $safeUrl );
632  }
633  } else {
634  // OutputPage::output() is fairly slow; run it in $postCommitWork to mask
635  // the latency of syncing DB positions accross all datacenters synchronously
636  $flags = $lbFactory::SHUTDOWN_CHRONPROT_SYNC;
637  if ( $lbFactory->hasOrMadeRecentMasterChanges( INF ) && $allowHeaders ) {
638  $cpPosTime = microtime( true );
639  // Set a cookie in case the DB position store cannot sync accross datacenters.
640  // This will at least cover the common case of the user staying on the domain.
641  $expires = time() + ChronologyProtector::POSITION_TTL;
642  $options = [ 'prefix' => '' ];
643  $request->response()->setCookie( 'cpPosTime', $cpPosTime, $expires, $options );
644  }
645  }
646  // Record ChronologyProtector positions for DBs affected in this request at this point
647  $lbFactory->shutdown( $flags, $postCommitWork );
648  wfDebug( __METHOD__ . ': LBFactory shutdown completed' );
649 
650  // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
651  // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
652  // ChronologyProtector works for cacheable URLs.
653  if ( $request->wasPosted() && $lbFactory->hasOrMadeRecentMasterChanges() ) {
654  $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
655  $options = [ 'prefix' => '' ];
656  $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
657  $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
658  }
659 
660  // Avoid letting a few seconds of replica DB lag cause a month of stale data. This logic is
661  // also intimately related to the value of $wgCdnReboundPurgeDelay.
662  if ( $lbFactory->laggedReplicaUsed() ) {
663  $maxAge = $config->get( 'CdnMaxageLagged' );
664  $output->lowerCdnMaxage( $maxAge );
665  $request->response()->header( "X-Database-Lagged: true" );
666  wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
667  }
668 
669  // Avoid long-term cache pollution due to message cache rebuild timeouts (T133069)
670  if ( MessageCache::singleton()->isDisabled() ) {
671  $maxAge = $config->get( 'CdnMaxageSubstitute' );
672  $output->lowerCdnMaxage( $maxAge );
673  $request->response()->header( "X-Response-Substitute: true" );
674  }
675  }
676 
681  private static function getUrlDomainDistance( $url ) {
682  $clusterWiki = WikiMap::getWikiFromUrl( $url );
683  if ( $clusterWiki === wfWikiID() ) {
684  return 'local'; // the current wiki
685  } elseif ( $clusterWiki !== false ) {
686  return 'remote'; // another wiki in this cluster/farm
687  }
688 
689  return 'external';
690  }
691 
702  public function doPostOutputShutdown( $mode = 'normal' ) {
703  // Perform the last synchronous operations...
704  try {
705  // Record backend request timing
706  $timing = $this->context->getTiming();
707  $timing->mark( 'requestShutdown' );
708  // Show visible profiling data if enabled (which cannot be post-send)
709  Profiler::instance()->logDataPageOutputOnly();
710  } catch ( Exception $e ) {
711  // An error may already have been shown in run(), so just log it to be safe
713  }
714 
715  $blocksHttpClient = true;
716  // Defer everything else if possible...
717  $callback = function () use ( $mode, &$blocksHttpClient ) {
718  try {
719  $this->restInPeace( $mode, $blocksHttpClient );
720  } catch ( Exception $e ) {
721  // If this is post-send, then displaying errors can cause broken HTML
723  }
724  };
725 
726  if ( function_exists( 'register_postsend_function' ) ) {
727  // https://github.com/facebook/hhvm/issues/1230
728  register_postsend_function( $callback );
729  $blocksHttpClient = false;
730  } else {
731  if ( function_exists( 'fastcgi_finish_request' ) ) {
732  fastcgi_finish_request();
733  $blocksHttpClient = false;
734  } else {
735  // Either all DB and deferred updates should happen or none.
736  // The latter should not be cancelled due to client disconnect.
737  ignore_user_abort( true );
738  }
739 
740  $callback();
741  }
742  }
743 
744  private function main() {
746 
747  $output = $this->context->getOutput();
748  $request = $this->context->getRequest();
749 
750  // Send Ajax requests to the Ajax dispatcher.
751  if ( $this->config->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
752  // Set a dummy title, because $wgTitle == null might break things
753  $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
754  . __METHOD__
755  );
756  $this->context->setTitle( $title );
757  $wgTitle = $title;
758 
759  $dispatcher = new AjaxDispatcher( $this->config );
760  $dispatcher->performAction( $this->context->getUser() );
761 
762  return;
763  }
764 
765  // Get title from request parameters,
766  // is set on the fly by parseTitle the first time.
767  $title = $this->getTitle();
768  $action = $this->getAction();
769  $wgTitle = $title;
770 
771  // Set DB query expectations for this HTTP request
772  $trxLimits = $this->config->get( 'TrxProfilerLimits' );
773  $trxProfiler = Profiler::instance()->getTransactionProfiler();
774  $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
775  if ( $request->hasSafeMethod() ) {
776  $trxProfiler->setExpectations( $trxLimits['GET'], __METHOD__ );
777  } else {
778  $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__ );
779  }
780 
781  // If the user has forceHTTPS set to true, or if the user
782  // is in a group requiring HTTPS, or if they have the HTTPS
783  // preference set, redirect them to HTTPS.
784  // Note: Do this after $wgTitle is setup, otherwise the hooks run from
785  // isLoggedIn() will do all sorts of weird stuff.
786  if (
787  $request->getProtocol() == 'http' &&
788  // switch to HTTPS only when supported by the server
789  preg_match( '#^https://#', wfExpandUrl( $request->getRequestURL(), PROTO_HTTPS ) ) &&
790  (
791  $request->getSession()->shouldForceHTTPS() ||
792  // Check the cookie manually, for paranoia
793  $request->getCookie( 'forceHTTPS', '' ) ||
794  // check for prefixed version that was used for a time in older MW versions
795  $request->getCookie( 'forceHTTPS' ) ||
796  // Avoid checking the user and groups unless it's enabled.
797  (
798  $this->context->getUser()->isLoggedIn()
799  && $this->context->getUser()->requiresHTTPS()
800  )
801  )
802  ) {
803  $oldUrl = $request->getFullRequestURL();
804  $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
805 
806  // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
807  if ( Hooks::run( 'BeforeHttpsRedirect', [ $this->context, &$redirUrl ] ) ) {
808  if ( $request->wasPosted() ) {
809  // This is weird and we'd hope it almost never happens. This
810  // means that a POST came in via HTTP and policy requires us
811  // redirecting to HTTPS. It's likely such a request is going
812  // to fail due to post data being lost, but let's try anyway
813  // and just log the instance.
814 
815  // @todo FIXME: See if we could issue a 307 or 308 here, need
816  // to see how clients (automated & browser) behave when we do
817  wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
818  }
819  // Setup dummy Title, otherwise OutputPage::redirect will fail
820  $title = Title::newFromText( 'REDIR', NS_MAIN );
821  $this->context->setTitle( $title );
822  // Since we only do this redir to change proto, always send a vary header
823  $output->addVaryHeader( 'X-Forwarded-Proto' );
824  $output->redirect( $redirUrl );
825  $output->output();
826 
827  return;
828  }
829  }
830 
831  if ( $title->canExist() && HTMLFileCache::useFileCache( $this->context ) ) {
832  // Try low-level file cache hit
834  if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
835  // Check incoming headers to see if client has this cached
836  $timestamp = $cache->cacheTimestamp();
837  if ( !$output->checkLastModified( $timestamp ) ) {
838  $cache->loadFromFileCache( $this->context );
839  }
840  // Do any stats increment/watchlist stuff, assuming user is viewing the
841  // latest revision (which should always be the case for file cache)
842  $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
843  // Tell OutputPage that output is taken care of
844  $output->disable();
845 
846  return;
847  }
848  }
849 
850  // Actually do the work of the request and build up any output
851  $this->performRequest();
852 
853  // GUI-ify and stash the page output in MediaWiki::doPreOutputCommit() while
854  // ChronologyProtector synchronizes DB positions or slaves accross all datacenters.
855  $buffer = null;
856  $outputWork = function () use ( $output, &$buffer ) {
857  if ( $buffer === null ) {
858  $buffer = $output->output( true );
859  }
860 
861  return $buffer;
862  };
863 
864  // Now commit any transactions, so that unreported errors after
865  // output() don't roll back the whole DB transaction and so that
866  // we avoid having both success and error text in the response
867  $this->doPreOutputCommit( $outputWork );
868 
869  // Now send the actual output
870  print $outputWork();
871  }
872 
878  public function restInPeace( $mode = 'fast', $blocksHttpClient = true ) {
879  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
880  // Assure deferred updates are not in the main transaction
881  $lbFactory->commitMasterChanges( __METHOD__ );
882 
883  // Loosen DB query expectations since the HTTP client is unblocked
884  $trxProfiler = Profiler::instance()->getTransactionProfiler();
885  $trxProfiler->resetExpectations();
886  $trxProfiler->setExpectations(
887  $this->config->get( 'TrxProfilerLimits' )['PostSend'],
888  __METHOD__
889  );
890 
891  // Important: this must be the last deferred update added (T100085, T154425)
893 
894  // Do any deferred jobs; preferring to run them now if a client will not wait on them
895  DeferredUpdates::doUpdates( $blocksHttpClient ? 'enqueue' : 'run' );
896 
897  // Now that everything specific to this request is done,
898  // try to occasionally run jobs (if enabled) from the queues
899  if ( $mode === 'normal' ) {
900  $this->triggerJobs();
901  }
902 
903  // Log profiling data, e.g. in the database or UDP
905 
906  // Commit and close up!
907  $lbFactory->commitMasterChanges( __METHOD__ );
908  $lbFactory->shutdown( LBFactory::SHUTDOWN_NO_CHRONPROT );
909 
910  wfDebug( "Request ended normally\n" );
911  }
912 
918  public function triggerJobs() {
919  $jobRunRate = $this->config->get( 'JobRunRate' );
920  if ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
921  return; // recursion guard
922  } elseif ( $jobRunRate <= 0 || wfReadOnly() ) {
923  return;
924  }
925 
926  if ( $jobRunRate < 1 ) {
927  $max = mt_getrandmax();
928  if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
929  return; // the higher the job run rate, the less likely we return here
930  }
931  $n = 1;
932  } else {
933  $n = intval( $jobRunRate );
934  }
935 
936  $logger = LoggerFactory::getInstance( 'runJobs' );
937 
938  try {
939  if ( $this->config->get( 'RunJobsAsync' ) ) {
940  // Send an HTTP request to the job RPC entry point if possible
941  $invokedWithSuccess = $this->triggerAsyncJobs( $n, $logger );
942  if ( !$invokedWithSuccess ) {
943  // Fall back to blocking on running the job(s)
944  $logger->warning( "Jobs switched to blocking; Special:RunJobs disabled" );
945  $this->triggerSyncJobs( $n, $logger );
946  }
947  } else {
948  $this->triggerSyncJobs( $n, $logger );
949  }
950  } catch ( JobQueueError $e ) {
951  // Do not make the site unavailable (T88312)
953  }
954  }
955 
960  private function triggerSyncJobs( $n, LoggerInterface $runJobsLogger ) {
961  $runner = new JobRunner( $runJobsLogger );
962  $runner->run( [ 'maxJobs' => $n ] );
963  }
964 
970  private function triggerAsyncJobs( $n, LoggerInterface $runJobsLogger ) {
971  // Do not send request if there are probably no jobs
972  $group = JobQueueGroup::singleton();
973  if ( !$group->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
974  return true;
975  }
976 
977  $query = [ 'title' => 'Special:RunJobs',
978  'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 ];
980  $query, $this->config->get( 'SecretKey' ) );
981 
982  $errno = $errstr = null;
983  $info = wfParseUrl( $this->config->get( 'CanonicalServer' ) );
984  $host = $info ? $info['host'] : null;
985  $port = 80;
986  if ( isset( $info['scheme'] ) && $info['scheme'] == 'https' ) {
987  $host = "tls://" . $host;
988  $port = 443;
989  }
990  if ( isset( $info['port'] ) ) {
991  $port = $info['port'];
992  }
993 
994  MediaWiki\suppressWarnings();
995  $sock = $host ? fsockopen(
996  $host,
997  $port,
998  $errno,
999  $errstr,
1000  // If it takes more than 100ms to connect to ourselves there is a problem...
1001  0.100
1002  ) : false;
1003  MediaWiki\restoreWarnings();
1004 
1005  $invokedWithSuccess = true;
1006  if ( $sock ) {
1007  $special = SpecialPageFactory::getPage( 'RunJobs' );
1008  $url = $special->getPageTitle()->getCanonicalURL( $query );
1009  $req = (
1010  "POST $url HTTP/1.1\r\n" .
1011  "Host: {$info['host']}\r\n" .
1012  "Connection: Close\r\n" .
1013  "Content-Length: 0\r\n\r\n"
1014  );
1015 
1016  $runJobsLogger->info( "Running $n job(s) via '$url'" );
1017  // Send a cron API request to be performed in the background.
1018  // Give up if this takes too long to send (which should be rare).
1019  stream_set_timeout( $sock, 2 );
1020  $bytes = fwrite( $sock, $req );
1021  if ( $bytes !== strlen( $req ) ) {
1022  $invokedWithSuccess = false;
1023  $runJobsLogger->error( "Failed to start cron API (socket write error)" );
1024  } else {
1025  // Do not wait for the response (the script should handle client aborts).
1026  // Make sure that we don't close before that script reaches ignore_user_abort().
1027  $start = microtime( true );
1028  $status = fgets( $sock );
1029  $sec = microtime( true ) - $start;
1030  if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
1031  $invokedWithSuccess = false;
1032  $runJobsLogger->error( "Failed to start cron API: received '$status' ($sec)" );
1033  }
1034  }
1035  fclose( $sock );
1036  } else {
1037  $invokedWithSuccess = false;
1038  $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
1039  }
1040 
1041  return $invokedWithSuccess;
1042  }
1043 }
Action\getActionName
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
DerivativeRequest
Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base reque...
Definition: DerivativeRequest.php:34
HTMLFileCache\useFileCache
static useFileCache(IContextSource $context, $mode=self::MODE_NORMAL)
Check if pages can be cached for this request/user.
Definition: HTMLFileCache.php:93
MediaWiki\setDBProfilingAgent
setDBProfilingAgent()
Definition: MediaWiki.php:556
$user
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 account $user
Definition: hooks.txt:244
Page
Interface for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
Definition: Page.php:24
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:268
MediaWiki\$action
String $action
Cache what action this request is.
Definition: MediaWiki.php:47
Revision\newFromId
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:116
PROTO_INTERNAL
const PROTO_INTERNAL
Definition: Defines.php:225
Profiler\instance
static instance()
Singleton.
Definition: Profiler.php:62
HTMLFileCache
Page view caching in the file system.
Definition: HTMLFileCache.php:33
captcha-old.count
count
Definition: captcha-old.py:249
MediaWiki\run
run()
Run the current MediaWiki instance; index.php just calls this.
Definition: MediaWiki.php:519
JobQueueGroup\TYPE_DEFAULT
const TYPE_DEFAULT
Definition: JobQueueGroup.php:49
HTMLFileCache\MODE_OUTAGE
const MODE_OUTAGE
Definition: HTMLFileCache.php:35
Title\newMainPage
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:581
MediaWiki\getTitle
getTitle()
Get the Title object that we'll be acting on, as specified in the WebRequest.
Definition: MediaWiki.php:137
WikiMap\getWikiFromUrl
static getWikiFromUrl( $url)
Definition: WikiMap.php:222
$status
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. '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). '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:1245
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
MediaWiki\main
main()
Definition: MediaWiki.php:744
$req
this hook is for auditing only $req
Definition: hooks.txt:988
NS_FILE
const NS_FILE
Definition: Defines.php:71
SpecialRunJobs\getQuerySignature
static getQuerySignature(array $query, $secretKey)
Definition: SpecialRunJobs.php:118
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1324
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
MediaWiki\restInPeace
restInPeace( $mode='fast', $blocksHttpClient=true)
Ends this task peacefully.
Definition: MediaWiki.php:878
ContentHandler\getForTitle
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
Definition: ContentHandler.php:240
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
$wgTitle
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') if(! $wgEnableAPI) $wgTitle
Definition: api.php:68
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
RedirectSpecialPage
Shortcut to construct a special page alias.
Definition: RedirectSpecialPage.php:29
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2198
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1140
HttpError
Show an error that looks like an HTTP server error.
Definition: HttpError.php:30
php
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
Action
Actions are things which can be done to pages (edit, delete, rollback, etc).
Definition: Action.php:37
NS_MAIN
const NS_MAIN
Definition: Defines.php:65
$query
null for the 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:1581
Title\getCdnUrls
getCdnUrls()
Get a list of URLs to purge from the CDN cache when this page changes.
Definition: Title.php:3718
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:54
DeferredUpdates\addCallableUpdate
static addCallableUpdate( $callable, $stage=self::POSTSEND, IDatabase $dbw=null)
Add a callable update.
Definition: DeferredUpdates.php:111
register_postsend_function
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
wfParseUrl
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Definition: GlobalFunctions.php:866
Article\newFromWikiPage
static newFromWikiPage(WikiPage $page, IContextSource $context)
Create an Article object of the appropriate class for the given page.
Definition: Article.php:145
MWException
MediaWiki exception.
Definition: MWException.php:26
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:932
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:121
MediaWiki\performAction
performAction(Page $page, Title $requestTitle)
Perform one of the "standard" actions.
Definition: MediaWiki.php:464
Config\get
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
MWExceptionHandler\handleException
static handleException( $e)
Exception handler which simulates the appropriate catch() handling:
Definition: MWExceptionHandler.php:128
$article
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:77
MediaWiki\parseTitle
parseTitle()
Parse the request to get the Title object.
Definition: MediaWiki.php:67
MWExceptionHandler\rollbackMasterChangesAndLog
static rollbackMasterChangesAndLog( $e)
Roll back any open database transactions and log the stack trace of the exception.
Definition: MWExceptionHandler.php:93
MediaWiki
A helper class for throttling authentication attempts.
PROTO_CURRENT
const PROTO_CURRENT
Definition: Defines.php:223
MediaWiki\triggerSyncJobs
triggerSyncJobs( $n, LoggerInterface $runJobsLogger)
Definition: MediaWiki.php:960
MediaWiki\doPreOutputCommit
doPreOutputCommit(callable $postCommitWork=null)
Definition: MediaWiki.php:570
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:529
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
JobQueueError
Definition: JobQueue.php:723
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:1047
MediaWiki\triggerAsyncJobs
triggerAsyncJobs( $n, LoggerInterface $runJobsLogger)
Definition: MediaWiki.php:970
ErrorPageError\report
report()
Output a report about the exception and takes care of formatting.
Definition: ErrorPageError.php:63
list
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
PROTO_HTTPS
const PROTO_HTTPS
Definition: Defines.php:221
MessageCache\singleton
static singleton()
Get the signleton instance of this class.
Definition: MessageCache.php:113
$services
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title 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:2198
captcha-old.action
action
Definition: captcha-old.py:212
Title\newFromTextThrow
static newFromTextThrow( $text, $defaultNamespace=NS_MAIN)
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,...
Definition: Title.php:301
$request
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:2581
MediaWiki\triggerJobs
triggerJobs()
Potentially open a socket and sent an HTTP request back to the server to run a specified number of jo...
Definition: MediaWiki.php:918
MediaWiki\MediaWikiServices\getInstance
static getInstance()
Returns the global default instance of the top level service locator.
Definition: MediaWikiServices.php:99
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2807
AjaxDispatcher
Object-Oriented Ajax functions.
Definition: AjaxDispatcher.php:34
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2141
MediaWiki\preOutputCommit
static preOutputCommit(IContextSource $context, callable $postCommitWork=null)
This function commits all DB changes as needed before the user can receive a response (in case commit...
Definition: MediaWiki.php:582
NS_MEDIA
const NS_MEDIA
Definition: Defines.php:53
MediaWiki\tryNormaliseRedirect
tryNormaliseRedirect(Title $title)
Handle redirects for uncanonical title requests.
Definition: MediaWiki.php:326
MediaWiki\__construct
__construct(IContextSource $context=null)
Definition: MediaWiki.php:52
Title\newFromURL
static newFromURL( $url)
THIS IS NOT THE FUNCTION YOU WANT.
Definition: Title.php:348
SpecialPageFactory\resolveAlias
static resolveAlias( $alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
Definition: SpecialPageFactory.php:338
$ret
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:1965
$special
this hook is for auditing only RecentChangesLinked and Watchlist $special
Definition: hooks.txt:988
RequestContext\getMain
static getMain()
Static methods.
Definition: RequestContext.php:470
IContextSource\getTitle
getTitle()
Get the Title object.
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:55
DeferredUpdates\doUpdates
static doUpdates( $mode='run', $stage=self::ALL)
Do any deferred updates and clear the list.
Definition: DeferredUpdates.php:123
MediaWiki\performRequest
performRequest()
Performs the request.
Definition: MediaWiki.php:173
MediaWiki\getAction
getAction()
Returns the name of the action that will be executed.
Definition: MediaWiki.php:153
Title
Represents a title within MediaWiki.
Definition: Title.php:39
MediaWiki\initializeArticle
initializeArticle()
Initialize the main Article object for "standard" actions (view, etc) Create an Article object for th...
Definition: MediaWiki.php:381
$cache
$cache
Definition: mcc.php:33
MalformedTitleException
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
Definition: MalformedTitleException.php:25
$options
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:1965
Wikimedia\Rdbms\ILBFactory\SHUTDOWN_NO_CHRONPROT
const SHUTDOWN_NO_CHRONPROT
Definition: ILBFactory.php:34
DeferredUpdates\PRESEND
const PRESEND
Definition: DeferredUpdates.php:60
Wikimedia\Rdbms\ChronologyProtector
Class for ensuring a consistent ordering of events as seen by the user, despite replication.
Definition: ChronologyProtector.php:36
IContextSource\getConfig
getConfig()
Get the site configuration.
Wikimedia\Rdbms\LBFactory
An interface for generating database load balancers.
Definition: LBFactory.php:38
JobQueueGroup\singleton
static singleton( $wiki=false)
Definition: JobQueueGroup.php:72
$rev
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:1750
MediaWiki\$config
Config $config
Definition: MediaWiki.php:42
Wikimedia\Rdbms\DBConnectionError
Definition: DBConnectionError.php:26
MWExceptionRenderer\getHTML
static getHTML( $e)
If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error,...
Definition: MWExceptionRenderer.php:162
SpecialPageFactory\executePath
static executePath(Title &$title, IContextSource &$context, $including=false, LinkRenderer $linkRenderer=null)
Execute a special page path.
Definition: SpecialPageFactory.php:511
LoggerFactory
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
MediaWiki\doPostOutputShutdown
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:702
IContextSource\getRequest
getRequest()
Get the WebRequest object.
WikiFilePage
Special handling for file pages.
Definition: WikiFilePage.php:30
wfWarn
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Definition: GlobalFunctions.php:1190
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
SpecialPageFactory\getPage
static getPage( $name)
Find the object with a given name and return it (or NULL)
Definition: SpecialPageFactory.php:379
MediaWikiServices
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
MediaWiki\$context
IContextSource $context
Definition: MediaWiki.php:37
JobRunner
Job queue runner utility methods.
Definition: JobRunner.php:40
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
MediaWiki\getUrlDomainDistance
static getUrlDomainDistance( $url)
Definition: MediaWiki.php:681
Title\newFromID
static newFromID( $id, $flags=0)
Create a new Title from an article ID.
Definition: Title.php:411
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
IContextSource\getOutput
getOutput()
Get the OutputPage object.
Action\factory
static factory( $action, Page $page, IContextSource $context=null)
Get an appropriate Action subclass for the given action.
Definition: Action.php:95
BadTitleError
Show an error page on a badtitle.
Definition: BadTitleError.php:30
$flags
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2801
$buffer
$buffer
Definition: mwdoc-filter.php:49
wfExpandUrl
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:586
wfLogProfilingData
wfLogProfilingData()
Definition: GlobalFunctions.php:1230
MWExceptionHandler\logException
static logException( $e, $catcher=self::CAUGHT_BY_OTHER)
Log an exception to the exception log (if enabled).
Definition: MWExceptionHandler.php:613
$wgContLang
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 content language as $wgContLang
Definition: design.txt:56