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          * @param $code string
 150          * @return string
 151          */
 152         public static function sanitizeLangCode( $code ) {
 153                 global $wgLanguageCode;
 154
 155                 // BCP 47 - letter case MUST NOT carry meaning
 156                 $code = strtolower( $code );
 157
 158                 # Validate $code
 159                 if( empty( $code ) || !Language::isValidCode( $code ) || ( $code === 'qqq' ) ) {
 160                         wfDebug( "Invalid user language code\n" );
 161                         $code = $wgLanguageCode;
 162                 }
 163
 164                 return $code;
 165         }
 166
 167         /**
 168          * Set the Language object
 169          *
 170          * @deprecated 1.19 Use setLanguage instead
 171          * @param $l Mixed Language instance or language code
 172          */
 173         public function setLang( $l ) {
 174                 wfDeprecated( __METHOD__, '1.19' );
 175                 $this->setLanguage( $l );
 176         }
 177
 178         /**
 179          * Set the Language object
 180          *
 181          * @param $l Mixed Language instance or language code
 182          * @since 1.19
 183          */
 184         public function setLanguage( $l ) {
 185                 if ( $l instanceof Language ) {
 186                         $this->lang = $l;
 187                 } elseif ( is_string( $l ) ) {
 188                         $l = self::sanitizeLangCode( $l );
 189                         $obj = Language::factory( $l );
 190                         $this->lang = $obj;
 191                 } else {
 192                         throw new MWException( __METHOD__ . " was passed an invalid type of data." );
 193                 }
 194         }
 195
 196         /**
 197          * @deprecated 1.19 Use getLanguage instead
 198          * @return Language
 199          */
 200         public function getLang() {
 201                 wfDeprecated( __METHOD__, '1.19' );
 202                 return $this->getLanguage();
 203         }
 204
 205         /**
 206          * Get the Language object
 207          *
 208          * @return Language
 209          * @since 1.19
 210          */
 211         public function getLanguage() {
 212                 if ( $this->lang === null ) {
 213                         global $wgLanguageCode, $wgContLang;
 214                         $code = $this->getRequest()->getVal(
 215                                 'uselang',
 216                                 $this->getUser()->getOption( 'language' )
 217                         );
 218                         $code = self::sanitizeLangCode( $code );
 219
 220                         wfRunHooks( 'UserGetLanguageObject', array( $this->getUser(), &$code ) );
 221
 222                         if( $code === $wgLanguageCode ) {
 223                                 $this->lang = $wgContLang;
 224                         } else {
 225                                 $obj = Language::factory( $code );
 226                                 $this->lang = $obj;
 227                         }
 228                 }
 229                 return $this->lang;
 230         }
 231
 232         /**
 233          * Set the Skin object
 234          *
 235          * @param $s Skin
 236          */
 237         public function setSkin( Skin $s ) {
 238                 $this->skin = clone $s;
 239                 $this->skin->setContext( $this );
 240         }
 241
 242         /**
 243          * Get the Skin object
 244          *
 245          * @return Skin
 246          */
 247         public function getSkin() {
 248                 if ( $this->skin === null ) {
 249                         wfProfileIn( __METHOD__ . '-createskin' );
 250
 251                         $skin = null;
 252                         wfRunHooks( 'RequestContextCreateSkin', array( $this, &$skin ) );
 253
 254                         // If the hook worked try to set a skin from it
 255                         if ( $skin instanceof Skin ) {
 256                                 $this->skin = $skin;
 257                         } elseif ( is_string($skin) ) {
 258                                 $this->skin = Skin::newFromKey( $skin );
 259                         }
 260
 261                         // If this is still null (the hook didn't run or didn't work)
 262                         // then go through the normal processing to load a skin
 263                         if ( $this->skin === null ) {
 264                                 global $wgHiddenPrefs;
 265                                 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
 266                                         # get the user skin
 267                                         $userSkin = $this->getUser()->getOption( 'skin' );
 268                                         $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
 269                                 } else {
 270                                         # if we're not allowing users to override, then use the default
 271                                         global $wgDefaultSkin;
 272                                         $userSkin = $wgDefaultSkin;
 273                                 }
 274
 275                                 $this->skin = Skin::newFromKey( $userSkin );
 276                         }
 277
 278                         // After all that set a context on whatever skin got created
 279                         $this->skin->setContext( $this );
 280                         wfProfileOut( __METHOD__ . '-createskin' );
 281                 }
 282                 return $this->skin;
 283         }
 284
 285         /** Helpful methods **/
 286
 287         /**
 288          * Get a Message object with context set
 289          * Parameters are the same as wfMessage()
 290          *
 291          * @return Message object
 292          */
 293         public function msg() {
 294                 $args = func_get_args();
 295                 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
 296         }
 297
 298         /** Static methods **/
 299
 300         /**
 301          * Get the RequestContext object associated with the main request
 302          *
 303          * @return RequestContext object
 304          */
 305         public static function getMain() {
 306                 static $instance = null;
 307                 if ( $instance === null ) {
 308                         $instance = new self;
 309                 }
 310                 return $instance;
 311         }
 312
 313         /**
 314          * Create a new extraneous context. The context is filled with information
 315          * external to the current session.
 316          * - Title is specified by argument
 317          * - Request is a FauxRequest, or a FauxRequest can be specified by argument
 318          * - User is an anonymous user, for separation IPv4 localhost is used
 319          * - Language will be based on the anonymous user and request, may be content
 320          *   language or a uselang param in the fauxrequest data may change the lang
 321          * - Skin will be based on the anonymous user, should be the wiki's default skin
 322          *
 323          * @param $title Title Title to use for the extraneous request
 324          * @param $request Mixed A WebRequest or data to use for a FauxRequest
 325          * @return RequestContext
 326          */
 327         public static function newExtraneousContext( Title $title, $request=array() ) {
 328                 $context = new self;
 329                 $context->setTitle( $title );
 330                 if ( $request instanceof WebRequest ) {
 331                         $context->setRequest( $request );
 332                 } else {
 333                         $context->setRequest( new FauxRequest( $request ) );
 334                 }
 335                 $context->user = User::newFromName( '127.0.0.1', false );
 336                 return $context;
 337         }
 338
 339 }
 340