3 * Context for ResourceLoader modules.
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.
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.
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
21 * @author Trevor Parscal
22 * @author Roan Kattouw
25 use MediaWiki\Logger\LoggerFactory
;
26 use MediaWiki\MediaWikiServices
;
29 * Object passed around to modules which contains information about the state
30 * of a specific loader request.
32 class ResourceLoaderContext
implements MessageLocalizer
{
33 protected $resourceLoader;
37 // Module content vary
43 // Request vary (in addition to cache vary)
58 * @param ResourceLoader $resourceLoader
59 * @param WebRequest $request
61 public function __construct( ResourceLoader
$resourceLoader, WebRequest
$request ) {
62 $this->resourceLoader
= $resourceLoader;
63 $this->request
= $request;
64 $this->logger
= $resourceLoader->getLogger();
66 // Future developers: Use WebRequest::getRawVal() instead getVal().
67 // The getVal() method performs slow Language+UTF logic. (f303bb9360)
70 $modules = $request->getRawVal( 'modules' );
71 $this->modules
= $modules ? self
::expandModuleNames( $modules ) : [];
74 $this->user
= $request->getRawVal( 'user' );
75 $this->debug
= $request->getFuzzyBool(
77 $this->getConfig()->get( 'ResourceLoaderDebug' )
79 $this->only
= $request->getRawVal( 'only', null );
80 $this->version
= $request->getRawVal( 'version', null );
81 $this->raw
= $request->getFuzzyBool( 'raw' );
84 $this->image
= $request->getRawVal( 'image' );
85 $this->variant
= $request->getRawVal( 'variant' );
86 $this->format
= $request->getRawVal( 'format' );
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
= $this->getConfig()->get( 'DefaultSkin' );
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' ]`.
101 * This process is reversed by ResourceLoader::makePackedModulesString().
103 * @param string $modules Packed module name list
104 * @return array Array of module names
106 public static function expandModuleNames( $modules ) {
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
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 ) );
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";
134 * Return a dummy ResourceLoaderContext object suitable for passing into
135 * things that don't "really" need a context.
138 * - Creating html5shiv script tag in OutputPage.
139 * - FileModule::readStyleFiles (deprecated, to be removed).
140 * - Unit tests (deprecated, create empty instance directly or use RLTestCase).
142 * @return ResourceLoaderContext
144 public static function newDummyContext() {
145 // This currently creates a non-empty instance of ResourceLoader (all modules registered),
146 // but that's probably not needed. So once that moves into ServiceWiring, this'll
147 // become more like the EmptyResourceLoader class we have in PHPUnit tests, which
148 // is what this should've had originally. If this turns out to be untrue, change to:
149 // `MediaWikiServices::getInstance()->getResourceLoader()` instead.
150 return new self( new ResourceLoader(
151 MediaWikiServices
::getInstance()->getMainConfig(),
152 LoggerFactory
::getInstance( 'resourceloader' )
153 ), new FauxRequest( [] ) );
157 * @return ResourceLoader
159 public function getResourceLoader() {
160 return $this->resourceLoader
;
166 public function getConfig() {
167 return $this->getResourceLoader()->getConfig();
173 public function getRequest() {
174 return $this->request
;
179 * @return \Psr\Log\LoggerInterface
181 public function getLogger() {
182 return $this->logger
;
188 public function getModules() {
189 return $this->modules
;
195 public function getLanguage() {
196 if ( $this->language
=== null ) {
197 // Must be a valid language code after this point (T64849)
198 // Only support uselang values that follow built-in conventions (T102058)
199 $lang = $this->getRequest()->getRawVal( 'lang', '' );
200 // Stricter version of RequestContext::sanitizeLangCode()
201 if ( !Language
::isValidBuiltInCode( $lang ) ) {
202 $lang = $this->getConfig()->get( 'LanguageCode' );
204 $this->language
= $lang;
206 return $this->language
;
212 public function getDirection() {
213 if ( $this->direction
=== null ) {
214 $this->direction
= $this->getRequest()->getRawVal( 'dir' );
215 if ( !$this->direction
) {
216 // Determine directionality based on user language (T8100)
217 $this->direction
= Language
::factory( $this->getLanguage() )->getDir();
220 return $this->direction
;
226 public function getSkin() {
231 * @return string|null
233 public function getUser() {
238 * Get a Message object with context set. See wfMessage for parameters.
241 * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
242 * or a MessageSpecifier.
243 * @param mixed $args,...
246 public function msg( $key ) {
247 return wfMessage( ...func_get_args() )
248 ->inLanguage( $this->getLanguage() )
249 // Use a dummy title because there is no real title
250 // for this endpoint, and the cache won't vary on it
252 ->title( Title
::newFromText( 'Dwimmerlaik' ) );
256 * Get the possibly-cached User object for the specified username
261 public function getUserObj() {
262 if ( $this->userObj
=== null ) {
263 $username = $this->getUser();
265 // Use provided username if valid, fallback to anonymous user
266 $this->userObj
= User
::newFromName( $username ) ?
: new User
;
269 $this->userObj
= new User
;
273 return $this->userObj
;
279 public function getDebug() {
284 * @return string|null
286 public function getOnly() {
291 * @see ResourceLoaderModule::getVersionHash
292 * @see ResourceLoaderClientHtml::makeLoad
293 * @return string|null
295 public function getVersion() {
296 return $this->version
;
302 public function getRaw() {
307 * @return string|null
309 public function getImage() {
314 * @return string|null
316 public function getVariant() {
317 return $this->variant
;
321 * @return string|null
323 public function getFormat() {
324 return $this->format
;
328 * If this is a request for an image, get the ResourceLoaderImage object.
331 * @return ResourceLoaderImage|bool false if a valid object cannot be created
333 public function getImageObj() {
334 if ( $this->imageObj
=== null ) {
335 $this->imageObj
= false;
337 if ( !$this->image
) {
338 return $this->imageObj
;
341 $modules = $this->getModules();
342 if ( count( $modules ) !== 1 ) {
343 return $this->imageObj
;
346 $module = $this->getResourceLoader()->getModule( $modules[0] );
347 if ( !$module ||
!$module instanceof ResourceLoaderImageModule
) {
348 return $this->imageObj
;
351 $image = $module->getImage( $this->image
, $this );
353 return $this->imageObj
;
356 $this->imageObj
= $image;
359 return $this->imageObj
;
363 * Return the replaced-content mapping callback
365 * When editing a page that's used to generate the scripts or styles of a
366 * ResourceLoaderWikiModule, a preview should use the to-be-saved version of
367 * the page rather than the current version in the database. A context
368 * supporting such previews should return a callback to return these
372 * @return callable|null Signature is `Content|null func( Title $t )`
374 public function getContentOverrideCallback() {
381 public function shouldIncludeScripts() {
382 return $this->getOnly() === null ||
$this->getOnly() === 'scripts';
388 public function shouldIncludeStyles() {
389 return $this->getOnly() === null ||
$this->getOnly() === 'styles';
395 public function shouldIncludeMessages() {
396 return $this->getOnly() === null;
400 * All factors that uniquely identify this request, except 'modules'.
402 * The list of modules is excluded here for legacy reasons as most callers already
403 * split up handling of individual modules. Including it here would massively fragment
404 * the cache and decrease its usefulness.
406 * E.g. Used by RequestFileCache to form a cache key for storing the reponse output.
410 public function getHash() {
411 if ( !isset( $this->hash
) ) {
412 $this->hash
= implode( '|', [
413 // Module content vary
414 $this->getLanguage(),