MediaWiki REL1_32
ResourceLoaderContext.php
Go to the documentation of this file.
1<?php
27
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
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
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
138 public static function newDummyContext() {
139 return new self( new ResourceLoader(
140 MediaWikiServices::getInstance()->getMainConfig(),
141 LoggerFactory::getInstance( 'resourceloader' )
142 ), new FauxRequest( [] ) );
143 }
144
148 public function getResourceLoader() {
150 }
151
155 public function getRequest() {
156 return $this->request;
157 }
158
163 public function getLogger() {
164 return $this->logger;
165 }
166
170 public function getModules() {
171 return $this->modules;
172 }
173
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
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
208 public function getSkin() {
209 return $this->skin;
210 }
211
215 public function getUser() {
216 return $this->user;
217 }
218
228 public function msg( $key ) {
229 return 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
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
261 public function getDebug() {
262 return $this->debug;
263 }
264
268 public function getOnly() {
269 return $this->only;
270 }
271
277 public function getVersion() {
278 return $this->version;
279 }
280
284 public function getRaw() {
285 return $this->raw;
286 }
287
291 public function getImage() {
292 return $this->image;
293 }
294
298 public function getVariant() {
299 return $this->variant;
300 }
301
305 public function getFormat() {
306 return $this->format;
307 }
308
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
356 public function getContentOverrideCallback() {
357 return null;
358 }
359
363 public function shouldIncludeScripts() {
364 return $this->getOnly() === null || $this->getOnly() === 'scripts';
365 }
366
370 public function shouldIncludeStyles() {
371 return $this->getOnly() === null || $this->getOnly() === 'styles';
372 }
373
377 public function shouldIncludeMessages() {
378 return $this->getOnly() === null;
379 }
380
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}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
WebRequest clone which takes values from a provided array.
PSR-3 logger instance factory.
MediaWikiServices is the service locator for the application scope of MediaWiki.
Object passed around to modules which contains information about the state of a specific loader reque...
__construct(ResourceLoader $resourceLoader, WebRequest $request)
getImageObj()
If this is a request for an image, get the ResourceLoaderImage object.
msg( $key)
Get a Message object with context set.
getUserObj()
Get the possibly-cached User object for the specified username.
getHash()
All factors that uniquely identify this request, except 'modules'.
static newDummyContext()
Return a dummy ResourceLoaderContext object suitable for passing into things that don't "really" need...
static expandModuleNames( $modules)
Expand a string of the form jquery.foo,bar|jquery.ui.baz,quux to an array of module names like ‘[ 'jq...
getContentOverrideCallback()
Return the replaced-content mapping callback.
ResourceLoader module for generated and embedded images.
Dynamic JavaScript and CSS resource loading system.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:592
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account incomplete not yet checked for validity & $retval
Definition hooks.txt:266
returning false will NOT prevent logging a wrapping ErrorException instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment this hook should only be used to add variables that depend on the current page request
Definition hooks.txt:2274
if the prop value should be in the metadata multi language array format
Definition hooks.txt:1690
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
this hook is for auditing only or null if authentication failed before getting that far $username
Definition hooks.txt:815
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Interface for localizing messages in MediaWiki.
Prior to version
if(!isset( $args[0])) $lang