RequestContext.php

Go to the documentation of this file.

<?php
class RequestContext implements IContextSource {

        private $request;

        private $title;

        private $wikipage;

        private $output;

        private $user;

        private $lang;

        private $skin;

        public function setRequest( WebRequest $r ) {
                $this->request = $r;
        }

        public function getRequest() {
                if ( $this->request === null ) {
                        global $wgRequest; # fallback to $wg till we can improve this
                        $this->request = $wgRequest;
                }
                return $this->request;
        }

        public function setTitle( Title $t ) {
                $this->title = $t;
                // Erase the WikiPage so a new one with the new title gets created.
                $this->wikipage = null;
        }

        public function getTitle() {
                if ( $this->title === null ) {
                        global $wgTitle; # fallback to $wg till we can improve this
                        $this->title = $wgTitle;
                }
                return $this->title;
        }

        public function canUseWikiPage() {
                if ( $this->wikipage !== null ) {
                        # If there's a WikiPage object set, we can for sure get it
                        return true;
                }
                $title = $this->getTitle();
                if ( $title === null ) {
                        # No Title, no WikiPage
                        return false;
                } else {
                        # Only namespaces whose pages are stored in the database can have WikiPage
                        return $title->canExist();
                }
        }

        public function setWikiPage( WikiPage $p ) {
                $contextTitle = $this->getTitle();
                $pageTitle = $p->getTitle();
                if ( !$contextTitle || !$pageTitle->equals( $contextTitle ) ) {
                        $this->setTitle( $pageTitle );
                }
                // Defer this to the end since setTitle sets it to null.
                $this->wikipage = $p;
        }

        public function getWikiPage() {
                if ( $this->wikipage === null ) {
                        $title = $this->getTitle();
                        if ( $title === null ) {
                                throw new MWException( __METHOD__ . ' called without Title object set' );
                        }
                        $this->wikipage = WikiPage::factory( $title );
                }
                return $this->wikipage;
        }

        public function setOutput( OutputPage $o ) {
                $this->output = $o;
        }

        public function getOutput() {
                if ( $this->output === null ) {
                        $this->output = new OutputPage( $this );
                }
                return $this->output;
        }

        public function setUser( User $u ) {
                $this->user = $u;
        }

        public function getUser() {
                if ( $this->user === null ) {
                        $this->user = User::newFromSession( $this->getRequest() );
                }
                return $this->user;
        }

        public static function sanitizeLangCode( $code ) {
                global $wgLanguageCode;

                // BCP 47 - letter case MUST NOT carry meaning
                $code = strtolower( $code );

                # Validate $code
                if( empty( $code ) || !Language::isValidCode( $code ) || ( $code === 'qqq' ) ) {
                        wfDebug( "Invalid user language code\n" );
                        $code = $wgLanguageCode;
                }

                return $code;
        }

        public function setLang( $l ) {
                wfDeprecated( __METHOD__, '1.19' );
                $this->setLanguage( $l );
        }

        public function setLanguage( $l ) {
                if ( $l instanceof Language ) {
                        $this->lang = $l;
                } elseif ( is_string( $l ) ) {
                        $l = self::sanitizeLangCode( $l );
                        $obj = Language::factory( $l );
                        $this->lang = $obj;
                } else {
                        throw new MWException( __METHOD__ . " was passed an invalid type of data." );
                }
        }

        public function getLang() {
                wfDeprecated( __METHOD__, '1.19' );
                return $this->getLanguage();
        }

        public function getLanguage() {
                if ( $this->lang === null ) {
                        global $wgLanguageCode, $wgContLang;
                        $code = $this->getRequest()->getVal(
                                'uselang',
                                $this->getUser()->getOption( 'language' )
                        );
                        $code = self::sanitizeLangCode( $code );

                        wfRunHooks( 'UserGetLanguageObject', array( $this->getUser(), &$code ) );

                        if( $code === $wgLanguageCode ) {
                                $this->lang = $wgContLang;
                        } else {
                                $obj = Language::factory( $code );
                                $this->lang = $obj;
                        }
                }
                return $this->lang;
        }

        public function setSkin( Skin $s ) {
                $this->skin = clone $s;
                $this->skin->setContext( $this );
        }

        public function getSkin() {
                if ( $this->skin === null ) {
                        wfProfileIn( __METHOD__ . '-createskin' );

                        $skin = null;
                        wfRunHooks( 'RequestContextCreateSkin', array( $this, &$skin ) );

                        // If the hook worked try to set a skin from it
                        if ( $skin instanceof Skin ) {
                                $this->skin = $skin;
                        } elseif ( is_string($skin) ) {
                                $this->skin = Skin::newFromKey( $skin );
                        }

                        // If this is still null (the hook didn't run or didn't work)
                        // then go through the normal processing to load a skin
                        if ( $this->skin === null ) {
                                global $wgHiddenPrefs;
                                if( !in_array( 'skin', $wgHiddenPrefs ) ) {
                                        # get the user skin
                                        $userSkin = $this->getUser()->getOption( 'skin' );
                                        $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
                                } else {
                                        # if we're not allowing users to override, then use the default
                                        global $wgDefaultSkin;
                                        $userSkin = $wgDefaultSkin;
                                }

                                $this->skin = Skin::newFromKey( $userSkin );
                        }

                        // After all that set a context on whatever skin got created
                        $this->skin->setContext( $this );
                        wfProfileOut( __METHOD__ . '-createskin' );
                }
                return $this->skin;
        }

        public function msg() {
                $args = func_get_args();
                return call_user_func_array( 'wfMessage', $args )->setContext( $this );
        }

        public static function getMain() {
                static $instance = null;
                if ( $instance === null ) {
                        $instance = new self;
                }
                return $instance;
        }

        public static function newExtraneousContext( Title $title, $request=array() ) {
                $context = new self;
                $context->setTitle( $title );
                if ( $request instanceof WebRequest ) {
                        $context->setRequest( $request );
                } else {
                        $context->setRequest( new FauxRequest( $request ) );
                }
                $context->user = User::newFromName( '127.0.0.1', false );
                return $context;
        }

}