includes/MediaWiki.php

   1 <?php
   2 /**
   3  * Helper class for the index.php entry point.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 use MediaWiki\Logger\LoggerFactory;
  24 use Psr\Log\LoggerInterface;
  25 use MediaWiki\MediaWikiServices;
  26 use Wikimedia\Rdbms\ChronologyProtector;
  27 use Wikimedia\Rdbms\LBFactory;
  28 use Wikimedia\Rdbms\DBConnectionError;
  29 use Liuggio\StatsdClient\Sender\SocketSender;
  30
  31 /**
  32  * The MediaWiki class is the helper class for the index.php entry point.
  33  */
  34 class MediaWiki {
  35         /**
  36          * @var IContextSource
  37          */
  38         private $context;
  39
  40         /**
  41          * @var Config
  42          */
  43         private $config;
  44
  45         /**
  46          * @var String Cache what action this request is
  47          */
  48         private $action;
  49
  50         /**
  51          * @param IContextSource|null $context
  52          */
  53         public function __construct( IContextSource $context = null ) {
  54                 if ( !$context ) {
  55                         $context = RequestContext::getMain();
  56                 }
  57
  58                 $this->context = $context;
  59                 $this->config = $context->getConfig();
  60         }
  61
  62         /**
  63          * Parse the request to get the Title object
  64          *
  65          * @throws MalformedTitleException If a title has been provided by the user, but is invalid.
  66          * @return Title Title object to be $wgTitle
  67          */
  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 {
  83                         $ret = Title::newFromURL( $title );
  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                 ) {
 120                         $ret = Title::newMainPage();
 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.
 126                         Title::newFromTextThrow( $title );
 127                         throw new MalformedTitleException( 'badtitletext', $title );
 128                 }
 129
 130                 return $ret;
 131         }
 132
 133         /**
 134          * Get the Title object that we'll be acting on, as specified in the WebRequest
 135          * @return Title
 136          */
 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
 148         /**
 149          * Returns the name of the action that will be executed.
 150          *
 151          * @return string Action
 152          */
 153         public function getAction() {
 154                 if ( $this->action === null ) {
 155                         $this->action = Action::getActionName( $this->context );
 156                 }
 157
 158                 return $this->action;
 159         }
 160
 161         /**
 162          * Performs the request.
 163          * - bad titles
 164          * - read restriction
 165          * - local interwiki redirects
 166          * - redirect loop
 167          * - special pages
 168          * - normal pages
 169          *
 170          * @throws MWException|PermissionsError|BadTitleError|HttpError
 171          * @return void
 172          */
 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
 305         /**
 306          * Handle redirects for uncanonical title requests.
 307          *
 308          * Handles:
 309          * - Redirect loops.
 310          * - No title in URL.
 311          * - $wgUsePathInfo URLs.
 312          * - URLs with a variant.
 313          * - Other non-standard URLs (as long as they have no extra query parameters).
 314          *
 315          * Behaviour:
 316          * - Normalise title values:
 317          *   /wiki/Foo%20Bar -> /wiki/Foo_Bar
 318          * - Normalise empty title:
 319          *   /wiki/ -> /wiki/Main
 320          *   /w/index.php?title= -> /wiki/Main
 321          * - Don't redirect anything with query parameters other than 'title' or 'action=view'.
 322          *
 323          * @param Title $title
 324          * @return bool True if a redirect was set.
 325          * @throws HttpError
 326          */
 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
 377         /**
 378          * Initialize the main Article object for "standard" actions (view, etc)
 379          * Create an Article object for the page, following redirects if needed.
 380          *
 381          * @return Article|string An Article, or a string to redirect to another URL
 382          */
 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
 460         /**
 461          * Perform one of the "standard" actions
 462          *
 463          * @param Page $page
 464          * @param Title $requestTitle The original title, before any redirects were applied
 465          */
 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                 // NOTE: deprecated hook. Add to $wgActions instead
 505                 if ( Hooks::run(
 506                         'UnknownAction',
 507                         [
 508                                 $request->getVal( 'action', 'view' ),
 509                                 $page
 510                         ],
 511                         '1.19'
 512                 ) ) {
 513                         $output->setStatusCode( 404 );
 514                         $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
 515                 }
 516         }
 517
 518         /**
 519          * Run the current MediaWiki instance; index.php just calls this
 520          */
 521         public function run() {
 522                 try {
 523                         $this->setDBProfilingAgent();
 524                         try {
 525                                 $this->main();
 526                         } catch ( ErrorPageError $e ) {
 527                                 // T64091: while exceptions are convenient to bubble up GUI errors,
 528                                 // they are not internal application faults. As with normal requests, this
 529                                 // should commit, print the output, do deferred updates, jobs, and profiling.
 530                                 $this->doPreOutputCommit();
 531                                 $e->report(); // display the GUI error
 532                         }
 533                 } catch ( Exception $e ) {
 534                         $context = $this->context;
 535                         $action = $context->getRequest()->getVal( 'action', 'view' );
 536                         if (
 537                                 $e instanceof DBConnectionError &&
 538                                 $context->hasTitle() &&
 539                                 $context->getTitle()->canExist() &&
 540                                 in_array( $action, [ 'view', 'history' ], true ) &&
 541                                 HTMLFileCache::useFileCache( $this->context, HTMLFileCache::MODE_OUTAGE )
 542                         ) {
 543                                 // Try to use any (even stale) file during outages...
 544                                 $cache = new HTMLFileCache( $context->getTitle(), $action );
 545                                 if ( $cache->isCached() ) {
 546                                         $cache->loadFromFileCache( $context, HTMLFileCache::MODE_OUTAGE );
 547                                         print MWExceptionRenderer::getHTML( $e );
 548                                         exit;
 549                                 }
 550                         }
 551
 552                         MWExceptionHandler::handleException( $e );
 553                 } catch ( Error $e ) {
 554                         // Type errors and such: at least handle it now and clean up the LBFactory state
 555                         MWExceptionHandler::handleException( $e );
 556                 }
 557
 558                 $this->doPostOutputShutdown( 'normal' );
 559         }
 560
 561         private function setDBProfilingAgent() {
 562                 $services = MediaWikiServices::getInstance();
 563                 // Add a comment for easy SHOW PROCESSLIST interpretation
 564                 $name = $this->context->getUser()->getName();
 565                 $services->getDBLoadBalancerFactory()->setAgentName(
 566                         mb_strlen( $name ) > 15 ? mb_substr( $name, 0, 15 ) . '...' : $name
 567                 );
 568         }
 569
 570         /**
 571          * @see MediaWiki::preOutputCommit()
 572          * @param callable|null $postCommitWork [default: null]
 573          * @since 1.26
 574          */
 575         public function doPreOutputCommit( callable $postCommitWork = null ) {
 576                 self::preOutputCommit( $this->context, $postCommitWork );
 577         }
 578
 579         /**
 580          * This function commits all DB changes as needed before
 581          * the user can receive a response (in case commit fails)
 582          *
 583          * @param IContextSource $context
 584          * @param callable|null $postCommitWork [default: null]
 585          * @since 1.27
 586          */
 587         public static function preOutputCommit(
 588                 IContextSource $context, callable $postCommitWork = null
 589         ) {
 590                 // Either all DBs should commit or none
 591                 ignore_user_abort( true );
 592
 593                 $config = $context->getConfig();
 594                 $request = $context->getRequest();
 595                 $output = $context->getOutput();
 596                 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 597
 598                 // Commit all changes
 599                 $lbFactory->commitMasterChanges(
 600                         __METHOD__,
 601                         // Abort if any transaction was too big
 602                         [ 'maxWriteDuration' => $config->get( 'MaxUserDBWriteDuration' ) ]
 603                 );
 604                 wfDebug( __METHOD__ . ': primary transaction round committed' );
 605
 606                 // Run updates that need to block the user or affect output (this is the last chance)
 607                 DeferredUpdates::doUpdates( 'enqueue', DeferredUpdates::PRESEND );
 608                 wfDebug( __METHOD__ . ': pre-send deferred updates completed' );
 609
 610                 // Should the client return, their request should observe the new ChronologyProtector
 611                 // DB positions. This request might be on a foreign wiki domain, so synchronously update
 612                 // the DB positions in all datacenters to be safe. If this output is not a redirect,
 613                 // then OutputPage::output() will be relatively slow, meaning that running it in
 614                 // $postCommitWork should help mask the latency of those updates.
 615                 $flags = $lbFactory::SHUTDOWN_CHRONPROT_SYNC;
 616                 $strategy = 'cookie+sync';
 617
 618                 $allowHeaders = !( $output->isDisabled() || headers_sent() );
 619                 if ( $output->getRedirect() && $lbFactory->hasOrMadeRecentMasterChanges( INF ) ) {
 620                         // OutputPage::output() will be fast, so $postCommitWork is useless for masking
 621                         // the latency of synchronously updating the DB positions in all datacenters.
 622                         // Try to make use of the time the client spends following redirects instead.
 623                         $domainDistance = self::getUrlDomainDistance( $output->getRedirect() );
 624                         if ( $domainDistance === 'local' && $allowHeaders ) {
 625                                 $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
 626                                 $strategy = 'cookie'; // use same-domain cookie and keep the URL uncluttered
 627                         } elseif ( $domainDistance === 'remote' ) {
 628                                 $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
 629                                 $strategy = 'cookie+url'; // cross-domain cookie might not work
 630                         }
 631                 }
 632
 633                 // Record ChronologyProtector positions for DBs affected in this request at this point
 634                 $cpIndex = null;
 635                 $cpClientId = null;
 636                 $lbFactory->shutdown( $flags, $postCommitWork, $cpIndex, $cpClientId );
 637                 wfDebug( __METHOD__ . ': LBFactory shutdown completed' );
 638
 639                 if ( $cpIndex > 0 ) {
 640                         if ( $allowHeaders ) {
 641                                 $now = time();
 642                                 $expires = $now + ChronologyProtector::POSITION_COOKIE_TTL;
 643                                 $options = [ 'prefix' => '' ];
 644                                 $value = LBFactory::makeCookieValueFromCPIndex( $cpIndex, $now, $cpClientId );
 645                                 $request->response()->setCookie( 'cpPosIndex', $value, $expires, $options );
 646                         }
 647
 648                         if ( $strategy === 'cookie+url' ) {
 649                                 if ( $output->getRedirect() ) { // sanity
 650                                         $safeUrl = $lbFactory->appendShutdownCPIndexAsQuery(
 651                                                 $output->getRedirect(),
 652                                                 $cpIndex
 653                                         );
 654                                         $output->redirect( $safeUrl );
 655                                 } else {
 656                                         $e = new LogicException( "No redirect; cannot append cpPosIndex parameter." );
 657                                         MWExceptionHandler::logException( $e );
 658                                 }
 659                         }
 660                 }
 661
 662                 // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
 663                 // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
 664                 // ChronologyProtector works for cacheable URLs.
 665                 if ( $request->wasPosted() && $lbFactory->hasOrMadeRecentMasterChanges() ) {
 666                         $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
 667                         $options = [ 'prefix' => '' ];
 668                         $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
 669                         $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
 670                 }
 671
 672                 // Avoid letting a few seconds of replica DB lag cause a month of stale data. This logic is
 673                 // also intimately related to the value of $wgCdnReboundPurgeDelay.
 674                 if ( $lbFactory->laggedReplicaUsed() ) {
 675                         $maxAge = $config->get( 'CdnMaxageLagged' );
 676                         $output->lowerCdnMaxage( $maxAge );
 677                         $request->response()->header( "X-Database-Lagged: true" );
 678                         wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
 679                 }
 680
 681                 // Avoid long-term cache pollution due to message cache rebuild timeouts (T133069)
 682                 if ( MessageCache::singleton()->isDisabled() ) {
 683                         $maxAge = $config->get( 'CdnMaxageSubstitute' );
 684                         $output->lowerCdnMaxage( $maxAge );
 685                         $request->response()->header( "X-Response-Substitute: true" );
 686                 }
 687         }
 688
 689         /**
 690          * @param string $url
 691          * @return string Either "local", "remote" if in the farm, "external" otherwise
 692          */
 693         private static function getUrlDomainDistance( $url ) {
 694                 $clusterWiki = WikiMap::getWikiFromUrl( $url );
 695                 if ( $clusterWiki === wfWikiID() ) {
 696                         return 'local'; // the current wiki
 697                 } elseif ( $clusterWiki !== false ) {
 698                         return 'remote'; // another wiki in this cluster/farm
 699                 }
 700
 701                 return 'external';
 702         }
 703
 704         /**
 705          * This function does work that can be done *after* the
 706          * user gets the HTTP response so they don't block on it
 707          *
 708          * This manages deferred updates, job insertion,
 709          * final commit, and the logging of profiling data
 710          *
 711          * @param string $mode Use 'fast' to always skip job running
 712          * @since 1.26
 713          */
 714         public function doPostOutputShutdown( $mode = 'normal' ) {
 715                 // Perform the last synchronous operations...
 716                 try {
 717                         // Record backend request timing
 718                         $timing = $this->context->getTiming();
 719                         $timing->mark( 'requestShutdown' );
 720                         // Show visible profiling data if enabled (which cannot be post-send)
 721                         Profiler::instance()->logDataPageOutputOnly();
 722                 } catch ( Exception $e ) {
 723                         // An error may already have been shown in run(), so just log it to be safe
 724                         MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 725                 }
 726
 727                 // Disable WebResponse setters for post-send processing (T191537).
 728                 WebResponse::disableForPostSend();
 729
 730                 $blocksHttpClient = true;
 731                 // Defer everything else if possible...
 732                 $callback = function () use ( $mode, &$blocksHttpClient ) {
 733                         try {
 734                                 $this->restInPeace( $mode, $blocksHttpClient );
 735                         } catch ( Exception $e ) {
 736                                 // If this is post-send, then displaying errors can cause broken HTML
 737                                 MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 738                         }
 739                 };
 740
 741                 if ( function_exists( 'register_postsend_function' ) ) {
 742                         // https://github.com/facebook/hhvm/issues/1230
 743                         register_postsend_function( $callback );
 744                         /** @noinspection PhpUnusedLocalVariableInspection */
 745                         $blocksHttpClient = false;
 746                 } else {
 747                         if ( function_exists( 'fastcgi_finish_request' ) ) {
 748                                 fastcgi_finish_request();
 749                                 /** @noinspection PhpUnusedLocalVariableInspection */
 750                                 $blocksHttpClient = false;
 751                         } else {
 752                                 // Either all DB and deferred updates should happen or none.
 753                                 // The latter should not be cancelled due to client disconnect.
 754                                 ignore_user_abort( true );
 755                         }
 756
 757                         $callback();
 758                 }
 759         }
 760
 761         private function main() {
 762                 global $wgTitle;
 763
 764                 $output = $this->context->getOutput();
 765                 $request = $this->context->getRequest();
 766
 767                 // Send Ajax requests to the Ajax dispatcher.
 768                 if ( $request->getVal( 'action' ) === 'ajax' ) {
 769                         // Set a dummy title, because $wgTitle == null might break things
 770                         $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
 771                                 . __METHOD__
 772                         );
 773                         $this->context->setTitle( $title );
 774                         $wgTitle = $title;
 775
 776                         $dispatcher = new AjaxDispatcher( $this->config );
 777                         $dispatcher->performAction( $this->context->getUser() );
 778
 779                         return;
 780                 }
 781
 782                 // Get title from request parameters,
 783                 // is set on the fly by parseTitle the first time.
 784                 $title = $this->getTitle();
 785                 $action = $this->getAction();
 786                 $wgTitle = $title;
 787
 788                 // Set DB query expectations for this HTTP request
 789                 $trxLimits = $this->config->get( 'TrxProfilerLimits' );
 790                 $trxProfiler = Profiler::instance()->getTransactionProfiler();
 791                 $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
 792                 if ( $request->hasSafeMethod() ) {
 793                         $trxProfiler->setExpectations( $trxLimits['GET'], __METHOD__ );
 794                 } else {
 795                         $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__ );
 796                 }
 797
 798                 // If the user has forceHTTPS set to true, or if the user
 799                 // is in a group requiring HTTPS, or if they have the HTTPS
 800                 // preference set, redirect them to HTTPS.
 801                 // Note: Do this after $wgTitle is setup, otherwise the hooks run from
 802                 // isLoggedIn() will do all sorts of weird stuff.
 803                 if (
 804                         $request->getProtocol() == 'http' &&
 805                         // switch to HTTPS only when supported by the server
 806                         preg_match( '#^https://#', wfExpandUrl( $request->getRequestURL(), PROTO_HTTPS ) ) &&
 807                         (
 808                                 $request->getSession()->shouldForceHTTPS() ||
 809                                 // Check the cookie manually, for paranoia
 810                                 $request->getCookie( 'forceHTTPS', '' ) ||
 811                                 // check for prefixed version that was used for a time in older MW versions
 812                                 $request->getCookie( 'forceHTTPS' ) ||
 813                                 // Avoid checking the user and groups unless it's enabled.
 814                                 (
 815                                         $this->context->getUser()->isLoggedIn()
 816                                         && $this->context->getUser()->requiresHTTPS()
 817                                 )
 818                         )
 819                 ) {
 820                         $oldUrl = $request->getFullRequestURL();
 821                         $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
 822
 823                         // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
 824                         if ( Hooks::run( 'BeforeHttpsRedirect', [ $this->context, &$redirUrl ] ) ) {
 825                                 if ( $request->wasPosted() ) {
 826                                         // This is weird and we'd hope it almost never happens. This
 827                                         // means that a POST came in via HTTP and policy requires us
 828                                         // redirecting to HTTPS. It's likely such a request is going
 829                                         // to fail due to post data being lost, but let's try anyway
 830                                         // and just log the instance.
 831
 832                                         // @todo FIXME: See if we could issue a 307 or 308 here, need
 833                                         // to see how clients (automated & browser) behave when we do
 834                                         wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
 835                                 }
 836                                 // Setup dummy Title, otherwise OutputPage::redirect will fail
 837                                 $title = Title::newFromText( 'REDIR', NS_MAIN );
 838                                 $this->context->setTitle( $title );
 839                                 // Since we only do this redir to change proto, always send a vary header
 840                                 $output->addVaryHeader( 'X-Forwarded-Proto' );
 841                                 $output->redirect( $redirUrl );
 842                                 $output->output();
 843
 844                                 return;
 845                         }
 846                 }
 847
 848                 if ( $title->canExist() && HTMLFileCache::useFileCache( $this->context ) ) {
 849                         // Try low-level file cache hit
 850                         $cache = new HTMLFileCache( $title, $action );
 851                         if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
 852                                 // Check incoming headers to see if client has this cached
 853                                 $timestamp = $cache->cacheTimestamp();
 854                                 if ( !$output->checkLastModified( $timestamp ) ) {
 855                                         $cache->loadFromFileCache( $this->context );
 856                                 }
 857                                 // Do any stats increment/watchlist stuff, assuming user is viewing the
 858                                 // latest revision (which should always be the case for file cache)
 859                                 $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
 860                                 // Tell OutputPage that output is taken care of
 861                                 $output->disable();
 862
 863                                 return;
 864                         }
 865                 }
 866
 867                 // Actually do the work of the request and build up any output
 868                 $this->performRequest();
 869
 870                 // GUI-ify and stash the page output in MediaWiki::doPreOutputCommit() while
 871                 // ChronologyProtector synchronizes DB positions or replicas across all datacenters.
 872                 $buffer = null;
 873                 $outputWork = function () use ( $output, &$buffer ) {
 874                         if ( $buffer === null ) {
 875                                 $buffer = $output->output( true );
 876                         }
 877
 878                         return $buffer;
 879                 };
 880
 881                 // Now commit any transactions, so that unreported errors after
 882                 // output() don't roll back the whole DB transaction and so that
 883                 // we avoid having both success and error text in the response
 884                 $this->doPreOutputCommit( $outputWork );
 885
 886                 // Now send the actual output
 887                 print $outputWork();
 888         }
 889
 890         /**
 891          * Ends this task peacefully
 892          * @param string $mode Use 'fast' to always skip job running
 893          * @param bool $blocksHttpClient Whether this blocks an HTTP response to a client
 894          */
 895         public function restInPeace( $mode = 'fast', $blocksHttpClient = true ) {
 896                 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 897                 // Assure deferred updates are not in the main transaction
 898                 $lbFactory->commitMasterChanges( __METHOD__ );
 899
 900                 // Loosen DB query expectations since the HTTP client is unblocked
 901                 $trxProfiler = Profiler::instance()->getTransactionProfiler();
 902                 $trxProfiler->resetExpectations();
 903                 $trxProfiler->setExpectations(
 904                         $this->context->getRequest()->hasSafeMethod()
 905                                 ? $this->config->get( 'TrxProfilerLimits' )['PostSend-GET']
 906                                 : $this->config->get( 'TrxProfilerLimits' )['PostSend-POST'],
 907                         __METHOD__
 908                 );
 909
 910                 // Important: this must be the last deferred update added (T100085, T154425)
 911                 DeferredUpdates::addCallableUpdate( [ JobQueueGroup::class, 'pushLazyJobs' ] );
 912
 913                 // Do any deferred jobs; preferring to run them now if a client will not wait on them
 914                 DeferredUpdates::doUpdates( $blocksHttpClient ? 'enqueue' : 'run' );
 915
 916                 // Now that everything specific to this request is done,
 917                 // try to occasionally run jobs (if enabled) from the queues
 918                 if ( $mode === 'normal' ) {
 919                         $this->triggerJobs();
 920                 }
 921
 922                 // Log profiling data, e.g. in the database or UDP
 923                 wfLogProfilingData();
 924
 925                 // Commit and close up!
 926                 $lbFactory->commitMasterChanges( __METHOD__ );
 927                 $lbFactory->shutdown( LBFactory::SHUTDOWN_NO_CHRONPROT );
 928
 929                 wfDebug( "Request ended normally\n" );
 930         }
 931
 932         /**
 933          * Send out any buffered statsd data according to sampling rules
 934          *
 935          * @param IBufferingStatsdDataFactory $stats
 936          * @param Config $config
 937          * @throws ConfigException
 938          * @since 1.31
 939          */
 940         public static function emitBufferedStatsdData(
 941                 IBufferingStatsdDataFactory $stats, Config $config
 942         ) {
 943                 if ( $config->get( 'StatsdServer' ) && $stats->hasData() ) {
 944                         try {
 945                                 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
 946                                 $statsdHost = $statsdServer[0];
 947                                 $statsdPort = $statsdServer[1] ?? 8125;
 948                                 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
 949                                 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
 950                                 $statsdClient->setSamplingRates( $config->get( 'StatsdSamplingRates' ) );
 951                                 $statsdClient->send( $stats->getData() );
 952
 953                                 $stats->clearData(); // empty buffer for the next round
 954                         } catch ( Exception $ex ) {
 955                                 MWExceptionHandler::logException( $ex );
 956                         }
 957                 }
 958         }
 959
 960         /**
 961          * Potentially open a socket and sent an HTTP request back to the server
 962          * to run a specified number of jobs. This registers a callback to cleanup
 963          * the socket once it's done.
 964          */
 965         public function triggerJobs() {
 966                 $jobRunRate = $this->config->get( 'JobRunRate' );
 967                 if ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
 968                         return; // recursion guard
 969                 } elseif ( $jobRunRate <= 0 || wfReadOnly() ) {
 970                         return;
 971                 }
 972
 973                 if ( $jobRunRate < 1 ) {
 974                         $max = mt_getrandmax();
 975                         if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
 976                                 return; // the higher the job run rate, the less likely we return here
 977                         }
 978                         $n = 1;
 979                 } else {
 980                         $n = intval( $jobRunRate );
 981                 }
 982
 983                 $logger = LoggerFactory::getInstance( 'runJobs' );
 984
 985                 try {
 986                         if ( $this->config->get( 'RunJobsAsync' ) ) {
 987                                 // Send an HTTP request to the job RPC entry point if possible
 988                                 $invokedWithSuccess = $this->triggerAsyncJobs( $n, $logger );
 989                                 if ( !$invokedWithSuccess ) {
 990                                         // Fall back to blocking on running the job(s)
 991                                         $logger->warning( "Jobs switched to blocking; Special:RunJobs disabled" );
 992                                         $this->triggerSyncJobs( $n, $logger );
 993                                 }
 994                         } else {
 995                                 $this->triggerSyncJobs( $n, $logger );
 996                         }
 997                 } catch ( JobQueueError $e ) {
 998                         // Do not make the site unavailable (T88312)
 999                         MWExceptionHandler::logException( $e );
1000                 }
1001         }
1002
1003         /**
1004          * @param int $n Number of jobs to try to run
1005          * @param LoggerInterface $runJobsLogger
1006          */
1007         private function triggerSyncJobs( $n, LoggerInterface $runJobsLogger ) {
1008                 $trxProfiler = Profiler::instance()->getTransactionProfiler();
1009                 $old = $trxProfiler->setSilenced( true );
1010                 try {
1011                         $runner = new JobRunner( $runJobsLogger );
1012                         $runner->run( [ 'maxJobs' => $n ] );
1013                 } finally {
1014                         $trxProfiler->setSilenced( $old );
1015                 }
1016         }
1017
1018         /**
1019          * @param int $n Number of jobs to try to run
1020          * @param LoggerInterface $runJobsLogger
1021          * @return bool Success
1022          */
1023         private function triggerAsyncJobs( $n, LoggerInterface $runJobsLogger ) {
1024                 // Do not send request if there are probably no jobs
1025                 $group = JobQueueGroup::singleton();
1026                 if ( !$group->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
1027                         return true;
1028                 }
1029
1030                 $query = [ 'title' => 'Special:RunJobs',
1031                         'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 ];
1032                 $query['signature'] = SpecialRunJobs::getQuerySignature(
1033                         $query, $this->config->get( 'SecretKey' ) );
1034
1035                 $errno = $errstr = null;
1036                 $info = wfParseUrl( $this->config->get( 'CanonicalServer' ) );
1037                 $host = $info ? $info['host'] : null;
1038                 $port = 80;
1039                 if ( isset( $info['scheme'] ) && $info['scheme'] == 'https' ) {
1040                         $host = "tls://" . $host;
1041                         $port = 443;
1042                 }
1043                 if ( isset( $info['port'] ) ) {
1044                         $port = $info['port'];
1045                 }
1046
1047                 Wikimedia\suppressWarnings();
1048                 $sock = $host ? fsockopen(
1049                         $host,
1050                         $port,
1051                         $errno,
1052                         $errstr,
1053                         // If it takes more than 100ms to connect to ourselves there is a problem...
1054                         0.100
1055                 ) : false;
1056                 Wikimedia\restoreWarnings();
1057
1058                 $invokedWithSuccess = true;
1059                 if ( $sock ) {
1060                         $special = MediaWikiServices::getInstance()->getSpecialPageFactory()->
1061                                 getPage( 'RunJobs' );
1062                         $url = $special->getPageTitle()->getCanonicalURL( $query );
1063                         $req = (
1064                                 "POST $url HTTP/1.1\r\n" .
1065                                 "Host: {$info['host']}\r\n" .
1066                                 "Connection: Close\r\n" .
1067                                 "Content-Length: 0\r\n\r\n"
1068                         );
1069
1070                         $runJobsLogger->info( "Running $n job(s) via '$url'" );
1071                         // Send a cron API request to be performed in the background.
1072                         // Give up if this takes too long to send (which should be rare).
1073                         stream_set_timeout( $sock, 2 );
1074                         $bytes = fwrite( $sock, $req );
1075                         if ( $bytes !== strlen( $req ) ) {
1076                                 $invokedWithSuccess = false;
1077                                 $runJobsLogger->error( "Failed to start cron API (socket write error)" );
1078                         } else {
1079                                 // Do not wait for the response (the script should handle client aborts).
1080                                 // Make sure that we don't close before that script reaches ignore_user_abort().
1081                                 $start = microtime( true );
1082                                 $status = fgets( $sock );
1083                                 $sec = microtime( true ) - $start;
1084                                 if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
1085                                         $invokedWithSuccess = false;
1086                                         $runJobsLogger->error( "Failed to start cron API: received '$status' ($sec)" );
1087                                 }
1088                         }
1089                         fclose( $sock );
1090                 } else {
1091                         $invokedWithSuccess = false;
1092                         $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
1093                 }
1094
1095                 return $invokedWithSuccess;
1096         }
1097 }