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