MediaWiki  master
ResourceLoaderClientHtml.php
Go to the documentation of this file.
1 <?php
23 
30 
32  private $context;
33 
35  private $resourceLoader;
36 
38  private $options;
39 
41  private $config = [];
42 
44  private $modules = [];
45 
47  private $moduleStyles = [];
48 
50  private $exemptStates = [];
51 
53  private $data;
54 
62  public function __construct( ResourceLoaderContext $context, array $options = [] ) {
63  $this->context = $context;
64  $this->resourceLoader = $context->getResourceLoader();
65  $this->options = $options + [
66  'target' => null,
67  'safemode' => null,
68  'nonce' => null,
69  ];
70  }
71 
77  public function setConfig( array $vars ) {
78  foreach ( $vars as $key => $value ) {
79  $this->config[$key] = $value;
80  }
81  }
82 
88  public function setModules( array $modules ) {
89  $this->modules = $modules;
90  }
91 
97  public function setModuleStyles( array $modules ) {
98  $this->moduleStyles = $modules;
99  }
100 
108  public function setExemptStates( array $states ) {
109  $this->exemptStates = $states;
110  }
111 
115  private function getData() {
116  if ( $this->data ) {
117  // @codeCoverageIgnoreStart
118  return $this->data;
119  // @codeCoverageIgnoreEnd
120  }
121 
122  $rl = $this->resourceLoader;
123  $data = [
124  'states' => [
125  // moduleName => state
126  ],
127  'general' => [],
128  'styles' => [],
129  // Embedding for private modules
130  'embed' => [
131  'styles' => [],
132  'general' => [],
133  ],
134  // Deprecations for style-only modules
135  'styleDeprecations' => [],
136  ];
137 
138  foreach ( $this->modules as $name ) {
139  $module = $rl->getModule( $name );
140  if ( !$module ) {
141  continue;
142  }
143 
144  $group = $module->getGroup();
146  if ( $module->isKnownEmpty( $context ) ) {
147  // Avoid needless request or embed for empty module
148  $data['states'][$name] = 'ready';
149  continue;
150  }
151 
152  if ( $group === 'user' || $module->shouldEmbedModule( $this->context ) ) {
153  // Call makeLoad() to decide how to load these, instead of
154  // loading via mw.loader.load().
155  // - For group=user: We need to provide a pre-generated load.php
156  // url to the client that has the 'user' and 'version' parameters
157  // filled in. Without this, the client would wrongly use the static
158  // version hash, per T64602.
159  // - For shouldEmbed=true: Embed via mw.loader.implement, per T36907.
160  $data['embed']['general'][] = $name;
161  // Avoid duplicate request from mw.loader
162  $data['states'][$name] = 'loading';
163  } else {
164  // Load via mw.loader.load()
165  $data['general'][] = $name;
166  }
167  }
168 
169  foreach ( $this->moduleStyles as $name ) {
170  $module = $rl->getModule( $name );
171  if ( !$module ) {
172  continue;
173  }
174 
175  if ( $module->getType() !== ResourceLoaderModule::LOAD_STYLES ) {
176  $logger = $rl->getLogger();
177  $logger->error( 'Unexpected general module "{module}" in styles queue.', [
178  'module' => $name,
179  ] );
180  continue;
181  }
182 
183  // Stylesheet doesn't trigger mw.loader callback.
184  // Set "ready" state to allow script modules to depend on this module (T87871).
185  // And to avoid duplicate requests at run-time from mw.loader.
186  $data['states'][$name] = 'ready';
187 
188  $group = $module->getGroup();
190  // Avoid needless request for empty module
191  if ( !$module->isKnownEmpty( $context ) ) {
192  if ( $module->shouldEmbedModule( $this->context ) ) {
193  // Embed via style element
194  $data['embed']['styles'][] = $name;
195  } else {
196  // Load from load.php?only=styles via <link rel=stylesheet>
197  $data['styles'][] = $name;
198  }
199  }
200  $deprecation = $module->getDeprecationInformation();
201  if ( $deprecation ) {
202  $data['styleDeprecations'][] = $deprecation;
203  }
204  }
205 
206  return $data;
207  }
208 
212  public function getDocumentAttributes() {
213  return [ 'class' => 'client-nojs' ];
214  }
215 
230  public function getHeadHtml() {
231  $nonce = $this->options['nonce'];
232  $data = $this->getData();
233  $chunks = [];
234 
235  // Change "client-nojs" class to client-js. This allows easy toggling of UI components.
236  // This must happen synchronously on every page view to avoid flashes of wrong content.
237  // See also #getDocumentAttributes() and /resources/src/startup.js.
238  $script = <<<JAVASCRIPT
239 document.documentElement.className = document.documentElement.className
240  .replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );
241 JAVASCRIPT;
242 
243  // Inline script: Declare mw.config variables for this page.
244  if ( $this->config ) {
245  $confJson = ResourceLoader::encodeJsonForScript( $this->config );
246  $script .= <<<JAVASCRIPT
247 RLCONF = {$confJson};
248 JAVASCRIPT;
249  }
250 
251  // Inline script: Declare initial module states for this page.
252  $states = array_merge( $this->exemptStates, $data['states'] );
253  if ( $states ) {
254  $stateJson = ResourceLoader::encodeJsonForScript( $states );
255  $script .= <<<JAVASCRIPT
256 RLSTATE = {$stateJson};
257 JAVASCRIPT;
258  }
259 
260  // Inline script: Declare general modules to load on this page.
261  if ( $data['general'] ) {
262  $pageModulesJson = ResourceLoader::encodeJsonForScript( $data['general'] );
263  $script .= <<<JAVASCRIPT
264 RLPAGEMODULES = {$pageModulesJson};
265 JAVASCRIPT;
266  }
267 
268  if ( $this->context->getDebug() ) {
269  $chunks[] = Html::inlineScript( $script, $nonce );
270  } else {
271  $chunks[] = Html::inlineScript(
272  ResourceLoader::filter( 'minify-js', $script, [ 'cache' => false ] ),
273  $nonce
274  );
275  }
276 
277  // Inline RLQ: Embedded modules
278  if ( $data['embed']['general'] ) {
279  $chunks[] = $this->getLoad(
280  $data['embed']['general'],
282  $nonce
283  );
284  }
285 
286  // External stylesheets (only=styles)
287  if ( $data['styles'] ) {
288  $chunks[] = $this->getLoad(
289  $data['styles'],
291  $nonce
292  );
293  }
294 
295  // Inline stylesheets (embedded only=styles)
296  if ( $data['embed']['styles'] ) {
297  $chunks[] = $this->getLoad(
298  $data['embed']['styles'],
300  $nonce
301  );
302  }
303 
304  // Async scripts. Once the startup is loaded, inline RLQ scripts will run.
305  // Pass-through a custom 'target' from OutputPage (T143066).
306  $startupQuery = [ 'raw' => '1' ];
307  foreach ( [ 'target', 'safemode' ] as $param ) {
308  if ( $this->options[$param] !== null ) {
309  $startupQuery[$param] = (string)$this->options[$param];
310  }
311  }
312  $chunks[] = $this->getLoad(
313  'startup',
315  $nonce,
316  $startupQuery
317  );
318 
319  return WrappedString::join( "\n", $chunks );
320  }
321 
325  public function getBodyHtml() {
326  $data = $this->getData();
327  $chunks = [];
328 
329  // Deprecations for only=styles modules
330  if ( $data['styleDeprecations'] ) {
332  implode( '', $data['styleDeprecations'] ),
333  $this->options['nonce']
334  );
335  }
336 
337  return WrappedString::join( "\n", $chunks );
338  }
339 
340  private function getContext( $group, $type ) {
341  return self::makeContext( $this->context, $group, $type );
342  }
343 
344  private function getLoad( $modules, $only, $nonce, array $extraQuery = [] ) {
345  return self::makeLoad( $this->context, (array)$modules, $only, $extraQuery, $nonce );
346  }
347 
348  private static function makeContext( ResourceLoaderContext $mainContext, $group, $type,
349  array $extraQuery = []
350  ) {
351  // Create new ResourceLoaderContext so that $extraQuery may trigger isRaw().
352  $req = new FauxRequest( array_merge( $mainContext->getRequest()->getValues(), $extraQuery ) );
353  // Set 'only' if not combined
354  $req->setVal( 'only', $type === ResourceLoaderModule::TYPE_COMBINED ? null : $type );
355  // Remove user parameter in most cases
356  if ( $group !== 'user' && $group !== 'private' ) {
357  $req->setVal( 'user', null );
358  }
359  $context = new ResourceLoaderContext( $mainContext->getResourceLoader(), $req );
360  // Allow caller to setVersion() and setModules()
362  $ret->setContentOverrideCallback( $mainContext->getContentOverrideCallback() );
363  return $ret;
364  }
365 
377  public static function makeLoad( ResourceLoaderContext $mainContext, array $modules, $only,
378  array $extraQuery = [], $nonce = null
379  ) {
380  $rl = $mainContext->getResourceLoader();
381  $chunks = [];
382 
383  // Sort module names so requests are more uniform
384  sort( $modules );
385 
386  if ( $mainContext->getDebug() && count( $modules ) > 1 ) {
387  $chunks = [];
388  // Recursively call us for every item
389  foreach ( $modules as $name ) {
390  $chunks[] = self::makeLoad( $mainContext, [ $name ], $only, $extraQuery, $nonce );
391  }
392  return new WrappedStringList( "\n", $chunks );
393  }
394 
395  // Create keyed-by-source and then keyed-by-group list of module objects from modules list
396  $sortedModules = [];
397  foreach ( $modules as $name ) {
398  $module = $rl->getModule( $name );
399  if ( !$module ) {
400  $rl->getLogger()->warning( 'Unknown module "{module}"', [ 'module' => $name ] );
401  continue;
402  }
403  $sortedModules[$module->getSource()][$module->getGroup()][$name] = $module;
404  }
405 
406  foreach ( $sortedModules as $source => $groups ) {
407  foreach ( $groups as $group => $grpModules ) {
408  $context = self::makeContext( $mainContext, $group, $only, $extraQuery );
409 
410  // Separate sets of linked and embedded modules while preserving order
411  $moduleSets = [];
412  $idx = -1;
413  foreach ( $grpModules as $name => $module ) {
414  $shouldEmbed = $module->shouldEmbedModule( $context );
415  if ( !$moduleSets || $moduleSets[$idx][0] !== $shouldEmbed ) {
416  $moduleSets[++$idx] = [ $shouldEmbed, [] ];
417  }
418  $moduleSets[$idx][1][$name] = $module;
419  }
420 
421  // Link/embed each set
422  foreach ( $moduleSets as list( $embed, $moduleSet ) ) {
423  $context->setModules( array_keys( $moduleSet ) );
424  if ( $embed ) {
425  // Decide whether to use style or script element
426  if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
427  $chunks[] = Html::inlineStyle(
428  $rl->makeModuleResponse( $context, $moduleSet )
429  );
430  } else {
432  $rl->makeModuleResponse( $context, $moduleSet ),
433  $nonce
434  );
435  }
436  } else {
437  // See if we have one or more raw modules
438  $isRaw = false;
439  foreach ( $moduleSet as $key => $module ) {
440  $isRaw |= $module->isRaw();
441  }
442 
443  // Special handling for the user group; because users might change their stuff
444  // on-wiki like user pages, or user preferences; we need to find the highest
445  // timestamp of these user-changeable modules so we can ensure cache misses on change
446  // This should NOT be done for the site group (T29564) because anons get that too
447  // and we shouldn't be putting timestamps in CDN-cached HTML
448  if ( $group === 'user' ) {
449  // Must setModules() before makeVersionQuery()
450  $context->setVersion( $rl->makeVersionQuery( $context ) );
451  }
452 
453  $url = $rl->createLoaderURL( $source, $context, $extraQuery );
454 
455  // Decide whether to use 'style' or 'script' element
456  if ( $only === ResourceLoaderModule::TYPE_STYLES ) {
457  $chunk = Html::linkedStyle( $url );
458  } elseif ( $context->getRaw() || $isRaw ) {
459  $chunk = Html::element( 'script', [
460  // In SpecialJavaScriptTest, QUnit must load synchronous
461  'async' => !isset( $extraQuery['sync'] ),
462  'src' => $url
463  ] );
464  } else {
466  Xml::encodeJsCall( 'mw.loader.load', [ $url ] ),
467  $nonce
468  );
469  }
470 
471  if ( $group == 'noscript' ) {
472  $chunks[] = Html::rawElement( 'noscript', [], $chunk );
473  } else {
474  $chunks[] = $chunk;
475  }
476  }
477  }
478  }
479  }
480 
481  return new WrappedStringList( "\n", $chunks );
482  }
483 }
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:6
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
setConfig(array $vars)
Set mw.config variables.
setModuleStyles(array $modules)
Ensure the styles of one or more modules are loaded.
static linkedStyle( $url, $media='all')
Output a "<link rel=stylesheet>" linking to the given URL for the given media type (if any)...
Definition: Html.php:649
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
static filter( $filter, $data, array $options=[])
Run JavaScript or CSS data through a filter, caching the filtered result for future calls...
getLoad( $modules, $only, $nonce, array $extraQuery=[])
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1982
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:175
$source
$value
static inlineScript( $contents, $nonce=null)
Output an HTML script tag with the given contents.
Definition: Html.php:573
__construct(ResourceLoaderContext $context, array $options=[])
Allows changing specific properties of a context object, without changing the main one...
getHeadHtml()
The order of elements in the head is as follows:
static encodeJsCall( $name, $args, $pretty=false)
Create a call to a JavaScript function.
Definition: Xml.php:677
setExemptStates(array $states)
Set state of special modules that are handled by the caller manually.
static makeContext(ResourceLoaderContext $mainContext, $group, $type, array $extraQuery=[])
Load and configure a ResourceLoader client on an HTML page.
static encodeJsonForScript( $data)
Wrapper around json_encode that avoids needless escapes, and pretty-prints in debug mode...
getContentOverrideCallback()
Return the replaced-content mapping callback.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
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
Definition: distributors.txt:9
static makeInlineScript( $script, $nonce=null)
Returns an HTML script tag that runs given JS code after startup and base modules.
static makeLoad(ResourceLoaderContext $mainContext, array $modules, $only, array $extraQuery=[], $nonce=null)
Explicily load or embed modules on a page.
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:35
this hook is for auditing only $req
Definition: hooks.txt:979
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
static inlineStyle( $contents, $media='all', $attribs=[])
Output a "<style>" tag with the given contents for the given media type (if any). ...
Definition: Html.php:620
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
setModules(array $modules)
Ensure one or more modules are loaded.
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2217
Object passed around to modules which contains information about the state of a specific loader reque...