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