includes/resourceloader/ResourceLoaderContext.php

   1 <?php
   2 /**
   3  * Context for ResourceLoader modules.
   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  * @file
  21  * @author Trevor Parscal
  22  * @author Roan Kattouw
  23  */
  24
  25 use MediaWiki\Logger\LoggerFactory;
  26
  27 /**
  28  * Object passed around to modules which contains information about the state
  29  * of a specific loader request
  30  */
  31 class ResourceLoaderContext {
  32         protected $resourceLoader;
  33         protected $request;
  34         protected $logger;
  35
  36         // Module content vary
  37         protected $skin;
  38         protected $language;
  39         protected $debug;
  40         protected $user;
  41
  42         // Request vary (in addition to cache vary)
  43         protected $modules;
  44         protected $only;
  45         protected $version;
  46         protected $raw;
  47         protected $image;
  48         protected $variant;
  49         protected $format;
  50
  51         protected $direction;
  52         protected $hash;
  53         protected $userObj;
  54         protected $imageObj;
  55
  56         /**
  57          * @param ResourceLoader $resourceLoader
  58          * @param WebRequest $request
  59          */
  60         public function __construct( ResourceLoader $resourceLoader, WebRequest $request ) {
  61                 $this->resourceLoader = $resourceLoader;
  62                 $this->request = $request;
  63                 $this->logger = $resourceLoader->getLogger();
  64
  65                 // List of modules
  66                 $modules = $request->getVal( 'modules' );
  67                 $this->modules = $modules ? self::expandModuleNames( $modules ) : [];
  68
  69                 // Various parameters
  70                 $this->user = $request->getVal( 'user' );
  71                 $this->debug = $request->getFuzzyBool(
  72                         'debug',
  73                         $resourceLoader->getConfig()->get( 'ResourceLoaderDebug' )
  74                 );
  75                 $this->only = $request->getVal( 'only', null );
  76                 $this->version = $request->getVal( 'version', null );
  77                 $this->raw = $request->getFuzzyBool( 'raw' );
  78
  79                 // Image requests
  80                 $this->image = $request->getVal( 'image' );
  81                 $this->variant = $request->getVal( 'variant' );
  82                 $this->format = $request->getVal( 'format' );
  83
  84                 $this->skin = $request->getVal( 'skin' );
  85                 $skinnames = Skin::getSkinNames();
  86                 // If no skin is specified, or we don't recognize the skin, use the default skin
  87                 if ( !$this->skin || !isset( $skinnames[$this->skin] ) ) {
  88                         $this->skin = $resourceLoader->getConfig()->get( 'DefaultSkin' );
  89                 }
  90         }
  91
  92         /**
  93          * Expand a string of the form jquery.foo,bar|jquery.ui.baz,quux to
  94          * an array of module names like [ 'jquery.foo', 'jquery.bar',
  95          * 'jquery.ui.baz', 'jquery.ui.quux' ]
  96          * @param string $modules Packed module name list
  97          * @return array Array of module names
  98          */
  99         public static function expandModuleNames( $modules ) {
 100                 $retval = [];
 101                 $exploded = explode( '|', $modules );
 102                 foreach ( $exploded as $group ) {
 103                         if ( strpos( $group, ',' ) === false ) {
 104                                 // This is not a set of modules in foo.bar,baz notation
 105                                 // but a single module
 106                                 $retval[] = $group;
 107                         } else {
 108                                 // This is a set of modules in foo.bar,baz notation
 109                                 $pos = strrpos( $group, '.' );
 110                                 if ( $pos === false ) {
 111                                         // Prefixless modules, i.e. without dots
 112                                         $retval = array_merge( $retval, explode( ',', $group ) );
 113                                 } else {
 114                                         // We have a prefix and a bunch of suffixes
 115                                         $prefix = substr( $group, 0, $pos ); // 'foo'
 116                                         $suffixes = explode( ',', substr( $group, $pos + 1 ) ); // [ 'bar', 'baz' ]
 117                                         foreach ( $suffixes as $suffix ) {
 118                                                 $retval[] = "$prefix.$suffix";
 119                                         }
 120                                 }
 121                         }
 122                 }
 123                 return $retval;
 124         }
 125
 126         /**
 127          * Return a dummy ResourceLoaderContext object suitable for passing into
 128          * things that don't "really" need a context.
 129          * @return ResourceLoaderContext
 130          */
 131         public static function newDummyContext() {
 132                 return new self( new ResourceLoader(
 133                         ConfigFactory::getDefaultInstance()->makeConfig( 'main' ),
 134                         LoggerFactory::getInstance( 'resourceloader' )
 135                 ), new FauxRequest( [] ) );
 136         }
 137
 138         /**
 139          * @return ResourceLoader
 140          */
 141         public function getResourceLoader() {
 142                 return $this->resourceLoader;
 143         }
 144
 145         /**
 146          * @return WebRequest
 147          */
 148         public function getRequest() {
 149                 return $this->request;
 150         }
 151
 152         /**
 153          * @since 1.27
 154          * @return \Psr\Log\LoggerInterface
 155          */
 156         public function getLogger() {
 157                 return $this->logger;
 158         }
 159
 160         /**
 161          * @return array
 162          */
 163         public function getModules() {
 164                 return $this->modules;
 165         }
 166
 167         /**
 168          * @return string
 169          */
 170         public function getLanguage() {
 171                 if ( $this->language === null ) {
 172                         // Must be a valid language code after this point (T64849)
 173                         // Only support uselang values that follow built-in conventions (T102058)
 174                         $lang = $this->getRequest()->getVal( 'lang', '' );
 175                         // Stricter version of RequestContext::sanitizeLangCode()
 176                         if ( !Language::isValidBuiltInCode( $lang ) ) {
 177                                 wfDebug( "Invalid user language code\n" );
 178                                 $lang = $this->getResourceLoader()->getConfig()->get( 'LanguageCode' );
 179                         }
 180                         $this->language = $lang;
 181                 }
 182                 return $this->language;
 183         }
 184
 185         /**
 186          * @return string
 187          */
 188         public function getDirection() {
 189                 if ( $this->direction === null ) {
 190                         $this->direction = $this->getRequest()->getVal( 'dir' );
 191                         if ( !$this->direction ) {
 192                                 // Determine directionality based on user language (bug 6100)
 193                                 $this->direction = Language::factory( $this->getLanguage() )->getDir();
 194                         }
 195                 }
 196                 return $this->direction;
 197         }
 198
 199         /**
 200          * @return string
 201          */
 202         public function getSkin() {
 203                 return $this->skin;
 204         }
 205
 206         /**
 207          * @return string|null
 208          */
 209         public function getUser() {
 210                 return $this->user;
 211         }
 212
 213         /**
 214          * Get a Message object with context set.  See wfMessage for parameters.
 215          *
 216          * @since 1.27
 217          * @param mixed ...
 218          * @return Message
 219          */
 220         public function msg() {
 221                 return call_user_func_array( 'wfMessage', func_get_args() )
 222                         ->inLanguage( $this->getLanguage() )
 223                         // Use a dummy title because there is no real title
 224                         // for this endpoint, and the cache won't vary on it
 225                         // anyways.
 226                         ->title( Title::newFromText( 'Dwimmerlaik' ) );
 227         }
 228
 229         /**
 230          * Get the possibly-cached User object for the specified username
 231          *
 232          * @since 1.25
 233          * @return User
 234          */
 235         public function getUserObj() {
 236                 if ( $this->userObj === null ) {
 237                         $username = $this->getUser();
 238                         if ( $username ) {
 239                                 // Use provided username if valid, fallback to anonymous user
 240                                 $this->userObj = User::newFromName( $username ) ?: new User;
 241                         } else {
 242                                 // Anonymous user
 243                                 $this->userObj = new User;
 244                         }
 245                 }
 246
 247                 return $this->userObj;
 248         }
 249
 250         /**
 251          * @return bool
 252          */
 253         public function getDebug() {
 254                 return $this->debug;
 255         }
 256
 257         /**
 258          * @return string|null
 259          */
 260         public function getOnly() {
 261                 return $this->only;
 262         }
 263
 264         /**
 265          * @see ResourceLoaderModule::getVersionHash
 266          * @see ResourceLoaderClientHtml::makeLoad
 267          * @return string|null
 268          */
 269         public function getVersion() {
 270                 return $this->version;
 271         }
 272
 273         /**
 274          * @return bool
 275          */
 276         public function getRaw() {
 277                 return $this->raw;
 278         }
 279
 280         /**
 281          * @return string|null
 282          */
 283         public function getImage() {
 284                 return $this->image;
 285         }
 286
 287         /**
 288          * @return string|null
 289          */
 290         public function getVariant() {
 291                 return $this->variant;
 292         }
 293
 294         /**
 295          * @return string|null
 296          */
 297         public function getFormat() {
 298                 return $this->format;
 299         }
 300
 301         /**
 302          * If this is a request for an image, get the ResourceLoaderImage object.
 303          *
 304          * @since 1.25
 305          * @return ResourceLoaderImage|bool false if a valid object cannot be created
 306          */
 307         public function getImageObj() {
 308                 if ( $this->imageObj === null ) {
 309                         $this->imageObj = false;
 310
 311                         if ( !$this->image ) {
 312                                 return $this->imageObj;
 313                         }
 314
 315                         $modules = $this->getModules();
 316                         if ( count( $modules ) !== 1 ) {
 317                                 return $this->imageObj;
 318                         }
 319
 320                         $module = $this->getResourceLoader()->getModule( $modules[0] );
 321                         if ( !$module || !$module instanceof ResourceLoaderImageModule ) {
 322                                 return $this->imageObj;
 323                         }
 324
 325                         $image = $module->getImage( $this->image, $this );
 326                         if ( !$image ) {
 327                                 return $this->imageObj;
 328                         }
 329
 330                         $this->imageObj = $image;
 331                 }
 332
 333                 return $this->imageObj;
 334         }
 335
 336         /**
 337          * @return bool
 338          */
 339         public function shouldIncludeScripts() {
 340                 return $this->getOnly() === null || $this->getOnly() === 'scripts';
 341         }
 342
 343         /**
 344          * @return bool
 345          */
 346         public function shouldIncludeStyles() {
 347                 return $this->getOnly() === null || $this->getOnly() === 'styles';
 348         }
 349
 350         /**
 351          * @return bool
 352          */
 353         public function shouldIncludeMessages() {
 354                 return $this->getOnly() === null;
 355         }
 356
 357         /**
 358          * All factors that uniquely identify this request, except 'modules'.
 359          *
 360          * The list of modules is excluded here for legacy reasons as most callers already
 361          * split up handling of individual modules. Including it here would massively fragment
 362          * the cache and decrease its usefulness.
 363          *
 364          * E.g. Used by RequestFileCache to form a cache key for storing the reponse output.
 365          *
 366          * @return string
 367          */
 368         public function getHash() {
 369                 if ( !isset( $this->hash ) ) {
 370                         $this->hash = implode( '|', [
 371                                 // Module content vary
 372                                 $this->getLanguage(),
 373                                 $this->getSkin(),
 374                                 $this->getDebug(),
 375                                 $this->getUser(),
 376                                 // Request vary
 377                                 $this->getOnly(),
 378                                 $this->getVersion(),
 379                                 $this->getRaw(),
 380                                 $this->getImage(),
 381                                 $this->getVariant(),
 382                                 $this->getFormat(),
 383                         ] );
 384                 }
 385                 return $this->hash;
 386         }
 387 }