MediaWiki  master
ResourceLoaderFileModule.php
Go to the documentation of this file.
1 <?php
29 
31  protected $localBasePath = '';
32 
34  protected $remoteBasePath = '';
35 
37  protected $templates = [];
38 
46  protected $scripts = [];
47 
55  protected $languageScripts = [];
56 
64  protected $skinScripts = [];
65 
73  protected $debugScripts = [];
74 
82  protected $styles = [];
83 
91  protected $skinStyles = [];
92 
100  protected $packageFiles = null;
101 
106  private $expandedPackageFiles = [];
107 
115  protected $dependencies = [];
116 
120  protected $skipFunction = null;
121 
129  protected $messages = [];
130 
132  protected $group;
133 
135  protected $debugRaw = true;
136 
138  protected $raw = false;
139 
140  protected $targets = [ 'desktop' ];
141 
143  protected $noflip = false;
144 
149  protected $hasGeneratedStyles = false;
150 
158  protected $localFileRefs = [];
159 
164  protected $missingLocalFileRefs = [];
165 
236  public function __construct(
237  $options = [],
240  ) {
241  // Flag to decide whether to automagically add the mediawiki.template module
242  $hasTemplates = false;
243  // localBasePath and remoteBasePath both have unbelievably long fallback chains
244  // and need to be handled separately.
245  list( $this->localBasePath, $this->remoteBasePath ) =
246  self::extractBasePaths( $options, $localBasePath, $remoteBasePath );
247 
248  // Extract, validate and normalise remaining options
249  foreach ( $options as $member => $option ) {
250  switch ( $member ) {
251  // Lists of file paths
252  case 'scripts':
253  case 'debugScripts':
254  case 'styles':
255  case 'packageFiles':
256  $this->{$member} = (array)$option;
257  break;
258  case 'templates':
259  $hasTemplates = true;
260  $this->{$member} = (array)$option;
261  break;
262  // Collated lists of file paths
263  case 'languageScripts':
264  case 'skinScripts':
265  case 'skinStyles':
266  if ( !is_array( $option ) ) {
267  throw new InvalidArgumentException(
268  "Invalid collated file path list error. " .
269  "'$option' given, array expected."
270  );
271  }
272  foreach ( $option as $key => $value ) {
273  if ( !is_string( $key ) ) {
274  throw new InvalidArgumentException(
275  "Invalid collated file path list key error. " .
276  "'$key' given, string expected."
277  );
278  }
279  $this->{$member}[$key] = (array)$value;
280  }
281  break;
282  case 'deprecated':
283  $this->deprecated = $option;
284  break;
285  // Lists of strings
286  case 'dependencies':
287  case 'messages':
288  case 'targets':
289  // Normalise
290  $option = array_values( array_unique( (array)$option ) );
291  sort( $option );
292 
293  $this->{$member} = $option;
294  break;
295  // Single strings
296  case 'group':
297  case 'skipFunction':
298  $this->{$member} = (string)$option;
299  break;
300  // Single booleans
301  case 'debugRaw':
302  case 'raw':
303  case 'noflip':
304  $this->{$member} = (bool)$option;
305  break;
306  }
307  }
308  if ( isset( $options['scripts'] ) && isset( $options['packageFiles'] ) ) {
309  throw new InvalidArgumentException( "A module may not set both 'scripts' and 'packageFiles'" );
310  }
311  if ( $hasTemplates ) {
312  $this->dependencies[] = 'mediawiki.template';
313  // Ensure relevant template compiler module gets loaded
314  foreach ( $this->templates as $alias => $templatePath ) {
315  if ( is_int( $alias ) ) {
316  $alias = $templatePath;
317  }
318  $suffix = explode( '.', $alias );
319  $suffix = end( $suffix );
320  $compilerModule = 'mediawiki.template.' . $suffix;
321  if ( $suffix !== 'html' && !in_array( $compilerModule, $this->dependencies ) ) {
322  $this->dependencies[] = $compilerModule;
323  }
324  }
325  }
326  }
327 
339  public static function extractBasePaths(
340  $options = [],
343  ) {
344  global $IP, $wgResourceBasePath;
345 
346  // The different ways these checks are done, and their ordering, look very silly,
347  // but were preserved for backwards-compatibility just in case. Tread lightly.
348 
349  if ( $localBasePath === null ) {
351  }
352  if ( $remoteBasePath === null ) {
354  }
355 
356  if ( isset( $options['remoteExtPath'] ) ) {
357  global $wgExtensionAssetsPath;
358  $remoteBasePath = $wgExtensionAssetsPath . '/' . $options['remoteExtPath'];
359  }
360 
361  if ( isset( $options['remoteSkinPath'] ) ) {
362  global $wgStylePath;
363  $remoteBasePath = $wgStylePath . '/' . $options['remoteSkinPath'];
364  }
365 
366  if ( array_key_exists( 'localBasePath', $options ) ) {
367  $localBasePath = (string)$options['localBasePath'];
368  }
369 
370  if ( array_key_exists( 'remoteBasePath', $options ) ) {
371  $remoteBasePath = (string)$options['remoteBasePath'];
372  }
373 
374  return [ $localBasePath, $remoteBasePath ];
375  }
376 
384  $deprecationScript = $this->getDeprecationInformation();
385  if ( $this->packageFiles !== null ) {
386  $packageFiles = $this->getPackageFiles( $context );
387  if ( $deprecationScript ) {
388  $mainFile =& $packageFiles['files'][$packageFiles['main']];
389  $mainFile['content'] = $deprecationScript . $mainFile['content'];
390  }
391  return $packageFiles;
392  }
393 
394  $files = $this->getScriptFiles( $context );
395  return $deprecationScript . $this->readScriptFiles( $files );
396  }
397 
403  $urls = [];
404  foreach ( $this->getScriptFiles( $context ) as $file ) {
406  $this->getConfig(),
407  $this->getRemotePath( $file )
408  );
409  }
410  return $urls;
411  }
412 
416  public function supportsURLLoading() {
417  // If package files are involved, don't support URL loading, because that breaks
418  // scoped require() functions
419  return $this->debugRaw && !$this->packageFiles;
420  }
421 
429  $styles = $this->readStyleFiles(
430  $this->getStyleFiles( $context ),
431  $this->getFlip( $context ),
432  $context
433  );
434  // Collect referenced files
435  $this->saveFileDependencies( $context, $this->localFileRefs );
436 
437  return $styles;
438  }
439 
445  if ( $this->hasGeneratedStyles ) {
446  // Do the default behaviour of returning a url back to load.php
447  // but with only=styles.
448  return parent::getStyleURLsForDebug( $context );
449  }
450  // Our module consists entirely of real css files,
451  // in debug mode we can load those directly.
452  $urls = [];
453  foreach ( $this->getStyleFiles( $context ) as $mediaType => $list ) {
454  $urls[$mediaType] = [];
455  foreach ( $list as $file ) {
457  $this->getConfig(),
458  $this->getRemotePath( $file )
459  );
460  }
461  }
462  return $urls;
463  }
464 
470  public function getMessages() {
471  return $this->messages;
472  }
473 
479  public function getGroup() {
480  return $this->group;
481  }
482 
489  return $this->dependencies;
490  }
491 
497  public function getSkipFunction() {
498  if ( !$this->skipFunction ) {
499  return null;
500  }
501 
502  $localPath = $this->getLocalPath( $this->skipFunction );
503  if ( !file_exists( $localPath ) ) {
504  throw new MWException( __METHOD__ . ": skip function file not found: \"$localPath\"" );
505  }
506  $contents = $this->stripBom( file_get_contents( $localPath ) );
507  return $contents;
508  }
509 
513  public function isRaw() {
514  return $this->raw;
515  }
516 
525  public function enableModuleContentVersion() {
526  return false;
527  }
528 
537  $files = [];
538 
539  // Flatten style files into $files
540  $styles = self::collateFilePathListByOption( $this->styles, 'media', 'all' );
541  foreach ( $styles as $styleFiles ) {
542  $files = array_merge( $files, $styleFiles );
543  }
544 
545  $skinFiles = self::collateFilePathListByOption(
546  self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
547  'media',
548  'all'
549  );
550  foreach ( $skinFiles as $styleFiles ) {
551  $files = array_merge( $files, $styleFiles );
552  }
553 
554  // Extract file names for package files
555  $expandedPackageFiles = $this->expandPackageFiles( $context );
557  array_filter( array_map( function ( $fileInfo ) {
558  return $fileInfo['filePath'] ?? null;
559  }, $expandedPackageFiles['files'] ) ) :
560  [];
561 
562  // Final merge, this should result in a master list of dependent files
563  $files = array_merge(
564  $files,
566  $this->scripts,
567  $this->templates,
568  $context->getDebug() ? $this->debugScripts : [],
569  $this->getLanguageScripts( $context->getLanguage() ),
570  self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' )
571  );
572  if ( $this->skipFunction ) {
573  $files[] = $this->skipFunction;
574  }
575  $files = array_map( [ $this, 'getLocalPath' ], $files );
576  // File deps need to be treated separately because they're already prefixed
577  $files = array_merge( $files, $this->getFileDependencies( $context ) );
578  // Filter out any duplicates from getFileDependencies() and others.
579  // Most commonly introduced by compileLessFile(), which always includes the
580  // entry point Less file we already know about.
581  $files = array_values( array_unique( $files ) );
582 
583  // Don't include keys or file paths here, only the hashes. Including that would needlessly
584  // cause global cache invalidation when files move or if e.g. the MediaWiki path changes.
585  // Any significant ordering is already detected by the definition summary.
586  return array_map( [ __CLASS__, 'safeFileHash' ], $files );
587  }
588 
596  $summary = parent::getDefinitionSummary( $context );
597 
598  $options = [];
599  foreach ( [
600  // The following properties are omitted because they don't affect the module reponse:
601  // - localBasePath (Per T104950; Changes when absolute directory name changes. If
602  // this affects 'scripts' and other file paths, getFileHashes accounts for that.)
603  // - remoteBasePath (Per T104950)
604  // - dependencies (provided via startup module)
605  // - targets
606  // - group (provided via startup module)
607  'scripts',
608  'debugScripts',
609  'styles',
610  'languageScripts',
611  'skinScripts',
612  'skinStyles',
613  'messages',
614  'templates',
615  'skipFunction',
616  'debugRaw',
617  'raw',
618  ] as $member ) {
619  $options[$member] = $this->{$member};
620  }
621 
622  $packageFiles = $this->expandPackageFiles( $context );
623  if ( $packageFiles ) {
624  // Extract the minimum needed:
625  // - The 'main' pointer (included as-is).
626  // - The 'files' array, simplied to only which files exist (the keys of
627  // this array), and something that represents their non-file content.
628  // For packaged files that reflect files directly from disk, the
629  // 'getFileHashes' method tracks this already.
630  // It is important that the keys of the 'files' array are preserved,
631  // as they affect the module output.
632  $packageFiles['files'] = array_map( function ( $fileInfo ) {
633  return $fileInfo['definitionSummary'] ?? ( $fileInfo['content'] ?? null );
634  }, $packageFiles['files'] );
635  }
636 
637  $summary[] = [
638  'options' => $options,
639  'packageFiles' => $packageFiles,
640  'fileHashes' => $this->getFileHashes( $context ),
641  'messageBlob' => $this->getMessageBlob( $context ),
642  ];
643 
644  $lessVars = $this->getLessVars( $context );
645  if ( $lessVars ) {
646  $summary[] = [ 'lessVars' => $lessVars ];
647  }
648 
649  return $summary;
650  }
651 
656  protected function getLocalPath( $path ) {
657  if ( $path instanceof ResourceLoaderFilePath ) {
658  return $path->getLocalPath();
659  }
660 
661  return "{$this->localBasePath}/$path";
662  }
663 
668  protected function getRemotePath( $path ) {
669  if ( $path instanceof ResourceLoaderFilePath ) {
670  return $path->getRemotePath();
671  }
672 
673  return "{$this->remoteBasePath}/$path";
674  }
675 
683  public function getStyleSheetLang( $path ) {
684  return preg_match( '/\.less$/i', $path ) ? 'less' : 'css';
685  }
686 
692  public static function getPackageFileType( $path ) {
693  if ( preg_match( '/\.json$/i', $path ) ) {
694  return 'data';
695  }
696  return 'script';
697  }
698 
708  protected static function collateFilePathListByOption( array $list, $option, $default ) {
709  $collatedFiles = [];
710  foreach ( (array)$list as $key => $value ) {
711  if ( is_int( $key ) ) {
712  // File name as the value
713  if ( !isset( $collatedFiles[$default] ) ) {
714  $collatedFiles[$default] = [];
715  }
716  $collatedFiles[$default][] = $value;
717  } elseif ( is_array( $value ) ) {
718  // File name as the key, options array as the value
719  $optionValue = $value[$option] ?? $default;
720  if ( !isset( $collatedFiles[$optionValue] ) ) {
721  $collatedFiles[$optionValue] = [];
722  }
723  $collatedFiles[$optionValue][] = $key;
724  }
725  }
726  return $collatedFiles;
727  }
728 
738  protected static function tryForKey( array $list, $key, $fallback = null ) {
739  if ( isset( $list[$key] ) && is_array( $list[$key] ) ) {
740  return $list[$key];
741  } elseif ( is_string( $fallback )
742  && isset( $list[$fallback] )
743  && is_array( $list[$fallback] )
744  ) {
745  return $list[$fallback];
746  }
747  return [];
748  }
749 
757  $files = array_merge(
758  $this->scripts,
759  $this->getLanguageScripts( $context->getLanguage() ),
760  self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' )
761  );
762  if ( $context->getDebug() ) {
763  $files = array_merge( $files, $this->debugScripts );
764  }
765 
766  return array_unique( $files, SORT_REGULAR );
767  }
768 
776  private function getLanguageScripts( $lang ) {
777  $scripts = self::tryForKey( $this->languageScripts, $lang );
778  if ( $scripts ) {
779  return $scripts;
780  }
781  $fallbacks = Language::getFallbacksFor( $lang );
782  foreach ( $fallbacks as $lang ) {
783  $scripts = self::tryForKey( $this->languageScripts, $lang );
784  if ( $scripts ) {
785  return $scripts;
786  }
787  }
788 
789  return [];
790  }
791 
802  return array_merge_recursive(
803  self::collateFilePathListByOption( $this->styles, 'media', 'all' ),
804  self::collateFilePathListByOption(
805  self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
806  'media',
807  'all'
808  )
809  );
810  }
811 
819  protected function getSkinStyleFiles( $skinName ) {
820  return self::collateFilePathListByOption(
821  self::tryForKey( $this->skinStyles, $skinName ),
822  'media',
823  'all'
824  );
825  }
826 
833  protected function getAllSkinStyleFiles() {
834  $styleFiles = [];
835  $internalSkinNames = array_keys( Skin::getSkinNames() );
836  $internalSkinNames[] = 'default';
837 
838  foreach ( $internalSkinNames as $internalSkinName ) {
839  $styleFiles = array_merge_recursive(
840  $styleFiles,
841  $this->getSkinStyleFiles( $internalSkinName )
842  );
843  }
844 
845  return $styleFiles;
846  }
847 
853  public function getAllStyleFiles() {
854  $collatedStyleFiles = array_merge_recursive(
855  self::collateFilePathListByOption( $this->styles, 'media', 'all' ),
856  $this->getAllSkinStyleFiles()
857  );
858 
859  $result = [];
860 
861  foreach ( $collatedStyleFiles as $media => $styleFiles ) {
862  foreach ( $styleFiles as $styleFile ) {
863  $result[] = $this->getLocalPath( $styleFile );
864  }
865  }
866 
867  return $result;
868  }
869 
877  private function readScriptFiles( array $scripts ) {
878  if ( empty( $scripts ) ) {
879  return '';
880  }
881  $js = '';
882  foreach ( array_unique( $scripts, SORT_REGULAR ) as $fileName ) {
883  $localPath = $this->getLocalPath( $fileName );
884  if ( !file_exists( $localPath ) ) {
885  throw new MWException( __METHOD__ . ": script file not found: \"$localPath\"" );
886  }
887  $contents = $this->stripBom( file_get_contents( $localPath ) );
888  $js .= $contents . "\n";
889  }
890  return $js;
891  }
892 
904  public function readStyleFiles( array $styles, $flip, $context ) {
905  if ( !$styles ) {
906  return [];
907  }
908  foreach ( $styles as $media => $files ) {
909  $uniqueFiles = array_unique( $files, SORT_REGULAR );
910  $styleFiles = [];
911  foreach ( $uniqueFiles as $file ) {
912  $styleFiles[] = $this->readStyleFile( $file, $flip, $context );
913  }
914  $styles[$media] = implode( "\n", $styleFiles );
915  }
916  return $styles;
917  }
918 
931  protected function readStyleFile( $path, $flip, $context ) {
932  $localPath = $this->getLocalPath( $path );
933  $remotePath = $this->getRemotePath( $path );
934  if ( !file_exists( $localPath ) ) {
935  $msg = __METHOD__ . ": style file not found: \"$localPath\"";
936  wfDebugLog( 'resourceloader', $msg );
937  throw new MWException( $msg );
938  }
939 
940  if ( $this->getStyleSheetLang( $localPath ) === 'less' ) {
941  $style = $this->compileLessFile( $localPath, $context );
942  $this->hasGeneratedStyles = true;
943  } else {
944  $style = $this->stripBom( file_get_contents( $localPath ) );
945  }
946 
947  if ( $flip ) {
948  $style = CSSJanus::transform( $style, true, false );
949  }
950  $localDir = dirname( $localPath );
951  $remoteDir = dirname( $remotePath );
952  // Get and register local file references
953  $localFileRefs = CSSMin::getLocalFileReferences( $style, $localDir );
954  foreach ( $localFileRefs as $file ) {
955  if ( file_exists( $file ) ) {
956  $this->localFileRefs[] = $file;
957  } else {
958  $this->missingLocalFileRefs[] = $file;
959  }
960  }
961  // Don't cache this call. remap() ensures data URIs embeds are up to date,
962  // and urls contain correct content hashes in their query string. (T128668)
963  return CSSMin::remap( $style, $localDir, $remoteDir, true );
964  }
965 
971  public function getFlip( $context ) {
972  return $context->getDirection() === 'rtl' && !$this->noflip;
973  }
974 
980  public function getTargets() {
981  return $this->targets;
982  }
983 
990  public function getType() {
991  $canBeStylesOnly = !(
992  // All options except 'styles', 'skinStyles' and 'debugRaw'
993  $this->scripts
994  || $this->debugScripts
995  || $this->templates
996  || $this->languageScripts
997  || $this->skinScripts
998  || $this->dependencies
999  || $this->messages
1000  || $this->skipFunction
1001  || $this->raw
1002  );
1003  return $canBeStylesOnly ? self::LOAD_STYLES : self::LOAD_GENERAL;
1004  }
1005 
1018  protected function compileLessFile( $fileName, ResourceLoaderContext $context ) {
1019  static $cache;
1020 
1021  if ( !$cache ) {
1023  }
1024 
1025  $vars = $this->getLessVars( $context );
1026  // Construct a cache key from the LESS file name, and a hash digest
1027  // of the LESS variables used for compilation.
1028  ksort( $vars );
1029  $varsHash = hash( 'md4', serialize( $vars ) );
1030  $cacheKey = $cache->makeGlobalKey( 'LESS', $fileName, $varsHash );
1031  $cachedCompile = $cache->get( $cacheKey );
1032 
1033  // If we got a cached value, we have to validate it by getting a
1034  // checksum of all the files that were loaded by the parser and
1035  // ensuring it matches the cached entry's.
1036  if ( isset( $cachedCompile['hash'] ) ) {
1037  $contentHash = FileContentsHasher::getFileContentsHash( $cachedCompile['files'] );
1038  if ( $contentHash === $cachedCompile['hash'] ) {
1039  $this->localFileRefs = array_merge( $this->localFileRefs, $cachedCompile['files'] );
1040  return $cachedCompile['css'];
1041  }
1042  }
1043 
1044  $compiler = $context->getResourceLoader()->getLessCompiler( $vars );
1045  $css = $compiler->parseFile( $fileName )->getCss();
1046  $files = $compiler->AllParsedFiles();
1047  $this->localFileRefs = array_merge( $this->localFileRefs, $files );
1048 
1049  // Cache for 24 hours (86400 seconds).
1050  $cache->set( $cacheKey, [
1051  'css' => $css,
1052  'files' => $files,
1053  'hash' => FileContentsHasher::getFileContentsHash( $files ),
1054  ], 3600 * 24 );
1055 
1056  return $css;
1057  }
1058 
1064  public function getTemplates() {
1065  $templates = [];
1066 
1067  foreach ( $this->templates as $alias => $templatePath ) {
1068  // Alias is optional
1069  if ( is_int( $alias ) ) {
1070  $alias = $templatePath;
1071  }
1072  $localPath = $this->getLocalPath( $templatePath );
1073  if ( file_exists( $localPath ) ) {
1074  $content = file_get_contents( $localPath );
1075  $templates[$alias] = $this->stripBom( $content );
1076  } else {
1077  $msg = __METHOD__ . ": template file not found: \"$localPath\"";
1078  wfDebugLog( 'resourceloader', $msg );
1079  throw new MWException( $msg );
1080  }
1081  }
1082  return $templates;
1083  }
1084 
1104  $hash = $context->getHash();
1105  if ( isset( $this->expandedPackageFiles[$hash] ) ) {
1106  return $this->expandedPackageFiles[$hash];
1107  }
1108  if ( $this->packageFiles === null ) {
1109  return null;
1110  }
1111  $expandedFiles = [];
1112  $mainFile = null;
1113 
1114  foreach ( $this->packageFiles as $alias => $fileInfo ) {
1115  if ( is_string( $fileInfo ) ) {
1116  $fileInfo = [ 'name' => $fileInfo, 'file' => $fileInfo ];
1117  } elseif ( !isset( $fileInfo['name'] ) ) {
1118  $msg = __METHOD__ . ": invalid package file definition for module " .
1119  "\"{$this->getName()}\": 'name' key is required when value is not a string";
1120  wfDebugLog( 'resourceloader', $msg );
1121  throw new MWException( $msg );
1122  }
1123 
1124  // Infer type from alias if needed
1125  $type = $fileInfo['type'] ?? self::getPackageFileType( $fileInfo['name'] );
1126  $expanded = [ 'type' => $type ];
1127  if ( !empty( $fileInfo['main'] ) ) {
1128  $mainFile = $fileInfo['name'];
1129  if ( $type !== 'script' ) {
1130  $msg = __METHOD__ . ": invalid package file definition for module " .
1131  "\"{$this->getName()}\": main file \"$mainFile\" must be of type \"script\", not \"$type\"";
1132  wfDebugLog( 'resourceloader', $msg );
1133  throw new MWException( $msg );
1134  }
1135  }
1136 
1137  // Perform expansions (except 'file' and 'callback'), creating one of these keys:
1138  // - 'content': literal value.
1139  // - 'filePath': content to be read from a file.
1140  // - 'callback': content computed by a callable.
1141  if ( isset( $fileInfo['content'] ) ) {
1142  $expanded['content'] = $fileInfo['content'];
1143  } elseif ( isset( $fileInfo['file'] ) ) {
1144  $expanded['filePath'] = $fileInfo['file'];
1145  } elseif ( isset( $fileInfo['callback'] ) ) {
1146  if ( !is_callable( $fileInfo['callback'] ) ) {
1147  $msg = __METHOD__ . ": invalid callback for package file \"{$fileInfo['name']}\"" .
1148  " in module \"{$this->getName()}\"";
1149  wfDebugLog( 'resourceloader', $msg );
1150  throw new MWException( $msg );
1151  }
1152  if ( isset( $fileInfo['versionCallback'] ) ) {
1153  if ( !is_callable( $fileInfo['versionCallback'] ) ) {
1154  throw new MWException( __METHOD__ . ": invalid versionCallback for file" .
1155  " \"{$fileInfo['name']}\" in module \"{$this->getName()}\"" );
1156  }
1157  $expanded['definitionSummary'] = ( $fileInfo['versionCallback'] )( $context );
1158  // Don't invoke 'callback' here as it may be expensive (T223260).
1159  $expanded['callback'] = $fileInfo['callback'];
1160  } else {
1161  $expanded['content'] = ( $fileInfo['callback'] )( $context );
1162  }
1163  } elseif ( isset( $fileInfo['config'] ) ) {
1164  if ( $type !== 'data' ) {
1165  $msg = __METHOD__ . ": invalid use of \"config\" for package file \"{$fileInfo['name']}\" " .
1166  "in module \"{$this->getName()}\": type must be \"data\" but is \"$type\"";
1167  wfDebugLog( 'resourceloader', $msg );
1168  throw new MWException( $msg );
1169  }
1170  $expandedConfig = [];
1171  foreach ( $fileInfo['config'] as $key => $var ) {
1172  $expandedConfig[ is_numeric( $key ) ? $var : $key ] = $this->getConfig()->get( $var );
1173  }
1174  $expanded['content'] = $expandedConfig;
1175  } elseif ( !empty( $fileInfo['main'] ) ) {
1176  // [ 'name' => 'foo.js', 'main' => true ] is shorthand
1177  $expanded['filePath'] = $fileInfo['name'];
1178  } else {
1179  $msg = __METHOD__ . ": invalid package file definition for \"{$fileInfo['name']}\" " .
1180  "in module \"{$this->getName()}\": one of \"file\", \"content\", \"callback\" or \"config\" " .
1181  "must be set";
1182  wfDebugLog( 'resourceloader', $msg );
1183  throw new MWException( $msg );
1184  }
1185 
1186  $expandedFiles[$fileInfo['name']] = $expanded;
1187  }
1188 
1189  if ( $expandedFiles && $mainFile === null ) {
1190  // The first package file that is a script is the main file
1191  foreach ( $expandedFiles as $path => &$file ) {
1192  if ( $file['type'] === 'script' ) {
1193  $mainFile = $path;
1194  break;
1195  }
1196  }
1197  }
1198 
1199  $result = [
1200  'main' => $mainFile,
1201  'files' => $expandedFiles
1202  ];
1203 
1204  $this->expandedPackageFiles[$hash] = $result;
1205  return $result;
1206  }
1207 
1214  if ( $this->packageFiles === null ) {
1215  return null;
1216  }
1217  $expandedPackageFiles = $this->expandPackageFiles( $context );
1218 
1219  // Expand file contents
1220  foreach ( $expandedPackageFiles['files'] as &$fileInfo ) {
1221  // Turn any 'filePath' or 'callback' key into actual 'content',
1222  // and remove the key after that.
1223  if ( isset( $fileInfo['filePath'] ) ) {
1224  $localPath = $this->getLocalPath( $fileInfo['filePath'] );
1225  if ( !file_exists( $localPath ) ) {
1226  $msg = __METHOD__ . ": package file not found: \"$localPath\"" .
1227  " in module \"{$this->getName()}\"";
1228  wfDebugLog( 'resourceloader', $msg );
1229  throw new MWException( $msg );
1230  }
1231  $content = $this->stripBom( file_get_contents( $localPath ) );
1232  if ( $fileInfo['type'] === 'data' ) {
1233  $content = json_decode( $content );
1234  }
1235  $fileInfo['content'] = $content;
1236  unset( $fileInfo['filePath'] );
1237  } elseif ( isset( $fileInfo['callback'] ) ) {
1238  $fileInfo['content'] = ( $fileInfo['callback'] )( $context );
1239  unset( $fileInfo['callback'] );
1240  }
1241 
1242  // Not needed for client response, exists for getDefinitionSummary().
1243  unset( $fileInfo['definitionSummary'] );
1244  }
1245 
1246  return $expandedPackageFiles;
1247  }
1248 
1259  protected function stripBom( $input ) {
1260  if ( substr_compare( "\xef\xbb\xbf", $input, 0, 3 ) === 0 ) {
1261  return substr( $input, 3 );
1262  }
1263  return $input;
1264  }
1265 }
getScriptURLsForDebug(ResourceLoaderContext $context)
getFlip( $context)
Get whether CSS for this module should be flipped.
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
getDeprecationInformation()
Get JS representing deprecation information for the current module if available.
if(is_array( $mode)) switch( $mode) $input
Abstraction for ResourceLoader modules, with name registration and maxage functionality.
serialize()
array $dependencies
List of modules this module depends on.
$IP
Definition: WebStart.php:41
array $skinStyles
List of paths to CSS files to include when using specific skins.
static getFileContentsHash( $filePaths, $algo='md4')
Get a hash of the combined contents of one or more files, either by retrieving a previously-computed ...
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
getStyleFiles(ResourceLoaderContext $context)
Get a list of file paths for all styles in this module, in order of proper inclusion.
array $packageFiles
List of packaged files to make available through require()
static getPackageFileType( $path)
Infer the file type from a package file path.
if(!isset( $args[0])) $lang
getMessageBlob(ResourceLoaderContext $context)
Get the hash of the message blob.
static getSkinNames()
Fetch the set of available skins.
Definition: Skin.php:57
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
$value
getAllStyleFiles()
Returns all style files and all skin style files used by this module.
readStyleFiles(array $styles, $flip, $context)
Get the contents of a list of CSS files.
getSkipFunction()
Get the skip function.
compileLessFile( $fileName, ResourceLoaderContext $context)
Compile a LESS file into CSS.
array $debugScripts
List of paths to JavaScript files to include in debug mode.
The package scripts
Definition: README.txt:1
static remap( $source, $local, $remote, $embedData=true)
Remaps CSS URL paths and automatically embeds data URIs for CSS rules or url() values preceded by an ...
Definition: CSSMin.php:239
getStyles(ResourceLoaderContext $context)
Get all styles for a given context.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
array $templates
Saves a list of the templates named by the modules.
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel you ll need to handle error messages
Definition: hooks.txt:1287
getLessVars(ResourceLoaderContext $context)
Get module-specific LESS variables, if any.
bool $raw
Whether mw.loader.state() call should be omitted.
stripBom( $input)
Takes an input string and removes the UTF-8 BOM character if present.
getFileHashes(ResourceLoaderContext $context)
Helper method for getDefinitionSummary.
bool $debugRaw
Link to raw files in debug mode.
$wgStylePath
The URL path of the skins directory.
getFileDependencies(ResourceLoaderContext $context)
Get the files this module depends on indirectly for a given skin.
enableModuleContentVersion()
Disable module content versioning.
$css
string $skipFunction
File name containing the body of the skip function.
bool $hasGeneratedStyles
Whether getStyleURLsForDebug should return raw file paths, or return load.php urls.
static transformResourcePath(Config $config, $path)
Transform path to web-accessible static resource.
getDependencies(ResourceLoaderContext $context=null)
Gets list of names of modules this module depends on.
ResourceLoader module based on local JavaScript/CSS files.
readScriptFiles(array $scripts)
Get the contents of a list of JavaScript files.
string $group
Name of group to load this module in.
static string [] static getLocalFileReferences( $source, $path)
Get a list of local files referenced in a stylesheet (includes non-existent files).
Definition: CSSMin.php:63
array $localFileRefs
Place where readStyleFile() tracks file dependencies.
string $localBasePath
Local base path, see __construct()
$cache
Definition: mcc.php:33
$wgResourceBasePath
The default &#39;remoteBasePath&#39; value for instances of ResourceLoaderFileModule.
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 & $options
Definition: hooks.txt:1982
getDefinitionSummary(ResourceLoaderContext $context)
Get the definition summary for this module.
getStyleSheetLang( $path)
Infer the stylesheet language from a stylesheet file path.
__construct( $options=[], $localBasePath=null, $remoteBasePath=null)
Constructs a new module from an options array.
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
getSkinStyleFiles( $skinName)
Gets a list of file paths for all skin styles in the module used by the skin.
getTemplates()
Takes named templates by the module and returns an array mapping.
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
getGroup()
Gets the name of the group this module should be loaded in.
An object to represent a path to a JavaScript/CSS file, along with a remote and local base path...
getMessages()
Gets list of message keys used by this module.
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
getStyleURLsForDebug(ResourceLoaderContext $context)
string $remoteBasePath
Remote base path, see __construct()
$fallback
Definition: MessagesAb.php:11
array $messages
List of message keys used by this module.
static extractBasePaths( $options=[], $localBasePath=null, $remoteBasePath=null)
Extract a pair of local and remote base paths from module definition information. ...
getAllSkinStyleFiles()
Gets a list of file paths for all skin style files in the module, for all available skins...
expandPackageFiles(ResourceLoaderContext $context)
Internal helper for use by getPackageFiles(), getFileHashes() and getDefinitionSummary().
array $scripts
List of paths to JavaScript files to always include.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
$wgExtensionAssetsPath
The URL path of the extensions directory.
static getFallbacksFor( $code, $mode=self::MESSAGES_FALLBACKS)
Get the ordered list of fallback languages.
Definition: Language.php:4514
array $languageScripts
List of JavaScript files to include when using a specific language.
getTargets()
Get target(s) for the module, eg [&#39;desktop&#39;] or [&#39;desktop&#39;, &#39;mobile&#39;].
const CACHE_ANYTHING
Definition: Defines.php:97
getType()
Get the module&#39;s load type.
getScript(ResourceLoaderContext $context)
Gets all scripts for a given context concatenated together.
getPackageFiles(ResourceLoaderContext $context)
Resolves the package files defintion and generates the content of each package file.
getLanguageScripts( $lang)
Get the set of language scripts for the given language, possibly using a fallback language...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2633
readStyleFile( $path, $flip, $context)
Reads a style file.
array $missingLocalFileRefs
Place where readStyleFile() tracks file dependencies for non-existent files.
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
getHash()
All factors that uniquely identify this request, except &#39;modules&#39;.
array $styles
List of paths to CSS files to always include.
static collateFilePathListByOption(array $list, $option, $default)
Collates file paths by option (where provided).
array $skinScripts
List of JavaScript files to include when using a specific skin.
getScriptFiles(ResourceLoaderContext $context)
Get a list of script file paths for this module, in order of proper execution.
saveFileDependencies(ResourceLoaderContext $context, $localFileRefs)
Set the files this module depends on indirectly for a given skin.
array $expandedPackageFiles
Expanded versions of $packageFiles, lazy-computed by expandPackageFiles(); keyed by context hash...
$content
Definition: pageupdater.txt:72
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2217
bool $noflip
Whether CSSJanus flipping should be skipped for this module.
Object passed around to modules which contains information about the state of a specific loader reque...
static tryForKey(array $list, $key, $fallback=null)
Get a list of element that match a key, optionally using a fallback key.