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 array( '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 ) ); // array( '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                                 global $wgLanguageCode;
 179                                 $lang = $wgLanguageCode;
 180                         }
 181                         $this->language = $lang;
 182                 }
 183                 return $this->language;
 184         }
 185
 186         /**
 187          * @return string
 188          */
 189         public function getDirection() {
 190                 if ( $this->direction === null ) {
 191                         $this->direction = $this->getRequest()->getVal( 'dir' );
 192                         if ( !$this->direction ) {
 193                                 // Determine directionality based on user language (bug 6100)
 194                                 $this->direction = Language::factory( $this->getLanguage() )->getDir();
 195                         }
 196                 }
 197                 return $this->direction;
 198         }
 199
 200         /**
 201          * @return string
 202          */
 203         public function getSkin() {
 204                 return $this->skin;
 205         }
 206
 207         /**
 208          * @return string|null
 209          */
 210         public function getUser() {
 211                 return $this->user;
 212         }
 213
 214         /**
 215          * Get a Message object with context set.  See wfMessage for parameters.
 216          *
 217          * @since 1.27
 218          * @param mixed ...
 219          * @return Message
 220          */
 221         public function msg() {
 222                 return call_user_func_array( 'wfMessage', func_get_args() )
 223                         ->inLanguage( $this->getLanguage() );
 224         }
 225
 226         /**
 227          * Get the possibly-cached User object for the specified username
 228          *
 229          * @since 1.25
 230          * @return User
 231          */
 232         public function getUserObj() {
 233                 if ( $this->userObj === null ) {
 234                         $username = $this->getUser();
 235                         if ( $username ) {
 236                                 // Use provided username if valid, fallback to anonymous user
 237                                 $this->userObj = User::newFromName( $username ) ?: new User;
 238                         } else {
 239                                 // Anonymous user
 240                                 $this->userObj = new User;
 241                         }
 242                 }
 243
 244                 return $this->userObj;
 245         }
 246
 247         /**
 248          * @return bool
 249          */
 250         public function getDebug() {
 251                 return $this->debug;
 252         }
 253
 254         /**
 255          * @return string|null
 256          */
 257         public function getOnly() {
 258                 return $this->only;
 259         }
 260
 261         /**
 262          * @see ResourceLoaderModule::getVersionHash
 263          * @see OutputPage::makeResourceLoaderLink
 264          * @return string|null
 265          */
 266         public function getVersion() {
 267                 return $this->version;
 268         }
 269
 270         /**
 271          * @return bool
 272          */
 273         public function getRaw() {
 274                 return $this->raw;
 275         }
 276
 277         /**
 278          * @return string|null
 279          */
 280         public function getImage() {
 281                 return $this->image;
 282         }
 283
 284         /**
 285          * @return string|null
 286          */
 287         public function getVariant() {
 288                 return $this->variant;
 289         }
 290
 291         /**
 292          * @return string|null
 293          */
 294         public function getFormat() {
 295                 return $this->format;
 296         }
 297
 298         /**
 299          * If this is a request for an image, get the ResourceLoaderImage object.
 300          *
 301          * @since 1.25
 302          * @return ResourceLoaderImage|bool false if a valid object cannot be created
 303          */
 304         public function getImageObj() {
 305                 if ( $this->imageObj === null ) {
 306                         $this->imageObj = false;
 307
 308                         if ( !$this->image ) {
 309                                 return $this->imageObj;
 310                         }
 311
 312                         $modules = $this->getModules();
 313                         if ( count( $modules ) !== 1 ) {
 314                                 return $this->imageObj;
 315                         }
 316
 317                         $module = $this->getResourceLoader()->getModule( $modules[0] );
 318                         if ( !$module || !$module instanceof ResourceLoaderImageModule ) {
 319                                 return $this->imageObj;
 320                         }
 321
 322                         $image = $module->getImage( $this->image, $this );
 323                         if ( !$image ) {
 324                                 return $this->imageObj;
 325                         }
 326
 327                         $this->imageObj = $image;
 328                 }
 329
 330                 return $this->imageObj;
 331         }
 332
 333         /**
 334          * @return bool
 335          */
 336         public function shouldIncludeScripts() {
 337                 return $this->getOnly() === null || $this->getOnly() === 'scripts';
 338         }
 339
 340         /**
 341          * @return bool
 342          */
 343         public function shouldIncludeStyles() {
 344                 return $this->getOnly() === null || $this->getOnly() === 'styles';
 345         }
 346
 347         /**
 348          * @return bool
 349          */
 350         public function shouldIncludeMessages() {
 351                 return $this->getOnly() === null;
 352         }
 353
 354         /**
 355          * All factors that uniquely identify this request, except 'modules'.
 356          *
 357          * The list of modules is excluded here for legacy reasons as most callers already
 358          * split up handling of individual modules. Including it here would massively fragment
 359          * the cache and decrease its usefulness.
 360          *
 361          * E.g. Used by RequestFileCache to form a cache key for storing the reponse output.
 362          *
 363          * @return string
 364          */
 365         public function getHash() {
 366                 if ( !isset( $this->hash ) ) {
 367                         $this->hash = implode( '|', [
 368                                 // Module content vary
 369                                 $this->getLanguage(),
 370                                 $this->getSkin(),
 371                                 $this->getDebug(),
 372                                 $this->getUser(),
 373                                 // Request vary
 374                                 $this->getOnly(),
 375                                 $this->getVersion(),
 376                                 $this->getRaw(),
 377                                 $this->getImage(),
 378                                 $this->getVariant(),
 379                                 $this->getFormat(),
 380                         ] );
 381                 }
 382                 return $this->hash;
 383         }
 384 }