3 * Request-dependant objects containers.
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.
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.
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
22 * @author Alexandre Emsenhuber
23 * @author Daniel Friesen
28 * Group all the pieces relevant to the context of a request into one instance
30 class RequestContext
implements IContextSource
{
63 * Set the WebRequest object
65 * @param $r WebRequest object
67 public function setRequest( WebRequest
$r ) {
72 * Get the WebRequest object
76 public function getRequest() {
77 if ( $this->request
=== null ) {
78 global $wgRequest; # fallback to $wg till we can improve this
79 $this->request
= $wgRequest;
81 return $this->request
;
85 * Set the Title object
87 * @param $t Title object
89 public function setTitle( Title
$t ) {
94 * Get the Title object
98 public function getTitle() {
99 if ( $this->title
=== null ) {
100 global $wgTitle; # fallback to $wg till we can improve this
101 $this->title
= $wgTitle;
107 * @param $o OutputPage
109 public function setOutput( OutputPage
$o ) {
114 * Get the OutputPage object
116 * @return OutputPage object
118 public function getOutput() {
119 if ( $this->output
=== null ) {
120 $this->output
= new OutputPage( $this );
122 return $this->output
;
126 * Set the User object
130 public function setUser( User
$u ) {
135 * Get the User object
139 public function getUser() {
140 if ( $this->user
=== null ) {
141 $this->user
= User
::newFromSession( $this->getRequest() );
147 * Accepts a language code and ensures it's sane. Outputs a cleaned up language
148 * code and replaces with $wgLanguageCode if not sane.
151 static function sanitizeLangCode( $code ) {
152 global $wgLanguageCode;
154 // BCP 47 - letter case MUST NOT carry meaning
155 $code = strtolower( $code );
158 if( empty( $code ) ||
!Language
::isValidCode( $code ) ||
( $code === 'qqq' ) ) {
159 wfDebug( "Invalid user language code\n" );
160 $code = $wgLanguageCode;
167 * Set the Language object
169 * @deprecated 1.19 Use setLanguage instead
170 * @param $l Mixed Language instance or language code
172 public function setLang( $l ) {
173 wfDeprecated( __METHOD__
, '1.19' );
174 $this->setLanguage( $l );
178 * Set the Language object
180 * @param $l Mixed Language instance or language code
183 public function setLanguage( $l ) {
184 if ( $l instanceof Language
) {
186 } elseif ( is_string( $l ) ) {
187 $l = self
::sanitizeLangCode( $l );
188 $obj = Language
::factory( $l );
191 throw new MWException( __METHOD__
. " was passed an invalid type of data." );
196 * @deprecated 1.19 Use getLanguage instead
199 public function getLang() {
200 wfDeprecated( __METHOD__
, '1.19' );
201 return $this->getLanguage();
205 * Get the Language object
210 public function getLanguage() {
211 if ( $this->lang
=== null ) {
212 global $wgLanguageCode, $wgContLang;
213 $code = $this->getRequest()->getVal(
215 $this->getUser()->getOption( 'language' )
217 $code = self
::sanitizeLangCode( $code );
219 wfRunHooks( 'UserGetLanguageObject', array( $this->getUser(), &$code ) );
221 if( $code === $wgLanguageCode ) {
222 $this->lang
= $wgContLang;
224 $obj = Language
::factory( $code );
232 * Set the Skin object
236 public function setSkin( Skin
$s ) {
237 $this->skin
= clone $s;
238 $this->skin
->setContext( $this );
242 * Get the Skin object
246 public function getSkin() {
247 if ( $this->skin
=== null ) {
248 wfProfileIn( __METHOD__
. '-createskin' );
250 global $wgHiddenPrefs;
251 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
253 $userSkin = $this->getUser()->getOption( 'skin' );
254 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
256 # if we're not allowing users to override, then use the default
257 global $wgDefaultSkin;
258 $userSkin = $wgDefaultSkin;
261 $this->skin
= Skin
::newFromKey( $userSkin );
262 $this->skin
->setContext( $this );
263 wfProfileOut( __METHOD__
. '-createskin' );
268 /** Helpful methods **/
271 * Get a Message object with context set
272 * Parameters are the same as wfMessage()
274 * @return Message object
276 public function msg() {
277 $args = func_get_args();
278 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
281 /** Static methods **/
284 * Get the RequestContext object associated with the main request
286 * @return RequestContext object
288 public static function getMain() {
289 static $instance = null;
290 if ( $instance === null ) {
291 $instance = new self
;
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
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
310 public static function newExtraneousContext( Title
$title, $request=array() ) {
312 $context->setTitle( $title );
313 if ( $request instanceof WebRequest
) {
314 $context->setRequest( $request );
316 $context->setRequest( new FauxRequest( $request ) );
318 $context->user
= User
::newFromName( '127.0.0.1', false );