includes/context/RequestContext.php

   1 <?php
   2 /**
   3  * Request-dependant objects containers.
   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  * @since 1.18
  21  *
  22  * @author Alexandre Emsenhuber
  23  * @author Daniel Friesen
  24  * @file
  25  */
  26
  27 /**
  28  * Group all the pieces relevant to the context of a request into one instance
  29  */
  30 class RequestContext implements IContextSource {
  31
  32         /**
  33          * @var WebRequest
  34          */
  35         private $request;
  36
  37         /**
  38          * @var Title
  39          */
  40         private $title;
  41
  42         /**
  43          * @var OutputPage
  44          */
  45         private $output;
  46
  47         /**
  48          * @var User
  49          */
  50         private $user;
  51
  52         /**
  53          * @var Language
  54          */
  55         private $lang;
  56
  57         /**
  58          * @var Skin
  59          */
  60         private $skin;
  61
  62         /**
  63          * Set the WebRequest object
  64          *
  65          * @param $r WebRequest object
  66          */
  67         public function setRequest( WebRequest $r ) {
  68                 $this->request = $r;
  69         }
  70
  71         /**
  72          * Get the WebRequest object
  73          *
  74          * @return WebRequest
  75          */
  76         public function getRequest() {
  77                 if ( $this->request === null ) {
  78                         global $wgRequest; # fallback to $wg till we can improve this
  79                         $this->request = $wgRequest;
  80                 }
  81                 return $this->request;
  82         }
  83
  84         /**
  85          * Set the Title object
  86          *
  87          * @param $t Title object
  88          */
  89         public function setTitle( Title $t ) {
  90                 $this->title = $t;
  91         }
  92
  93         /**
  94          * Get the Title object
  95          *
  96          * @return Title
  97          */
  98         public function getTitle() {
  99                 if ( $this->title === null ) {
 100                         global $wgTitle; # fallback to $wg till we can improve this
 101                         $this->title = $wgTitle;
 102                 }
 103                 return $this->title;
 104         }
 105
 106         /**
 107          * @param $o OutputPage
 108          */
 109         public function setOutput( OutputPage $o ) {
 110                 $this->output = $o;
 111         }
 112
 113         /**
 114          * Get the OutputPage object
 115          *
 116          * @return OutputPage object
 117          */
 118         public function getOutput() {
 119                 if ( $this->output === null ) {
 120                         $this->output = new OutputPage( $this );
 121                 }
 122                 return $this->output;
 123         }
 124
 125         /**
 126          * Set the User object
 127          *
 128          * @param $u User
 129          */
 130         public function setUser( User $u ) {
 131                 $this->user = $u;
 132         }
 133
 134         /**
 135          * Get the User object
 136          *
 137          * @return User
 138          */
 139         public function getUser() {
 140                 if ( $this->user === null ) {
 141                         $this->user = User::newFromSession( $this->getRequest() );
 142                 }
 143                 return $this->user;
 144         }
 145
 146         /**
 147          * Accepts a language code and ensures it's sane. Outputs a cleaned up language
 148          * code and replaces with $wgLanguageCode if not sane.
 149          * @private
 150          */
 151         static function sanitizeLangCode( $code ) {
 152                 global $wgLanguageCode;
 153
 154                 // BCP 47 - letter case MUST NOT carry meaning
 155                 $code = strtolower( $code );
 156
 157                 # Validate $code
 158                 if( empty( $code ) || !Language::isValidCode( $code ) || ( $code === 'qqq' ) ) {
 159                         wfDebug( "Invalid user language code\n" );
 160                         $code = $wgLanguageCode;
 161                 }
 162
 163                 return $code;
 164         }
 165
 166         /**
 167          * Set the Language object
 168          *
 169          * @deprecated 1.19 Use setLanguage instead
 170          * @param $l Mixed Language instance or language code
 171          */
 172         public function setLang( $l ) {
 173                 wfDeprecated( __METHOD__, '1.19' );
 174                 $this->setLanguage( $l );
 175         }
 176
 177         /**
 178          * Set the Language object
 179          *
 180          * @param $l Mixed Language instance or language code
 181          * @since 1.19
 182          */
 183         public function setLanguage( $l ) {
 184                 if ( $l instanceof Language ) {
 185                         $this->lang = $l;
 186                 } elseif ( is_string( $l ) ) {
 187                         $l = self::sanitizeLangCode( $l );
 188                         $obj = Language::factory( $l );
 189                         $this->lang = $obj;
 190                 } else {
 191                         throw new MWException( __METHOD__ . " was passed an invalid type of data." );
 192                 }
 193         }
 194
 195         /**
 196          * @deprecated 1.19 Use getLanguage instead
 197          * @return Language
 198          */
 199         public function getLang() {
 200                 wfDeprecated( __METHOD__, '1.19' );
 201                 return $this->getLanguage();
 202         }
 203
 204         /**
 205          * Get the Language object
 206          *
 207          * @return Language
 208          * @since 1.19
 209          */
 210         public function getLanguage() {
 211                 if ( $this->lang === null ) {
 212                         global $wgLanguageCode, $wgContLang;
 213                         $code = $this->getRequest()->getVal(
 214                                 'uselang',
 215                                 $this->getUser()->getOption( 'language' )
 216                         );
 217                         $code = self::sanitizeLangCode( $code );
 218
 219                         wfRunHooks( 'UserGetLanguageObject', array( $this->getUser(), &$code ) );
 220
 221                         if( $code === $wgLanguageCode ) {
 222                                 $this->lang = $wgContLang;
 223                         } else {
 224                                 $obj = Language::factory( $code );
 225                                 $this->lang = $obj;
 226                         }
 227                 }
 228                 return $this->lang;
 229         }
 230
 231         /**
 232          * Set the Skin object
 233          *
 234          * @param $s Skin
 235          */
 236         public function setSkin( Skin $s ) {
 237                 $this->skin = clone $s;
 238                 $this->skin->setContext( $this );
 239         }
 240
 241         /**
 242          * Get the Skin object
 243          *
 244          * @return Skin
 245          */
 246         public function getSkin() {
 247                 if ( $this->skin === null ) {
 248                         wfProfileIn( __METHOD__ . '-createskin' );
 249
 250                         global $wgHiddenPrefs;
 251                         if( !in_array( 'skin', $wgHiddenPrefs ) ) {
 252                                 # get the user skin
 253                                 $userSkin = $this->getUser()->getOption( 'skin' );
 254                                 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
 255                         } else {
 256                                 # if we're not allowing users to override, then use the default
 257                                 global $wgDefaultSkin;
 258                                 $userSkin = $wgDefaultSkin;
 259                         }
 260
 261                         $this->skin = Skin::newFromKey( $userSkin );
 262                         $this->skin->setContext( $this );
 263                         wfProfileOut( __METHOD__ . '-createskin' );
 264                 }
 265                 return $this->skin;
 266         }
 267
 268         /** Helpful methods **/
 269
 270         /**
 271          * Get a Message object with context set
 272          * Parameters are the same as wfMessage()
 273          *
 274          * @return Message object
 275          */
 276         public function msg() {
 277                 $args = func_get_args();
 278                 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
 279         }
 280
 281         /** Static methods **/
 282
 283         /**
 284          * Get the RequestContext object associated with the main request
 285          *
 286          * @return RequestContext object
 287          */
 288         public static function getMain() {
 289                 static $instance = null;
 290                 if ( $instance === null ) {
 291                         $instance = new self;
 292                 }
 293                 return $instance;
 294         }
 295
 296         /**
 297          * Create a new extraneous context. The context is filled with information
 298          * external to the current session.
 299          * - Title is specified by argument
 300          * - Request is a FauxRequest, or a FauxRequest can be specified by argument
 301          * - User is an anonymous user, for separation IPv4 localhost is used
 302          * - Language will be based on the anonymous user and request, may be content
 303          *   language or a uselang param in the fauxrequest data may change the lang
 304          * - Skin will be based on the anonymous user, should be the wiki's default skin
 305          *
 306          * @param $title Title Title to use for the extraneous request
 307          * @param $request Mixed A WebRequest or data to use for a FauxRequest
 308          * @return RequestContext
 309          */
 310         public static function newExtraneousContext( Title $title, $request=array() ) {
 311                 $context = new self;
 312                 $context->setTitle( $title );
 313                 if ( $request instanceof WebRequest ) {
 314                         $context->setRequest( $request );
 315                 } else {
 316                         $context->setRequest( new FauxRequest( $request ) );
 317                 }
 318                 $context->user = User::newFromName( '127.0.0.1', false );
 319                 return $context;
 320         }
 321
 322 }
 323