includes/context/RequestContext.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @since 1.18
  19  *
  20  * @author Alexandre Emsenhuber
  21  * @author Daniel Friesen
  22  * @file
  23  */
  24
  25 use MediaWiki\Logger\LoggerFactory;
  26 use MediaWiki\MediaWikiServices;
  27 use Wikimedia\ScopedCallback;
  28
  29 /**
  30  * Group all the pieces relevant to the context of a request into one instance
  31  */
  32 class RequestContext implements IContextSource, MutableContext {
  33         /**
  34          * @var WebRequest
  35          */
  36         private $request;
  37
  38         /**
  39          * @var Title
  40          */
  41         private $title;
  42
  43         /**
  44          * @var WikiPage
  45          */
  46         private $wikipage;
  47
  48         /**
  49          * @var OutputPage
  50          */
  51         private $output;
  52
  53         /**
  54          * @var User
  55          */
  56         private $user;
  57
  58         /**
  59          * @var Language
  60          */
  61         private $lang;
  62
  63         /**
  64          * @var Skin
  65          */
  66         private $skin;
  67
  68         /**
  69          * @var Timing
  70          */
  71         private $timing;
  72
  73         /**
  74          * @var Config
  75          */
  76         private $config;
  77
  78         /**
  79          * @var RequestContext
  80          */
  81         private static $instance = null;
  82
  83         /**
  84          * @param Config $config
  85          */
  86         public function setConfig( Config $config ) {
  87                 $this->config = $config;
  88         }
  89
  90         /**
  91          * @return Config
  92          */
  93         public function getConfig() {
  94                 if ( $this->config === null ) {
  95                         // @todo In the future, we could move this to WebStart.php so
  96                         // the Config object is ready for when initialization happens
  97                         $this->config = MediaWikiServices::getInstance()->getMainConfig();
  98                 }
  99
 100                 return $this->config;
 101         }
 102
 103         /**
 104          * Set the WebRequest object
 105          *
 106          * @param WebRequest $r
 107          */
 108         public function setRequest( WebRequest $r ) {
 109                 $this->request = $r;
 110         }
 111
 112         /**
 113          * Get the WebRequest object
 114          *
 115          * @return WebRequest
 116          */
 117         public function getRequest() {
 118                 if ( $this->request === null ) {
 119                         global $wgCommandLineMode;
 120                         // create the WebRequest object on the fly
 121                         if ( $wgCommandLineMode ) {
 122                                 $this->request = new FauxRequest( [] );
 123                         } else {
 124                                 $this->request = new WebRequest();
 125                         }
 126                 }
 127
 128                 return $this->request;
 129         }
 130
 131         /**
 132          * Get the Stats object
 133          *
 134          * @deprecated since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected)
 135          *
 136          * @return IBufferingStatsdDataFactory
 137          */
 138         public function getStats() {
 139                 return MediaWikiServices::getInstance()->getStatsdDataFactory();
 140         }
 141
 142         /**
 143          * Get the timing object
 144          *
 145          * @return Timing
 146          */
 147         public function getTiming() {
 148                 if ( $this->timing === null ) {
 149                         $this->timing = new Timing( [
 150                                 'logger' => LoggerFactory::getInstance( 'Timing' )
 151                         ] );
 152                 }
 153                 return $this->timing;
 154         }
 155
 156         /**
 157          * Set the Title object
 158          *
 159          * @param Title|null $title
 160          */
 161         public function setTitle( Title $title = null ) {
 162                 $this->title = $title;
 163                 // Erase the WikiPage so a new one with the new title gets created.
 164                 $this->wikipage = null;
 165         }
 166
 167         /**
 168          * Get the Title object
 169          *
 170          * @return Title|null
 171          */
 172         public function getTitle() {
 173                 if ( $this->title === null ) {
 174                         global $wgTitle; # fallback to $wg till we can improve this
 175                         $this->title = $wgTitle;
 176                         wfDebugLog(
 177                                 'GlobalTitleFail',
 178                                 __METHOD__ . ' called by ' . wfGetAllCallers( 5 ) . ' with no title set.'
 179                         );
 180                 }
 181
 182                 return $this->title;
 183         }
 184
 185         /**
 186          * Check, if a Title object is set
 187          *
 188          * @since 1.25
 189          * @return bool
 190          */
 191         public function hasTitle() {
 192                 return $this->title !== null;
 193         }
 194
 195         /**
 196          * Check whether a WikiPage object can be get with getWikiPage().
 197          * Callers should expect that an exception is thrown from getWikiPage()
 198          * if this method returns false.
 199          *
 200          * @since 1.19
 201          * @return bool
 202          */
 203         public function canUseWikiPage() {
 204                 if ( $this->wikipage ) {
 205                         // If there's a WikiPage object set, we can for sure get it
 206                         return true;
 207                 }
 208                 // Only pages with legitimate titles can have WikiPages.
 209                 // That usually means pages in non-virtual namespaces.
 210                 $title = $this->getTitle();
 211                 return $title ? $title->canExist() : false;
 212         }
 213
 214         /**
 215          * Set the WikiPage object
 216          *
 217          * @since 1.19
 218          * @param WikiPage $p
 219          */
 220         public function setWikiPage( WikiPage $p ) {
 221                 $pageTitle = $p->getTitle();
 222                 if ( !$this->hasTitle() || !$pageTitle->equals( $this->getTitle() ) ) {
 223                         $this->setTitle( $pageTitle );
 224                 }
 225                 // Defer this to the end since setTitle sets it to null.
 226                 $this->wikipage = $p;
 227         }
 228
 229         /**
 230          * Get the WikiPage object.
 231          * May throw an exception if there's no Title object set or the Title object
 232          * belongs to a special namespace that doesn't have WikiPage, so use first
 233          * canUseWikiPage() to check whether this method can be called safely.
 234          *
 235          * @since 1.19
 236          * @throws MWException
 237          * @return WikiPage
 238          */
 239         public function getWikiPage() {
 240                 if ( $this->wikipage === null ) {
 241                         $title = $this->getTitle();
 242                         if ( $title === null ) {
 243                                 throw new MWException( __METHOD__ . ' called without Title object set' );
 244                         }
 245                         $this->wikipage = WikiPage::factory( $title );
 246                 }
 247
 248                 return $this->wikipage;
 249         }
 250
 251         /**
 252          * @param OutputPage $o
 253          */
 254         public function setOutput( OutputPage $o ) {
 255                 $this->output = $o;
 256         }
 257
 258         /**
 259          * Get the OutputPage object
 260          *
 261          * @return OutputPage
 262          */
 263         public function getOutput() {
 264                 if ( $this->output === null ) {
 265                         $this->output = new OutputPage( $this );
 266                 }
 267
 268                 return $this->output;
 269         }
 270
 271         /**
 272          * Set the User object
 273          *
 274          * @param User $u
 275          */
 276         public function setUser( User $u ) {
 277                 $this->user = $u;
 278         }
 279
 280         /**
 281          * Get the User object
 282          *
 283          * @return User
 284          */
 285         public function getUser() {
 286                 if ( $this->user === null ) {
 287                         $this->user = User::newFromSession( $this->getRequest() );
 288                 }
 289
 290                 return $this->user;
 291         }
 292
 293         /**
 294          * Accepts a language code and ensures it's sane. Outputs a cleaned up language
 295          * code and replaces with $wgLanguageCode if not sane.
 296          * @param string $code Language code
 297          * @return string
 298          */
 299         public static function sanitizeLangCode( $code ) {
 300                 global $wgLanguageCode;
 301
 302                 // BCP 47 - letter case MUST NOT carry meaning
 303                 $code = strtolower( $code );
 304
 305                 # Validate $code
 306                 if ( !$code || !Language::isValidCode( $code ) || $code === 'qqq' ) {
 307                         $code = $wgLanguageCode;
 308                 }
 309
 310                 return $code;
 311         }
 312
 313         /**
 314          * Set the Language object
 315          *
 316          * @param Language|string $l Language instance or language code
 317          * @throws MWException
 318          * @since 1.19
 319          */
 320         public function setLanguage( $l ) {
 321                 if ( $l instanceof Language ) {
 322                         $this->lang = $l;
 323                 } elseif ( is_string( $l ) ) {
 324                         $l = self::sanitizeLangCode( $l );
 325                         $obj = Language::factory( $l );
 326                         $this->lang = $obj;
 327                 } else {
 328                         throw new MWException( __METHOD__ . " was passed an invalid type of data." );
 329                 }
 330         }
 331
 332         /**
 333          * Get the Language object.
 334          * Initialization of user or request objects can depend on this.
 335          * @return Language
 336          * @throws Exception
 337          * @since 1.19
 338          */
 339         public function getLanguage() {
 340                 if ( isset( $this->recursion ) ) {
 341                         trigger_error( "Recursion detected in " . __METHOD__, E_USER_WARNING );
 342                         $e = new Exception;
 343                         wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
 344
 345                         $code = $this->getConfig()->get( 'LanguageCode' ) ?: 'en';
 346                         $this->lang = Language::factory( $code );
 347                 } elseif ( $this->lang === null ) {
 348                         $this->recursion = true;
 349
 350                         global $wgContLang;
 351
 352                         try {
 353                                 $request = $this->getRequest();
 354                                 $user = $this->getUser();
 355
 356                                 $code = $request->getVal( 'uselang', 'user' );
 357                                 if ( $code === 'user' ) {
 358                                         $code = $user->getOption( 'language' );
 359                                 }
 360                                 $code = self::sanitizeLangCode( $code );
 361
 362                                 Hooks::run( 'UserGetLanguageObject', [ $user, &$code, $this ] );
 363
 364                                 if ( $code === $this->getConfig()->get( 'LanguageCode' ) ) {
 365                                         $this->lang = $wgContLang;
 366                                 } else {
 367                                         $obj = Language::factory( $code );
 368                                         $this->lang = $obj;
 369                                 }
 370
 371                                 unset( $this->recursion );
 372                         }
 373                         catch ( Exception $ex ) {
 374                                 unset( $this->recursion );
 375                                 throw $ex;
 376                         }
 377                 }
 378
 379                 return $this->lang;
 380         }
 381
 382         /**
 383          * Set the Skin object
 384          *
 385          * @param Skin $s
 386          */
 387         public function setSkin( Skin $s ) {
 388                 $this->skin = clone $s;
 389                 $this->skin->setContext( $this );
 390         }
 391
 392         /**
 393          * Get the Skin object
 394          *
 395          * @return Skin
 396          */
 397         public function getSkin() {
 398                 if ( $this->skin === null ) {
 399                         $skin = null;
 400                         Hooks::run( 'RequestContextCreateSkin', [ $this, &$skin ] );
 401                         $factory = SkinFactory::getDefaultInstance();
 402
 403                         // If the hook worked try to set a skin from it
 404                         if ( $skin instanceof Skin ) {
 405                                 $this->skin = $skin;
 406                         } elseif ( is_string( $skin ) ) {
 407                                 // Normalize the key, just in case the hook did something weird.
 408                                 $normalized = Skin::normalizeKey( $skin );
 409                                 $this->skin = $factory->makeSkin( $normalized );
 410                         }
 411
 412                         // If this is still null (the hook didn't run or didn't work)
 413                         // then go through the normal processing to load a skin
 414                         if ( $this->skin === null ) {
 415                                 if ( !in_array( 'skin', $this->getConfig()->get( 'HiddenPrefs' ) ) ) {
 416                                         # get the user skin
 417                                         $userSkin = $this->getUser()->getOption( 'skin' );
 418                                         $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
 419                                 } else {
 420                                         # if we're not allowing users to override, then use the default
 421                                         $userSkin = $this->getConfig()->get( 'DefaultSkin' );
 422                                 }
 423
 424                                 // Normalize the key in case the user is passing gibberish
 425                                 // or has old preferences (T71566).
 426                                 $normalized = Skin::normalizeKey( $userSkin );
 427
 428                                 // Skin::normalizeKey will also validate it, so
 429                                 // this won't throw an exception
 430                                 $this->skin = $factory->makeSkin( $normalized );
 431                         }
 432
 433                         // After all that set a context on whatever skin got created
 434                         $this->skin->setContext( $this );
 435                 }
 436
 437                 return $this->skin;
 438         }
 439
 440         /**
 441          * Get a Message object with context set
 442          * Parameters are the same as wfMessage()
 443          *
 444          * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
 445          *   or a MessageSpecifier.
 446          * @param mixed $args,...
 447          * @return Message
 448          */
 449         public function msg( $key ) {
 450                 $args = func_get_args();
 451
 452                 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
 453         }
 454
 455         /**
 456          * Get the RequestContext object associated with the main request
 457          *
 458          * @return RequestContext
 459          */
 460         public static function getMain() {
 461                 if ( self::$instance === null ) {
 462                         self::$instance = new self;
 463                 }
 464
 465                 return self::$instance;
 466         }
 467
 468         /**
 469          * Get the RequestContext object associated with the main request
 470          * and gives a warning to the log, to find places, where a context maybe is missing.
 471          *
 472          * @param string $func
 473          * @return RequestContext
 474          * @since 1.24
 475          */
 476         public static function getMainAndWarn( $func = __METHOD__ ) {
 477                 wfDebug( $func . ' called without context. ' .
 478                         "Using RequestContext::getMain() for sanity\n" );
 479
 480                 return self::getMain();
 481         }
 482
 483         /**
 484          * Resets singleton returned by getMain(). Should be called only from unit tests.
 485          */
 486         public static function resetMain() {
 487                 if ( !( defined( 'MW_PHPUNIT_TEST' ) || defined( 'MW_PARSER_TEST' ) ) ) {
 488                         throw new MWException( __METHOD__ . '() should be called only from unit tests!' );
 489                 }
 490                 self::$instance = null;
 491         }
 492
 493         /**
 494          * Export the resolved user IP, HTTP headers, user ID, and session ID.
 495          * The result will be reasonably sized to allow for serialization.
 496          *
 497          * @return array
 498          * @since 1.21
 499          */
 500         public function exportSession() {
 501                 $session = MediaWiki\Session\SessionManager::getGlobalSession();
 502                 return [
 503                         'ip' => $this->getRequest()->getIP(),
 504                         'headers' => $this->getRequest()->getAllHeaders(),
 505                         'sessionId' => $session->isPersistent() ? $session->getId() : '',
 506                         'userId' => $this->getUser()->getId()
 507                 ];
 508         }
 509
 510         /**
 511          * Import an client IP address, HTTP headers, user ID, and session ID
 512          *
 513          * This sets the current session, $wgUser, and $wgRequest from $params.
 514          * Once the return value falls out of scope, the old context is restored.
 515          * This method should only be called in contexts where there is no session
 516          * ID or end user receiving the response (CLI or HTTP job runners). This
 517          * is partly enforced, and is done so to avoid leaking cookies if certain
 518          * error conditions arise.
 519          *
 520          * This is useful when background scripts inherit context when acting on
 521          * behalf of a user. In general the 'sessionId' parameter should be set
 522          * to an empty string unless session importing is *truly* needed. This
 523          * feature is somewhat deprecated.
 524          *
 525          * @note suhosin.session.encrypt may interfere with this method.
 526          *
 527          * @param array $params Result of RequestContext::exportSession()
 528          * @return ScopedCallback
 529          * @throws MWException
 530          * @since 1.21
 531          */
 532         public static function importScopedSession( array $params ) {
 533                 if ( strlen( $params['sessionId'] ) &&
 534                         MediaWiki\Session\SessionManager::getGlobalSession()->isPersistent()
 535                 ) {
 536                         // Sanity check to avoid sending random cookies for the wrong users.
 537                         // This method should only called by CLI scripts or by HTTP job runners.
 538                         throw new MWException( "Sessions can only be imported when none is active." );
 539                 } elseif ( !IP::isValid( $params['ip'] ) ) {
 540                         throw new MWException( "Invalid client IP address '{$params['ip']}'." );
 541                 }
 542
 543                 if ( $params['userId'] ) { // logged-in user
 544                         $user = User::newFromId( $params['userId'] );
 545                         $user->load();
 546                         if ( !$user->getId() ) {
 547                                 throw new MWException( "No user with ID '{$params['userId']}'." );
 548                         }
 549                 } else { // anon user
 550                         $user = User::newFromName( $params['ip'], false );
 551                 }
 552
 553                 $importSessionFunc = function ( User $user, array $params ) {
 554                         global $wgRequest, $wgUser;
 555
 556                         $context = RequestContext::getMain();
 557
 558                         // Commit and close any current session
 559                         if ( MediaWiki\Session\PHPSessionHandler::isEnabled() ) {
 560                                 session_write_close(); // persist
 561                                 session_id( '' ); // detach
 562                                 $_SESSION = []; // clear in-memory array
 563                         }
 564
 565                         // Get new session, if applicable
 566                         $session = null;
 567                         if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
 568                                 $manager = MediaWiki\Session\SessionManager::singleton();
 569                                 $session = $manager->getSessionById( $params['sessionId'], true )
 570                                         ?: $manager->getEmptySession();
 571                         }
 572
 573                         // Remove any user IP or agent information, and attach the request
 574                         // with the new session.
 575                         $context->setRequest( new FauxRequest( [], false, $session ) );
 576                         $wgRequest = $context->getRequest(); // b/c
 577
 578                         // Now that all private information is detached from the user, it should
 579                         // be safe to load the new user. If errors occur or an exception is thrown
 580                         // and caught (leaving the main context in a mixed state), there is no risk
 581                         // of the User object being attached to the wrong IP, headers, or session.
 582                         $context->setUser( $user );
 583                         $wgUser = $context->getUser(); // b/c
 584                         if ( $session && MediaWiki\Session\PHPSessionHandler::isEnabled() ) {
 585                                 session_id( $session->getId() );
 586                                 MediaWiki\quietCall( 'session_start' );
 587                         }
 588                         $request = new FauxRequest( [], false, $session );
 589                         $request->setIP( $params['ip'] );
 590                         foreach ( $params['headers'] as $name => $value ) {
 591                                 $request->setHeader( $name, $value );
 592                         }
 593                         // Set the current context to use the new WebRequest
 594                         $context->setRequest( $request );
 595                         $wgRequest = $context->getRequest(); // b/c
 596                 };
 597
 598                 // Stash the old session and load in the new one
 599                 $oUser = self::getMain()->getUser();
 600                 $oParams = self::getMain()->exportSession();
 601                 $oRequest = self::getMain()->getRequest();
 602                 $importSessionFunc( $user, $params );
 603
 604                 // Set callback to save and close the new session and reload the old one
 605                 return new ScopedCallback(
 606                         function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
 607                                 global $wgRequest;
 608                                 $importSessionFunc( $oUser, $oParams );
 609                                 // Restore the exact previous Request object (instead of leaving FauxRequest)
 610                                 RequestContext::getMain()->setRequest( $oRequest );
 611                                 $wgRequest = RequestContext::getMain()->getRequest(); // b/c
 612                         }
 613                 );
 614         }
 615
 616         /**
 617          * Create a new extraneous context. The context is filled with information
 618          * external to the current session.
 619          * - Title is specified by argument
 620          * - Request is a FauxRequest, or a FauxRequest can be specified by argument
 621          * - User is an anonymous user, for separation IPv4 localhost is used
 622          * - Language will be based on the anonymous user and request, may be content
 623          *   language or a uselang param in the fauxrequest data may change the lang
 624          * - Skin will be based on the anonymous user, should be the wiki's default skin
 625          *
 626          * @param Title $title Title to use for the extraneous request
 627          * @param WebRequest|array $request A WebRequest or data to use for a FauxRequest
 628          * @return RequestContext
 629          */
 630         public static function newExtraneousContext( Title $title, $request = [] ) {
 631                 $context = new self;
 632                 $context->setTitle( $title );
 633                 if ( $request instanceof WebRequest ) {
 634                         $context->setRequest( $request );
 635                 } else {
 636                         $context->setRequest( new FauxRequest( $request ) );
 637                 }
 638                 $context->user = User::newFromName( '127.0.0.1', false );
 639
 640                 return $context;
 641         }
 642 }