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