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                 global $wgContLang;
  70
  71                 $request = $this->context->getRequest();
  72                 $curid = $request->getInt( 'curid' );
  73                 $title = $request->getVal( 'title' );
  74                 $action = $request->getVal( 'action' );
  75
  76                 if ( $request->getCheck( 'search' ) ) {
  77                         // Compatibility with old search URLs which didn't use Special:Search
  78                         // Just check for presence here, so blank requests still
  79                         // show the search page when using ugly URLs (T10054).
  80                         $ret = SpecialPage::getTitleFor( 'Search' );
  81                 } elseif ( $curid ) {
  82                         // URLs like this are generated by RC, because rc_title isn't always accurate
  83                         $ret = Title::newFromID( $curid );
  84                 } else {
  85                         $ret = Title::newFromURL( $title );
  86                         // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
  87                         // in wikitext links to tell Parser to make a direct file link
  88                         if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA ) {
  89                                 $ret = Title::makeTitle( NS_FILE, $ret->getDBkey() );
  90                         }
  91                         // Check variant links so that interwiki links don't have to worry
  92                         // about the possible different language variants
  93                         if ( count( $wgContLang->getVariants() ) > 1
  94                                 && !is_null( $ret ) && $ret->getArticleID() == 0
  95                         ) {
  96                                 $wgContLang->findVariantLink( $title, $ret );
  97                         }
  98                 }
  99
 100                 // If title is not provided, always allow oldid and diff to set the title.
 101                 // If title is provided, allow oldid and diff to override the title, unless
 102                 // we are talking about a special page which might use these parameters for
 103                 // other purposes.
 104                 if ( $ret === null || !$ret->isSpecialPage() ) {
 105                         // We can have urls with just ?diff=,?oldid= or even just ?diff=
 106                         $oldid = $request->getInt( 'oldid' );
 107                         $oldid = $oldid ? $oldid : $request->getInt( 'diff' );
 108                         // Allow oldid to override a changed or missing title
 109                         if ( $oldid ) {
 110                                 $rev = Revision::newFromId( $oldid );
 111                                 $ret = $rev ? $rev->getTitle() : $ret;
 112                         }
 113                 }
 114
 115                 // Use the main page as default title if nothing else has been provided
 116                 if ( $ret === null
 117                         && strval( $title ) === ''
 118                         && !$request->getCheck( 'curid' )
 119                         && $action !== 'delete'
 120                 ) {
 121                         $ret = Title::newMainPage();
 122                 }
 123
 124                 if ( $ret === null || ( $ret->getDBkey() == '' && !$ret->isExternal() ) ) {
 125                         // If we get here, we definitely don't have a valid title; throw an exception.
 126                         // Try to get detailed invalid title exception first, fall back to MalformedTitleException.
 127                         Title::newFromTextThrow( $title );
 128                         throw new MalformedTitleException( 'badtitletext', $title );
 129                 }
 130
 131                 return $ret;
 132         }
 133
 134         /**
 135          * Get the Title object that we'll be acting on, as specified in the WebRequest
 136          * @return Title
 137          */
 138         public function getTitle() {
 139                 if ( !$this->context->hasTitle() ) {
 140                         try {
 141                                 $this->context->setTitle( $this->parseTitle() );
 142                         } catch ( MalformedTitleException $ex ) {
 143                                 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
 144                         }
 145                 }
 146                 return $this->context->getTitle();
 147         }
 148
 149         /**
 150          * Returns the name of the action that will be executed.
 151          *
 152          * @return string Action
 153          */
 154         public function getAction() {
 155                 if ( $this->action === null ) {
 156                         $this->action = Action::getActionName( $this->context );
 157                 }
 158
 159                 return $this->action;
 160         }
 161
 162         /**
 163          * Performs the request.
 164          * - bad titles
 165          * - read restriction
 166          * - local interwiki redirects
 167          * - redirect loop
 168          * - special pages
 169          * - normal pages
 170          *
 171          * @throws MWException|PermissionsError|BadTitleError|HttpError
 172          * @return void
 173          */
 174         private function performRequest() {
 175                 global $wgTitle;
 176
 177                 $request = $this->context->getRequest();
 178                 $requestTitle = $title = $this->context->getTitle();
 179                 $output = $this->context->getOutput();
 180                 $user = $this->context->getUser();
 181
 182                 if ( $request->getVal( 'printable' ) === 'yes' ) {
 183                         $output->setPrintable();
 184                 }
 185
 186                 $unused = null; // To pass it by reference
 187                 Hooks::run( 'BeforeInitialize', [ &$title, &$unused, &$output, &$user, $request, $this ] );
 188
 189                 // Invalid titles. T23776: The interwikis must redirect even if the page name is empty.
 190                 if ( is_null( $title ) || ( $title->getDBkey() == '' && !$title->isExternal() )
 191                         || $title->isSpecial( 'Badtitle' )
 192                 ) {
 193                         $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
 194                         try {
 195                                 $this->parseTitle();
 196                         } catch ( MalformedTitleException $ex ) {
 197                                 throw new BadTitleError( $ex );
 198                         }
 199                         throw new BadTitleError();
 200                 }
 201
 202                 // Check user's permissions to read this page.
 203                 // We have to check here to catch special pages etc.
 204                 // We will check again in Article::view().
 205                 $permErrors = $title->isSpecial( 'RunJobs' )
 206                         ? [] // relies on HMAC key signature alone
 207                         : $title->getUserPermissionsErrors( 'read', $user );
 208                 if ( count( $permErrors ) ) {
 209                         // T34276: allowing the skin to generate output with $wgTitle or
 210                         // $this->context->title set to the input title would allow anonymous users to
 211                         // determine whether a page exists, potentially leaking private data. In fact, the
 212                         // curid and oldid request  parameters would allow page titles to be enumerated even
 213                         // when they are not guessable. So we reset the title to Special:Badtitle before the
 214                         // permissions error is displayed.
 215
 216                         // The skin mostly uses $this->context->getTitle() these days, but some extensions
 217                         // still use $wgTitle.
 218                         $badTitle = SpecialPage::getTitleFor( 'Badtitle' );
 219                         $this->context->setTitle( $badTitle );
 220                         $wgTitle = $badTitle;
 221
 222                         throw new PermissionsError( 'read', $permErrors );
 223                 }
 224
 225                 // Interwiki redirects
 226                 if ( $title->isExternal() ) {
 227                         $rdfrom = $request->getVal( 'rdfrom' );
 228                         if ( $rdfrom ) {
 229                                 $url = $title->getFullURL( [ 'rdfrom' => $rdfrom ] );
 230                         } else {
 231                                 $query = $request->getValues();
 232                                 unset( $query['title'] );
 233                                 $url = $title->getFullURL( $query );
 234                         }
 235                         // Check for a redirect loop
 236                         if ( !preg_match( '/^' . preg_quote( $this->config->get( 'Server' ), '/' ) . '/', $url )
 237                                 && $title->isLocal()
 238                         ) {
 239                                 // 301 so google et al report the target as the actual url.
 240                                 $output->redirect( $url, 301 );
 241                         } else {
 242                                 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
 243                                 try {
 244                                         $this->parseTitle();
 245                                 } catch ( MalformedTitleException $ex ) {
 246                                         throw new BadTitleError( $ex );
 247                                 }
 248                                 throw new BadTitleError();
 249                         }
 250                 // Handle any other redirects.
 251                 // Redirect loops, titleless URL, $wgUsePathInfo URLs, and URLs with a variant
 252                 } elseif ( !$this->tryNormaliseRedirect( $title ) ) {
 253                         // Prevent information leak via Special:MyPage et al (T109724)
 254                         if ( $title->isSpecialPage() ) {
 255                                 $specialPage = SpecialPageFactory::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 ) = SpecialPageFactory::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                                 SpecialPageFactory::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 ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
 343                         if ( $name ) {
 344                                 $title = SpecialPage::getTitleFor( $name, $subpage );
 345                         }
 346                 }
 347                 // Redirect to canonical url, make it a 301 to allow caching
 348                 $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
 349                 if ( $targetUrl == $request->getFullRequestURL() ) {
 350                         $message = "Redirect loop detected!\n\n" .
 351                                 "This means the wiki got confused about what page was " .
 352                                 "requested; this sometimes happens when moving a wiki " .
 353                                 "to a new server or changing the server configuration.\n\n";
 354
 355                         if ( $this->config->get( 'UsePathInfo' ) ) {
 356                                 $message .= "The wiki is trying to interpret the page " .
 357                                         "title from the URL path portion (PATH_INFO), which " .
 358                                         "sometimes fails depending on the web server. Try " .
 359                                         "setting \"\$wgUsePathInfo = false;\" in your " .
 360                                         "LocalSettings.php, or check that \$wgArticlePath " .
 361                                         "is correct.";
 362                         } else {
 363                                 $message .= "Your web server was detected as possibly not " .
 364                                         "supporting URL path components (PATH_INFO) correctly; " .
 365                                         "check your LocalSettings.php for a customized " .
 366                                         "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
 367                                         "to true.";
 368                         }
 369                         throw new HttpError( 500, $message );
 370                 }
 371                 $output->setCdnMaxage( 1200 );
 372                 $output->redirect( $targetUrl, '301' );
 373                 return true;
 374         }
 375
 376         /**
 377          * Initialize the main Article object for "standard" actions (view, etc)
 378          * Create an Article object for the page, following redirects if needed.
 379          *
 380          * @return Article|string An Article, or a string to redirect to another URL
 381          */
 382         private function initializeArticle() {
 383                 $title = $this->context->getTitle();
 384                 if ( $this->context->canUseWikiPage() ) {
 385                         // Try to use request context wiki page, as there
 386                         // is already data from db saved in per process
 387                         // cache there from this->getAction() call.
 388                         $page = $this->context->getWikiPage();
 389                 } else {
 390                         // This case should not happen, but just in case.
 391                         // @TODO: remove this or use an exception
 392                         $page = WikiPage::factory( $title );
 393                         $this->context->setWikiPage( $page );
 394                         wfWarn( "RequestContext::canUseWikiPage() returned false" );
 395                 }
 396
 397                 // Make GUI wrapper for the WikiPage
 398                 $article = Article::newFromWikiPage( $page, $this->context );
 399
 400                 // Skip some unnecessary code if the content model doesn't support redirects
 401                 if ( !ContentHandler::getForTitle( $title )->supportsRedirects() ) {
 402                         return $article;
 403                 }
 404
 405                 $request = $this->context->getRequest();
 406
 407                 // Namespace might change when using redirects
 408                 // Check for redirects ...
 409                 $action = $request->getVal( 'action', 'view' );
 410                 $file = ( $page instanceof WikiFilePage ) ? $page->getFile() : null;
 411                 if ( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
 412                         && !$request->getVal( 'oldid' ) // ... and are not old revisions
 413                         && !$request->getVal( 'diff' ) // ... and not when showing diff
 414                         && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
 415                         // ... and the article is not a non-redirect image page with associated file
 416                         && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
 417                 ) {
 418                         // Give extensions a change to ignore/handle redirects as needed
 419                         $ignoreRedirect = $target = false;
 420
 421                         Hooks::run( 'InitializeArticleMaybeRedirect',
 422                                 [ &$title, &$request, &$ignoreRedirect, &$target, &$article ] );
 423                         $page = $article->getPage(); // reflect any hook changes
 424
 425                         // Follow redirects only for... redirects.
 426                         // If $target is set, then a hook wanted to redirect.
 427                         if ( !$ignoreRedirect && ( $target || $page->isRedirect() ) ) {
 428                                 // Is the target already set by an extension?
 429                                 $target = $target ? $target : $page->followRedirect();
 430                                 if ( is_string( $target ) ) {
 431                                         if ( !$this->config->get( 'DisableHardRedirects' ) ) {
 432                                                 // we'll need to redirect
 433                                                 return $target;
 434                                         }
 435                                 }
 436                                 if ( is_object( $target ) ) {
 437                                         // Rewrite environment to redirected article
 438                                         $rpage = WikiPage::factory( $target );
 439                                         $rpage->loadPageData();
 440                                         if ( $rpage->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
 441                                                 $rarticle = Article::newFromWikiPage( $rpage, $this->context );
 442                                                 $rarticle->setRedirectedFrom( $title );
 443
 444                                                 $article = $rarticle;
 445                                                 $this->context->setTitle( $target );
 446                                                 $this->context->setWikiPage( $article->getPage() );
 447                                         }
 448                                 }
 449                         } else {
 450                                 // Article may have been changed by hook
 451                                 $this->context->setTitle( $article->getTitle() );
 452                                 $this->context->setWikiPage( $article->getPage() );
 453                         }
 454                 }
 455
 456                 return $article;
 457         }
 458
 459         /**
 460          * Perform one of the "standard" actions
 461          *
 462          * @param Page $page
 463          * @param Title $requestTitle The original title, before any redirects were applied
 464          */
 465         private function performAction( Page $page, Title $requestTitle ) {
 466                 $request = $this->context->getRequest();
 467                 $output = $this->context->getOutput();
 468                 $title = $this->context->getTitle();
 469                 $user = $this->context->getUser();
 470
 471                 if ( !Hooks::run( 'MediaWikiPerformAction',
 472                                 [ $output, $page, $title, $user, $request, $this ] )
 473                 ) {
 474                         return;
 475                 }
 476
 477                 $act = $this->getAction();
 478                 $action = Action::factory( $act, $page, $this->context );
 479
 480                 if ( $action instanceof Action ) {
 481                         // Narrow DB query expectations for this HTTP request
 482                         $trxLimits = $this->config->get( 'TrxProfilerLimits' );
 483                         $trxProfiler = Profiler::instance()->getTransactionProfiler();
 484                         if ( $request->wasPosted() && !$action->doesWrites() ) {
 485                                 $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__ );
 486                                 $request->markAsSafeRequest();
 487                         }
 488
 489                         # Let CDN cache things if we can purge them.
 490                         if ( $this->config->get( 'UseSquid' ) &&
 491                                 in_array(
 492                                         // Use PROTO_INTERNAL because that's what getCdnUrls() uses
 493                                         wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL ),
 494                                         $requestTitle->getCdnUrls()
 495                                 )
 496                         ) {
 497                                 $output->setCdnMaxage( $this->config->get( 'SquidMaxage' ) );
 498                         }
 499
 500                         $action->show();
 501                         return;
 502                 }
 503                 // NOTE: deprecated hook. Add to $wgActions instead
 504                 if ( Hooks::run(
 505                         'UnknownAction',
 506                         [
 507                                 $request->getVal( 'action', 'view' ),
 508                                 $page
 509                         ],
 510                         '1.19'
 511                 ) ) {
 512                         $output->setStatusCode( 404 );
 513                         $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
 514                 }
 515         }
 516
 517         /**
 518          * Run the current MediaWiki instance; index.php just calls this
 519          */
 520         public function run() {
 521                 try {
 522                         $this->setDBProfilingAgent();
 523                         try {
 524                                 $this->main();
 525                         } catch ( ErrorPageError $e ) {
 526                                 // T64091: while exceptions are convenient to bubble up GUI errors,
 527                                 // they are not internal application faults. As with normal requests, this
 528                                 // should commit, print the output, do deferred updates, jobs, and profiling.
 529                                 $this->doPreOutputCommit();
 530                                 $e->report(); // display the GUI error
 531                         }
 532                 } catch ( Exception $e ) {
 533                         $context = $this->context;
 534                         $action = $context->getRequest()->getVal( 'action', 'view' );
 535                         if (
 536                                 $e instanceof DBConnectionError &&
 537                                 $context->hasTitle() &&
 538                                 $context->getTitle()->canExist() &&
 539                                 in_array( $action, [ 'view', 'history' ], true ) &&
 540                                 HTMLFileCache::useFileCache( $this->context, HTMLFileCache::MODE_OUTAGE )
 541                         ) {
 542                                 // Try to use any (even stale) file during outages...
 543                                 $cache = new HTMLFileCache( $context->getTitle(), $action );
 544                                 if ( $cache->isCached() ) {
 545                                         $cache->loadFromFileCache( $context, HTMLFileCache::MODE_OUTAGE );
 546                                         print MWExceptionRenderer::getHTML( $e );
 547                                         exit;
 548                                 }
 549                         }
 550
 551                         MWExceptionHandler::handleException( $e );
 552                 } catch ( Error $e ) {
 553                         // Type errors and such: at least handle it now and clean up the LBFactory state
 554                         MWExceptionHandler::handleException( $e );
 555                 }
 556
 557                 $this->doPostOutputShutdown( 'normal' );
 558         }
 559
 560         private function setDBProfilingAgent() {
 561                 $services = MediaWikiServices::getInstance();
 562                 // Add a comment for easy SHOW PROCESSLIST interpretation
 563                 $name = $this->context->getUser()->getName();
 564                 $services->getDBLoadBalancerFactory()->setAgentName(
 565                         mb_strlen( $name ) > 15 ? mb_substr( $name, 0, 15 ) . '...' : $name
 566                 );
 567         }
 568
 569         /**
 570          * @see MediaWiki::preOutputCommit()
 571          * @param callable $postCommitWork [default: null]
 572          * @since 1.26
 573          */
 574         public function doPreOutputCommit( callable $postCommitWork = null ) {
 575                 self::preOutputCommit( $this->context, $postCommitWork );
 576         }
 577
 578         /**
 579          * This function commits all DB changes as needed before
 580          * the user can receive a response (in case commit fails)
 581          *
 582          * @param IContextSource $context
 583          * @param callable $postCommitWork [default: null]
 584          * @since 1.27
 585          */
 586         public static function preOutputCommit(
 587                 IContextSource $context, callable $postCommitWork = null
 588         ) {
 589                 // Either all DBs should commit or none
 590                 ignore_user_abort( true );
 591
 592                 $config = $context->getConfig();
 593                 $request = $context->getRequest();
 594                 $output = $context->getOutput();
 595                 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 596
 597                 // Commit all changes
 598                 $lbFactory->commitMasterChanges(
 599                         __METHOD__,
 600                         // Abort if any transaction was too big
 601                         [ 'maxWriteDuration' => $config->get( 'MaxUserDBWriteDuration' ) ]
 602                 );
 603                 wfDebug( __METHOD__ . ': primary transaction round committed' );
 604
 605                 // Run updates that need to block the user or affect output (this is the last chance)
 606                 DeferredUpdates::doUpdates( 'enqueue', DeferredUpdates::PRESEND );
 607                 wfDebug( __METHOD__ . ': pre-send deferred updates completed' );
 608
 609                 // Should the client return, their request should observe the new ChronologyProtector
 610                 // DB positions. This request might be on a foreign wiki domain, so synchronously update
 611                 // the DB positions in all datacenters to be safe. If this output is not a redirect,
 612                 // then OutputPage::output() will be relatively slow, meaning that running it in
 613                 // $postCommitWork should help mask the latency of those updates.
 614                 $flags = $lbFactory::SHUTDOWN_CHRONPROT_SYNC;
 615                 $strategy = 'cookie+sync';
 616
 617                 $allowHeaders = !( $output->isDisabled() || headers_sent() );
 618                 if ( $output->getRedirect() && $lbFactory->hasOrMadeRecentMasterChanges( INF ) ) {
 619                         // OutputPage::output() will be fast, so $postCommitWork is useless for masking
 620                         // the latency of synchronously updating the DB positions in all datacenters.
 621                         // Try to make use of the time the client spends following redirects instead.
 622                         $domainDistance = self::getUrlDomainDistance( $output->getRedirect() );
 623                         if ( $domainDistance === 'local' && $allowHeaders ) {
 624                                 $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
 625                                 $strategy = 'cookie'; // use same-domain cookie and keep the URL uncluttered
 626                         } elseif ( $domainDistance === 'remote' ) {
 627                                 $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
 628                                 $strategy = 'cookie+url'; // cross-domain cookie might not work
 629                         }
 630                 }
 631
 632                 // Record ChronologyProtector positions for DBs affected in this request at this point
 633                 $cpIndex = null;
 634                 $lbFactory->shutdown( $flags, $postCommitWork, $cpIndex );
 635                 wfDebug( __METHOD__ . ': LBFactory shutdown completed' );
 636
 637                 if ( $cpIndex > 0 ) {
 638                         if ( $allowHeaders ) {
 639                                 $expires = time() + ChronologyProtector::POSITION_TTL;
 640                                 $options = [ 'prefix' => '' ];
 641                                 $request->response()->setCookie( 'cpPosIndex', $cpIndex, $expires, $options );
 642                         }
 643
 644                         if ( $strategy === 'cookie+url' ) {
 645                                 if ( $output->getRedirect() ) { // sanity
 646                                         $safeUrl = $lbFactory->appendShutdownCPIndexAsQuery(
 647                                                 $output->getRedirect(),
 648                                                 $cpIndex
 649                                         );
 650                                         $output->redirect( $safeUrl );
 651                                 } else {
 652                                         $e = new LogicException( "No redirect; cannot append cpPosIndex parameter." );
 653                                         MWExceptionHandler::logException( $e );
 654                                 }
 655                         }
 656                 }
 657
 658                 // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
 659                 // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
 660                 // ChronologyProtector works for cacheable URLs.
 661                 if ( $request->wasPosted() && $lbFactory->hasOrMadeRecentMasterChanges() ) {
 662                         $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
 663                         $options = [ 'prefix' => '' ];
 664                         $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
 665                         $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
 666                 }
 667
 668                 // Avoid letting a few seconds of replica DB lag cause a month of stale data. This logic is
 669                 // also intimately related to the value of $wgCdnReboundPurgeDelay.
 670                 if ( $lbFactory->laggedReplicaUsed() ) {
 671                         $maxAge = $config->get( 'CdnMaxageLagged' );
 672                         $output->lowerCdnMaxage( $maxAge );
 673                         $request->response()->header( "X-Database-Lagged: true" );
 674                         wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
 675                 }
 676
 677                 // Avoid long-term cache pollution due to message cache rebuild timeouts (T133069)
 678                 if ( MessageCache::singleton()->isDisabled() ) {
 679                         $maxAge = $config->get( 'CdnMaxageSubstitute' );
 680                         $output->lowerCdnMaxage( $maxAge );
 681                         $request->response()->header( "X-Response-Substitute: true" );
 682                 }
 683         }
 684
 685         /**
 686          * @param string $url
 687          * @return string Either "local", "remote" if in the farm, "external" otherwise
 688          */
 689         private static function getUrlDomainDistance( $url ) {
 690                 $clusterWiki = WikiMap::getWikiFromUrl( $url );
 691                 if ( $clusterWiki === wfWikiID() ) {
 692                         return 'local'; // the current wiki
 693                 } elseif ( $clusterWiki !== false ) {
 694                         return 'remote'; // another wiki in this cluster/farm
 695                 }
 696
 697                 return 'external';
 698         }
 699
 700         /**
 701          * This function does work that can be done *after* the
 702          * user gets the HTTP response so they don't block on it
 703          *
 704          * This manages deferred updates, job insertion,
 705          * final commit, and the logging of profiling data
 706          *
 707          * @param string $mode Use 'fast' to always skip job running
 708          * @since 1.26
 709          */
 710         public function doPostOutputShutdown( $mode = 'normal' ) {
 711                 // Perform the last synchronous operations...
 712                 try {
 713                         // Record backend request timing
 714                         $timing = $this->context->getTiming();
 715                         $timing->mark( 'requestShutdown' );
 716                         // Show visible profiling data if enabled (which cannot be post-send)
 717                         Profiler::instance()->logDataPageOutputOnly();
 718                 } catch ( Exception $e ) {
 719                         // An error may already have been shown in run(), so just log it to be safe
 720                         MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 721                 }
 722
 723                 $blocksHttpClient = true;
 724                 // Defer everything else if possible...
 725                 $callback = function () use ( $mode, &$blocksHttpClient ) {
 726                         try {
 727                                 $this->restInPeace( $mode, $blocksHttpClient );
 728                         } catch ( Exception $e ) {
 729                                 // If this is post-send, then displaying errors can cause broken HTML
 730                                 MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 731                         }
 732                 };
 733
 734                 if ( function_exists( 'register_postsend_function' ) ) {
 735                         // https://github.com/facebook/hhvm/issues/1230
 736                         register_postsend_function( $callback );
 737                         /** @noinspection PhpUnusedLocalVariableInspection */
 738                         $blocksHttpClient = false;
 739                 } else {
 740                         if ( function_exists( 'fastcgi_finish_request' ) ) {
 741                                 fastcgi_finish_request();
 742                                 /** @noinspection PhpUnusedLocalVariableInspection */
 743                                 $blocksHttpClient = false;
 744                         } else {
 745                                 // Either all DB and deferred updates should happen or none.
 746                                 // The latter should not be cancelled due to client disconnect.
 747                                 ignore_user_abort( true );
 748                         }
 749
 750                         $callback();
 751                 }
 752         }
 753
 754         private function main() {
 755                 global $wgTitle;
 756
 757                 $output = $this->context->getOutput();
 758                 $request = $this->context->getRequest();
 759
 760                 // Send Ajax requests to the Ajax dispatcher.
 761                 if ( $this->config->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
 762                         // Set a dummy title, because $wgTitle == null might break things
 763                         $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
 764                                 . __METHOD__
 765                         );
 766                         $this->context->setTitle( $title );
 767                         $wgTitle = $title;
 768
 769                         $dispatcher = new AjaxDispatcher( $this->config );
 770                         $dispatcher->performAction( $this->context->getUser() );
 771
 772                         return;
 773                 }
 774
 775                 // Get title from request parameters,
 776                 // is set on the fly by parseTitle the first time.
 777                 $title = $this->getTitle();
 778                 $action = $this->getAction();
 779                 $wgTitle = $title;
 780
 781                 // Set DB query expectations for this HTTP request
 782                 $trxLimits = $this->config->get( 'TrxProfilerLimits' );
 783                 $trxProfiler = Profiler::instance()->getTransactionProfiler();
 784                 $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
 785                 if ( $request->hasSafeMethod() ) {
 786                         $trxProfiler->setExpectations( $trxLimits['GET'], __METHOD__ );
 787                 } else {
 788                         $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__ );
 789                 }
 790
 791                 // If the user has forceHTTPS set to true, or if the user
 792                 // is in a group requiring HTTPS, or if they have the HTTPS
 793                 // preference set, redirect them to HTTPS.
 794                 // Note: Do this after $wgTitle is setup, otherwise the hooks run from
 795                 // isLoggedIn() will do all sorts of weird stuff.
 796                 if (
 797                         $request->getProtocol() == 'http' &&
 798                         // switch to HTTPS only when supported by the server
 799                         preg_match( '#^https://#', wfExpandUrl( $request->getRequestURL(), PROTO_HTTPS ) ) &&
 800                         (
 801                                 $request->getSession()->shouldForceHTTPS() ||
 802                                 // Check the cookie manually, for paranoia
 803                                 $request->getCookie( 'forceHTTPS', '' ) ||
 804                                 // check for prefixed version that was used for a time in older MW versions
 805                                 $request->getCookie( 'forceHTTPS' ) ||
 806                                 // Avoid checking the user and groups unless it's enabled.
 807                                 (
 808                                         $this->context->getUser()->isLoggedIn()
 809                                         && $this->context->getUser()->requiresHTTPS()
 810                                 )
 811                         )
 812                 ) {
 813                         $oldUrl = $request->getFullRequestURL();
 814                         $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
 815
 816                         // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
 817                         if ( Hooks::run( 'BeforeHttpsRedirect', [ $this->context, &$redirUrl ] ) ) {
 818                                 if ( $request->wasPosted() ) {
 819                                         // This is weird and we'd hope it almost never happens. This
 820                                         // means that a POST came in via HTTP and policy requires us
 821                                         // redirecting to HTTPS. It's likely such a request is going
 822                                         // to fail due to post data being lost, but let's try anyway
 823                                         // and just log the instance.
 824
 825                                         // @todo FIXME: See if we could issue a 307 or 308 here, need
 826                                         // to see how clients (automated & browser) behave when we do
 827                                         wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
 828                                 }
 829                                 // Setup dummy Title, otherwise OutputPage::redirect will fail
 830                                 $title = Title::newFromText( 'REDIR', NS_MAIN );
 831                                 $this->context->setTitle( $title );
 832                                 // Since we only do this redir to change proto, always send a vary header
 833                                 $output->addVaryHeader( 'X-Forwarded-Proto' );
 834                                 $output->redirect( $redirUrl );
 835                                 $output->output();
 836
 837                                 return;
 838                         }
 839                 }
 840
 841                 if ( $title->canExist() && HTMLFileCache::useFileCache( $this->context ) ) {
 842                         // Try low-level file cache hit
 843                         $cache = new HTMLFileCache( $title, $action );
 844                         if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
 845                                 // Check incoming headers to see if client has this cached
 846                                 $timestamp = $cache->cacheTimestamp();
 847                                 if ( !$output->checkLastModified( $timestamp ) ) {
 848                                         $cache->loadFromFileCache( $this->context );
 849                                 }
 850                                 // Do any stats increment/watchlist stuff, assuming user is viewing the
 851                                 // latest revision (which should always be the case for file cache)
 852                                 $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
 853                                 // Tell OutputPage that output is taken care of
 854                                 $output->disable();
 855
 856                                 return;
 857                         }
 858                 }
 859
 860                 // Actually do the work of the request and build up any output
 861                 $this->performRequest();
 862
 863                 // GUI-ify and stash the page output in MediaWiki::doPreOutputCommit() while
 864                 // ChronologyProtector synchronizes DB positions or slaves accross all datacenters.
 865                 $buffer = null;
 866                 $outputWork = function () use ( $output, &$buffer ) {
 867                         if ( $buffer === null ) {
 868                                 $buffer = $output->output( true );
 869                         }
 870
 871                         return $buffer;
 872                 };
 873
 874                 // Now commit any transactions, so that unreported errors after
 875                 // output() don't roll back the whole DB transaction and so that
 876                 // we avoid having both success and error text in the response
 877                 $this->doPreOutputCommit( $outputWork );
 878
 879                 // Now send the actual output
 880                 print $outputWork();
 881         }
 882
 883         /**
 884          * Ends this task peacefully
 885          * @param string $mode Use 'fast' to always skip job running
 886          * @param bool $blocksHttpClient Whether this blocks an HTTP response to a client
 887          */
 888         public function restInPeace( $mode = 'fast', $blocksHttpClient = true ) {
 889                 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 890                 // Assure deferred updates are not in the main transaction
 891                 $lbFactory->commitMasterChanges( __METHOD__ );
 892
 893                 // Loosen DB query expectations since the HTTP client is unblocked
 894                 $trxProfiler = Profiler::instance()->getTransactionProfiler();
 895                 $trxProfiler->resetExpectations();
 896                 $trxProfiler->setExpectations(
 897                         $this->context->getRequest()->hasSafeMethod()
 898                                 ? $this->config->get( 'TrxProfilerLimits' )['PostSend-GET']
 899                                 : $this->config->get( 'TrxProfilerLimits' )['PostSend-POST'],
 900                         __METHOD__
 901                 );
 902
 903                 // Important: this must be the last deferred update added (T100085, T154425)
 904                 DeferredUpdates::addCallableUpdate( [ JobQueueGroup::class, 'pushLazyJobs' ] );
 905
 906                 // Do any deferred jobs; preferring to run them now if a client will not wait on them
 907                 DeferredUpdates::doUpdates( $blocksHttpClient ? 'enqueue' : 'run' );
 908
 909                 // Now that everything specific to this request is done,
 910                 // try to occasionally run jobs (if enabled) from the queues
 911                 if ( $mode === 'normal' ) {
 912                         $this->triggerJobs();
 913                 }
 914
 915                 // Log profiling data, e.g. in the database or UDP
 916                 wfLogProfilingData();
 917
 918                 // Commit and close up!
 919                 $lbFactory->commitMasterChanges( __METHOD__ );
 920                 $lbFactory->shutdown( LBFactory::SHUTDOWN_NO_CHRONPROT );
 921
 922                 wfDebug( "Request ended normally\n" );
 923         }
 924
 925         /**
 926          * Send out any buffered statsd data according to sampling rules
 927          *
 928          * @param IBufferingStatsdDataFactory $stats
 929          * @param Config $config
 930          * @throws ConfigException
 931          * @since 1.31
 932          */
 933         public static function emitBufferedStatsdData(
 934                 IBufferingStatsdDataFactory $stats, Config $config
 935         ) {
 936                 if ( $config->get( 'StatsdServer' ) && $stats->hasData() ) {
 937                         try {
 938                                 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
 939                                 $statsdHost = $statsdServer[0];
 940                                 $statsdPort = isset( $statsdServer[1] ) ? $statsdServer[1] : 8125;
 941                                 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
 942                                 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
 943                                 $statsdClient->setSamplingRates( $config->get( 'StatsdSamplingRates' ) );
 944                                 $statsdClient->send( $stats->getData() );
 945
 946                                 $stats->clearData(); // empty buffer for the next round
 947                         } catch ( Exception $ex ) {
 948                                 MWExceptionHandler::logException( $ex );
 949                         }
 950                 }
 951         }
 952
 953         /**
 954          * Potentially open a socket and sent an HTTP request back to the server
 955          * to run a specified number of jobs. This registers a callback to cleanup
 956          * the socket once it's done.
 957          */
 958         public function triggerJobs() {
 959                 $jobRunRate = $this->config->get( 'JobRunRate' );
 960                 if ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
 961                         return; // recursion guard
 962                 } elseif ( $jobRunRate <= 0 || wfReadOnly() ) {
 963                         return;
 964                 }
 965
 966                 if ( $jobRunRate < 1 ) {
 967                         $max = mt_getrandmax();
 968                         if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
 969                                 return; // the higher the job run rate, the less likely we return here
 970                         }
 971                         $n = 1;
 972                 } else {
 973                         $n = intval( $jobRunRate );
 974                 }
 975
 976                 $logger = LoggerFactory::getInstance( 'runJobs' );
 977
 978                 try {
 979                         if ( $this->config->get( 'RunJobsAsync' ) ) {
 980                                 // Send an HTTP request to the job RPC entry point if possible
 981                                 $invokedWithSuccess = $this->triggerAsyncJobs( $n, $logger );
 982                                 if ( !$invokedWithSuccess ) {
 983                                         // Fall back to blocking on running the job(s)
 984                                         $logger->warning( "Jobs switched to blocking; Special:RunJobs disabled" );
 985                                         $this->triggerSyncJobs( $n, $logger );
 986                                 }
 987                         } else {
 988                                 $this->triggerSyncJobs( $n, $logger );
 989                         }
 990                 } catch ( JobQueueError $e ) {
 991                         // Do not make the site unavailable (T88312)
 992                         MWExceptionHandler::logException( $e );
 993                 }
 994         }
 995
 996         /**
 997          * @param int $n Number of jobs to try to run
 998          * @param LoggerInterface $runJobsLogger
 999          */
1000         private function triggerSyncJobs( $n, LoggerInterface $runJobsLogger ) {
1001                 $runner = new JobRunner( $runJobsLogger );
1002                 $runner->run( [ 'maxJobs' => $n ] );
1003         }
1004
1005         /**
1006          * @param int $n Number of jobs to try to run
1007          * @param LoggerInterface $runJobsLogger
1008          * @return bool Success
1009          */
1010         private function triggerAsyncJobs( $n, LoggerInterface $runJobsLogger ) {
1011                 // Do not send request if there are probably no jobs
1012                 $group = JobQueueGroup::singleton();
1013                 if ( !$group->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
1014                         return true;
1015                 }
1016
1017                 $query = [ 'title' => 'Special:RunJobs',
1018                         'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 ];
1019                 $query['signature'] = SpecialRunJobs::getQuerySignature(
1020                         $query, $this->config->get( 'SecretKey' ) );
1021
1022                 $errno = $errstr = null;
1023                 $info = wfParseUrl( $this->config->get( 'CanonicalServer' ) );
1024                 $host = $info ? $info['host'] : null;
1025                 $port = 80;
1026                 if ( isset( $info['scheme'] ) && $info['scheme'] == 'https' ) {
1027                         $host = "tls://" . $host;
1028                         $port = 443;
1029                 }
1030                 if ( isset( $info['port'] ) ) {
1031                         $port = $info['port'];
1032                 }
1033
1034                 Wikimedia\suppressWarnings();
1035                 $sock = $host ? fsockopen(
1036                         $host,
1037                         $port,
1038                         $errno,
1039                         $errstr,
1040                         // If it takes more than 100ms to connect to ourselves there is a problem...
1041                         0.100
1042                 ) : false;
1043                 Wikimedia\restoreWarnings();
1044
1045                 $invokedWithSuccess = true;
1046                 if ( $sock ) {
1047                         $special = SpecialPageFactory::getPage( 'RunJobs' );
1048                         $url = $special->getPageTitle()->getCanonicalURL( $query );
1049                         $req = (
1050                                 "POST $url HTTP/1.1\r\n" .
1051                                 "Host: {$info['host']}\r\n" .
1052                                 "Connection: Close\r\n" .
1053                                 "Content-Length: 0\r\n\r\n"
1054                         );
1055
1056                         $runJobsLogger->info( "Running $n job(s) via '$url'" );
1057                         // Send a cron API request to be performed in the background.
1058                         // Give up if this takes too long to send (which should be rare).
1059                         stream_set_timeout( $sock, 2 );
1060                         $bytes = fwrite( $sock, $req );
1061                         if ( $bytes !== strlen( $req ) ) {
1062                                 $invokedWithSuccess = false;
1063                                 $runJobsLogger->error( "Failed to start cron API (socket write error)" );
1064                         } else {
1065                                 // Do not wait for the response (the script should handle client aborts).
1066                                 // Make sure that we don't close before that script reaches ignore_user_abort().
1067                                 $start = microtime( true );
1068                                 $status = fgets( $sock );
1069                                 $sec = microtime( true ) - $start;
1070                                 if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
1071                                         $invokedWithSuccess = false;
1072                                         $runJobsLogger->error( "Failed to start cron API: received '$status' ($sec)" );
1073                                 }
1074                         }
1075                         fclose( $sock );
1076                 } else {
1077                         $invokedWithSuccess = false;
1078                         $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
1079                 }
1080
1081                 return $invokedWithSuccess;
1082         }
1083 }