MediaWiki  1.28.0
ResourceLoaderFileModule.php
Go to the documentation of this file.
1 <?php
29  /* Protected Members */
30 
32  protected $localBasePath = '';
33 
35  protected $remoteBasePath = '';
36 
38  protected $templates = [];
39 
47  protected $scripts = [];
48 
56  protected $languageScripts = [];
57 
65  protected $skinScripts = [];
66 
74  protected $debugScripts = [];
75 
83  protected $styles = [];
84 
92  protected $skinStyles = [];
93 
101  protected $dependencies = [];
102 
106  protected $skipFunction = null;
107 
115  protected $messages = [];
116 
118  protected $group;
119 
121  protected $position = 'bottom';
122 
124  protected $debugRaw = true;
125 
127  protected $raw = false;
128 
129  protected $targets = [ 'desktop' ];
130 
132  protected $noflip = false;
133 
138  protected $hasGeneratedStyles = false;
139 
147  protected $localFileRefs = [];
148 
153  protected $missingLocalFileRefs = [];
154 
155  /* Methods */
156 
216  public function __construct(
217  $options = [],
218  $localBasePath = null,
219  $remoteBasePath = null
220  ) {
221  // Flag to decide whether to automagically add the mediawiki.template module
222  $hasTemplates = false;
223  // localBasePath and remoteBasePath both have unbelievably long fallback chains
224  // and need to be handled separately.
225  list( $this->localBasePath, $this->remoteBasePath ) =
226  self::extractBasePaths( $options, $localBasePath, $remoteBasePath );
227 
228  // Extract, validate and normalise remaining options
229  foreach ( $options as $member => $option ) {
230  switch ( $member ) {
231  // Lists of file paths
232  case 'scripts':
233  case 'debugScripts':
234  case 'styles':
235  $this->{$member} = (array)$option;
236  break;
237  case 'templates':
238  $hasTemplates = true;
239  $this->{$member} = (array)$option;
240  break;
241  // Collated lists of file paths
242  case 'languageScripts':
243  case 'skinScripts':
244  case 'skinStyles':
245  if ( !is_array( $option ) ) {
246  throw new InvalidArgumentException(
247  "Invalid collated file path list error. " .
248  "'$option' given, array expected."
249  );
250  }
251  foreach ( $option as $key => $value ) {
252  if ( !is_string( $key ) ) {
253  throw new InvalidArgumentException(
254  "Invalid collated file path list key error. " .
255  "'$key' given, string expected."
256  );
257  }
258  $this->{$member}[$key] = (array)$value;
259  }
260  break;
261  case 'deprecated':
262  $this->deprecated = $option;
263  break;
264  // Lists of strings
265  case 'dependencies':
266  case 'messages':
267  case 'targets':
268  // Normalise
269  $option = array_values( array_unique( (array)$option ) );
270  sort( $option );
271 
272  $this->{$member} = $option;
273  break;
274  // Single strings
275  case 'position':
276  case 'group':
277  case 'skipFunction':
278  $this->{$member} = (string)$option;
279  break;
280  // Single booleans
281  case 'debugRaw':
282  case 'raw':
283  case 'noflip':
284  $this->{$member} = (bool)$option;
285  break;
286  }
287  }
288  if ( $hasTemplates ) {
289  $this->dependencies[] = 'mediawiki.template';
290  // Ensure relevant template compiler module gets loaded
291  foreach ( $this->templates as $alias => $templatePath ) {
292  if ( is_int( $alias ) ) {
293  $alias = $templatePath;
294  }
295  $suffix = explode( '.', $alias );
296  $suffix = end( $suffix );
297  $compilerModule = 'mediawiki.template.' . $suffix;
298  if ( $suffix !== 'html' && !in_array( $compilerModule, $this->dependencies ) ) {
299  $this->dependencies[] = $compilerModule;
300  }
301  }
302  }
303  }
304 
316  public static function extractBasePaths(
317  $options = [],
318  $localBasePath = null,
319  $remoteBasePath = null
320  ) {
322 
323  // The different ways these checks are done, and their ordering, look very silly,
324  // but were preserved for backwards-compatibility just in case. Tread lightly.
325 
326  if ( $localBasePath === null ) {
328  }
329  if ( $remoteBasePath === null ) {
331  }
332 
333  if ( isset( $options['remoteExtPath'] ) ) {
335  $remoteBasePath = $wgExtensionAssetsPath . '/' . $options['remoteExtPath'];
336  }
337 
338  if ( isset( $options['remoteSkinPath'] ) ) {
340  $remoteBasePath = $wgStylePath . '/' . $options['remoteSkinPath'];
341  }
342 
343  if ( array_key_exists( 'localBasePath', $options ) ) {
344  $localBasePath = (string)$options['localBasePath'];
345  }
346 
347  if ( array_key_exists( 'remoteBasePath', $options ) ) {
348  $remoteBasePath = (string)$options['remoteBasePath'];
349  }
350 
351  return [ $localBasePath, $remoteBasePath ];
352  }
353 
361  $files = $this->getScriptFiles( $context );
362  return $this->getDeprecationInformation() . $this->readScriptFiles( $files );
363  }
364 
370  $urls = [];
371  foreach ( $this->getScriptFiles( $context ) as $file ) {
373  $this->getConfig(),
374  $this->getRemotePath( $file )
375  );
376  }
377  return $urls;
378  }
379 
383  public function supportsURLLoading() {
384  return $this->debugRaw;
385  }
386 
394  $styles = $this->readStyleFiles(
395  $this->getStyleFiles( $context ),
396  $this->getFlip( $context ),
397  $context
398  );
399  // Collect referenced files
400  $this->saveFileDependencies( $context, $this->localFileRefs );
401 
402  return $styles;
403  }
404 
410  if ( $this->hasGeneratedStyles ) {
411  // Do the default behaviour of returning a url back to load.php
412  // but with only=styles.
413  return parent::getStyleURLsForDebug( $context );
414  }
415  // Our module consists entirely of real css files,
416  // in debug mode we can load those directly.
417  $urls = [];
418  foreach ( $this->getStyleFiles( $context ) as $mediaType => $list ) {
419  $urls[$mediaType] = [];
420  foreach ( $list as $file ) {
422  $this->getConfig(),
423  $this->getRemotePath( $file )
424  );
425  }
426  }
427  return $urls;
428  }
429 
435  public function getMessages() {
436  return $this->messages;
437  }
438 
444  public function getGroup() {
445  return $this->group;
446  }
447 
451  public function getPosition() {
452  return $this->position;
453  }
454 
460  public function getDependencies( ResourceLoaderContext $context = null ) {
461  return $this->dependencies;
462  }
463 
469  public function getSkipFunction() {
470  if ( !$this->skipFunction ) {
471  return null;
472  }
473 
474  $localPath = $this->getLocalPath( $this->skipFunction );
475  if ( !file_exists( $localPath ) ) {
476  throw new MWException( __METHOD__ . ": skip function file not found: \"$localPath\"" );
477  }
478  $contents = $this->stripBom( file_get_contents( $localPath ) );
479  if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
480  $contents = $this->validateScriptFile( $localPath, $contents );
481  }
482  return $contents;
483  }
484 
488  public function isRaw() {
489  return $this->raw;
490  }
491 
500  public function enableModuleContentVersion() {
501  return false;
502  }
503 
515  $files = [];
516 
517  // Flatten style files into $files
518  $styles = self::collateFilePathListByOption( $this->styles, 'media', 'all' );
519  foreach ( $styles as $styleFiles ) {
520  $files = array_merge( $files, $styleFiles );
521  }
522 
523  $skinFiles = self::collateFilePathListByOption(
524  self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
525  'media',
526  'all'
527  );
528  foreach ( $skinFiles as $styleFiles ) {
529  $files = array_merge( $files, $styleFiles );
530  }
531 
532  // Final merge, this should result in a master list of dependent files
533  $files = array_merge(
534  $files,
535  $this->scripts,
536  $this->templates,
537  $context->getDebug() ? $this->debugScripts : [],
538  $this->getLanguageScripts( $context->getLanguage() ),
539  self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' )
540  );
541  if ( $this->skipFunction ) {
543  }
544  $files = array_map( [ $this, 'getLocalPath' ], $files );
545  // File deps need to be treated separately because they're already prefixed
546  $files = array_merge( $files, $this->getFileDependencies( $context ) );
547  // Filter out any duplicates from getFileDependencies() and others.
548  // Most commonly introduced by compileLessFile(), which always includes the
549  // entry point Less file we already know about.
550  $files = array_values( array_unique( $files ) );
551 
552  // Don't include keys or file paths here, only the hashes. Including that would needlessly
553  // cause global cache invalidation when files move or if e.g. the MediaWiki path changes.
554  // Any significant ordering is already detected by the definition summary.
555  return array_map( [ __CLASS__, 'safeFileHash' ], $files );
556  }
557 
565  $summary = parent::getDefinitionSummary( $context );
566 
567  $options = [];
568  foreach ( [
569  // The following properties are omitted because they don't affect the module reponse:
570  // - localBasePath (Per T104950; Changes when absolute directory name changes. If
571  // this affects 'scripts' and other file paths, getFileHashes accounts for that.)
572  // - remoteBasePath (Per T104950)
573  // - dependencies (provided via startup module)
574  // - targets
575  // - group (provided via startup module)
576  // - position (only used by OutputPage)
577  'scripts',
578  'debugScripts',
579  'styles',
580  'languageScripts',
581  'skinScripts',
582  'skinStyles',
583  'messages',
584  'templates',
585  'skipFunction',
586  'debugRaw',
587  'raw',
588  ] as $member ) {
589  $options[$member] = $this->{$member};
590  };
591 
592  $summary[] = [
593  'options' => $options,
594  'fileHashes' => $this->getFileHashes( $context ),
595  'messageBlob' => $this->getMessageBlob( $context ),
596  ];
597  return $summary;
598  }
599 
604  protected function getLocalPath( $path ) {
605  if ( $path instanceof ResourceLoaderFilePath ) {
606  return $path->getLocalPath();
607  }
608 
609  return "{$this->localBasePath}/$path";
610  }
611 
616  protected function getRemotePath( $path ) {
617  if ( $path instanceof ResourceLoaderFilePath ) {
618  return $path->getRemotePath();
619  }
620 
621  return "{$this->remoteBasePath}/$path";
622  }
623 
631  public function getStyleSheetLang( $path ) {
632  return preg_match( '/\.less$/i', $path ) ? 'less' : 'css';
633  }
634 
644  protected static function collateFilePathListByOption( array $list, $option, $default ) {
645  $collatedFiles = [];
646  foreach ( (array)$list as $key => $value ) {
647  if ( is_int( $key ) ) {
648  // File name as the value
649  if ( !isset( $collatedFiles[$default] ) ) {
650  $collatedFiles[$default] = [];
651  }
652  $collatedFiles[$default][] = $value;
653  } elseif ( is_array( $value ) ) {
654  // File name as the key, options array as the value
655  $optionValue = isset( $value[$option] ) ? $value[$option] : $default;
656  if ( !isset( $collatedFiles[$optionValue] ) ) {
657  $collatedFiles[$optionValue] = [];
658  }
659  $collatedFiles[$optionValue][] = $key;
660  }
661  }
662  return $collatedFiles;
663  }
664 
674  protected static function tryForKey( array $list, $key, $fallback = null ) {
675  if ( isset( $list[$key] ) && is_array( $list[$key] ) ) {
676  return $list[$key];
677  } elseif ( is_string( $fallback )
678  && isset( $list[$fallback] )
679  && is_array( $list[$fallback] )
680  ) {
681  return $list[$fallback];
682  }
683  return [];
684  }
685 
693  $files = array_merge(
694  $this->scripts,
695  $this->getLanguageScripts( $context->getLanguage() ),
696  self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' )
697  );
698  if ( $context->getDebug() ) {
699  $files = array_merge( $files, $this->debugScripts );
700  }
701 
702  return array_unique( $files, SORT_REGULAR );
703  }
704 
712  private function getLanguageScripts( $lang ) {
713  $scripts = self::tryForKey( $this->languageScripts, $lang );
714  if ( $scripts ) {
715  return $scripts;
716  }
717  $fallbacks = Language::getFallbacksFor( $lang );
718  foreach ( $fallbacks as $lang ) {
719  $scripts = self::tryForKey( $this->languageScripts, $lang );
720  if ( $scripts ) {
721  return $scripts;
722  }
723  }
724 
725  return [];
726  }
727 
735  return array_merge_recursive(
736  self::collateFilePathListByOption( $this->styles, 'media', 'all' ),
737  self::collateFilePathListByOption(
738  self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
739  'media',
740  'all'
741  )
742  );
743  }
744 
752  protected function getSkinStyleFiles( $skinName ) {
753  return self::collateFilePathListByOption(
754  self::tryForKey( $this->skinStyles, $skinName ),
755  'media',
756  'all'
757  );
758  }
759 
766  protected function getAllSkinStyleFiles() {
767  $styleFiles = [];
768  $internalSkinNames = array_keys( Skin::getSkinNames() );
769  $internalSkinNames[] = 'default';
770 
771  foreach ( $internalSkinNames as $internalSkinName ) {
772  $styleFiles = array_merge_recursive(
773  $styleFiles,
774  $this->getSkinStyleFiles( $internalSkinName )
775  );
776  }
777 
778  return $styleFiles;
779  }
780 
786  public function getAllStyleFiles() {
787  $collatedStyleFiles = array_merge_recursive(
788  self::collateFilePathListByOption( $this->styles, 'media', 'all' ),
789  $this->getAllSkinStyleFiles()
790  );
791 
792  $result = [];
793 
794  foreach ( $collatedStyleFiles as $media => $styleFiles ) {
795  foreach ( $styleFiles as $styleFile ) {
796  $result[] = $this->getLocalPath( $styleFile );
797  }
798  }
799 
800  return $result;
801  }
802 
810  protected function readScriptFiles( array $scripts ) {
811  if ( empty( $scripts ) ) {
812  return '';
813  }
814  $js = '';
815  foreach ( array_unique( $scripts, SORT_REGULAR ) as $fileName ) {
816  $localPath = $this->getLocalPath( $fileName );
817  if ( !file_exists( $localPath ) ) {
818  throw new MWException( __METHOD__ . ": script file not found: \"$localPath\"" );
819  }
820  $contents = $this->stripBom( file_get_contents( $localPath ) );
821  if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
822  // Static files don't really need to be checked as often; unlike
823  // on-wiki module they shouldn't change unexpectedly without
824  // admin interference.
825  $contents = $this->validateScriptFile( $fileName, $contents );
826  }
827  $js .= $contents . "\n";
828  }
829  return $js;
830  }
831 
847  public function readStyleFiles( array $styles, $flip, $context = null ) {
848  if ( $context === null ) {
849  wfDeprecated( __METHOD__ . ' without a ResourceLoader context', '1.27' );
851  }
852 
853  if ( empty( $styles ) ) {
854  return [];
855  }
856  foreach ( $styles as $media => $files ) {
857  $uniqueFiles = array_unique( $files, SORT_REGULAR );
858  $styleFiles = [];
859  foreach ( $uniqueFiles as $file ) {
860  $styleFiles[] = $this->readStyleFile( $file, $flip, $context );
861  }
862  $styles[$media] = implode( "\n", $styleFiles );
863  }
864  return $styles;
865  }
866 
879  protected function readStyleFile( $path, $flip, $context ) {
880  $localPath = $this->getLocalPath( $path );
881  $remotePath = $this->getRemotePath( $path );
882  if ( !file_exists( $localPath ) ) {
883  $msg = __METHOD__ . ": style file not found: \"$localPath\"";
884  wfDebugLog( 'resourceloader', $msg );
885  throw new MWException( $msg );
886  }
887 
888  if ( $this->getStyleSheetLang( $localPath ) === 'less' ) {
889  $style = $this->compileLessFile( $localPath, $context );
890  $this->hasGeneratedStyles = true;
891  } else {
892  $style = $this->stripBom( file_get_contents( $localPath ) );
893  }
894 
895  if ( $flip ) {
896  $style = CSSJanus::transform( $style, true, false );
897  }
898  $localDir = dirname( $localPath );
899  $remoteDir = dirname( $remotePath );
900  // Get and register local file references
901  $localFileRefs = CSSMin::getLocalFileReferences( $style, $localDir );
902  foreach ( $localFileRefs as $file ) {
903  if ( file_exists( $file ) ) {
904  $this->localFileRefs[] = $file;
905  } else {
906  $this->missingLocalFileRefs[] = $file;
907  }
908  }
909  // Don't cache this call. remap() ensures data URIs embeds are up to date,
910  // and urls contain correct content hashes in their query string. (T128668)
911  return CSSMin::remap( $style, $localDir, $remoteDir, true );
912  }
913 
919  public function getFlip( $context ) {
920  return $context->getDirection() === 'rtl' && !$this->noflip;
921  }
922 
928  public function getTargets() {
929  return $this->targets;
930  }
931 
938  public function getType() {
939  $canBeStylesOnly = !(
940  // All options except 'styles', 'skinStyles' and 'debugRaw'
941  $this->scripts
942  || $this->debugScripts
943  || $this->templates
944  || $this->languageScripts
945  || $this->skinScripts
946  || $this->dependencies
947  || $this->messages
948  || $this->skipFunction
949  || $this->raw
950  );
951  return $canBeStylesOnly ? self::LOAD_STYLES : self::LOAD_GENERAL;
952  }
953 
966  protected function compileLessFile( $fileName, ResourceLoaderContext $context ) {
967  static $cache;
968 
969  if ( !$cache ) {
971  }
972 
973  // Construct a cache key from the LESS file name and a hash digest
974  // of the LESS variables used for compilation.
975  $vars = $this->getLessVars( $context );
976  ksort( $vars );
977  $varsHash = hash( 'md4', serialize( $vars ) );
978  $cacheKey = $cache->makeGlobalKey( 'LESS', $fileName, $varsHash );
979  $cachedCompile = $cache->get( $cacheKey );
980 
981  // If we got a cached value, we have to validate it by getting a
982  // checksum of all the files that were loaded by the parser and
983  // ensuring it matches the cached entry's.
984  if ( isset( $cachedCompile['hash'] ) ) {
985  $contentHash = FileContentsHasher::getFileContentsHash( $cachedCompile['files'] );
986  if ( $contentHash === $cachedCompile['hash'] ) {
987  $this->localFileRefs = array_merge( $this->localFileRefs, $cachedCompile['files'] );
988  return $cachedCompile['css'];
989  }
990  }
991 
992  $compiler = $context->getResourceLoader()->getLessCompiler( $vars );
993  $css = $compiler->parseFile( $fileName )->getCss();
994  $files = $compiler->AllParsedFiles();
995  $this->localFileRefs = array_merge( $this->localFileRefs, $files );
996 
997  $cache->set( $cacheKey, [
998  'css' => $css,
999  'files' => $files,
1001  ], 60 * 60 * 24 ); // 86400 seconds, or 24 hours.
1002 
1003  return $css;
1004  }
1005 
1011  public function getTemplates() {
1012  $templates = [];
1013 
1014  foreach ( $this->templates as $alias => $templatePath ) {
1015  // Alias is optional
1016  if ( is_int( $alias ) ) {
1017  $alias = $templatePath;
1018  }
1019  $localPath = $this->getLocalPath( $templatePath );
1020  if ( file_exists( $localPath ) ) {
1021  $content = file_get_contents( $localPath );
1022  $templates[$alias] = $this->stripBom( $content );
1023  } else {
1024  $msg = __METHOD__ . ": template file not found: \"$localPath\"";
1025  wfDebugLog( 'resourceloader', $msg );
1026  throw new MWException( $msg );
1027  }
1028  }
1029  return $templates;
1030  }
1031 
1041  protected function stripBom( $input ) {
1042  if ( substr_compare( "\xef\xbb\xbf", $input, 0, 3 ) === 0 ) {
1043  return substr( $input, 3 );
1044  }
1045  return $input;
1046  }
1047 }
getScriptURLsForDebug(ResourceLoaderContext $context)
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
the array() calling protocol came about after MediaWiki 1.4rc1.
string $position
Position on the page to load this module at.
getDeprecationInformation()
Get JS representing deprecation information for the current module if available.
$context
Definition: load.php:50
Abstraction for ResourceLoader modules, with name registration and maxage functionality.
array $dependencies
List of modules this module depends on.
$IP
Definition: WebStart.php:58
static newDummyContext()
Return a dummy ResourceLoaderContext object suitable for passing into things that don't "really" need...
array $skinStyles
List of paths to CSS files to include when using specific skins.
getSkinStyleFiles($skinName)
Gets a list of file paths for all skin styles in the module used by the skin.
getStyleFiles(ResourceLoaderContext $context)
Get a list of file paths for all styles in this module, in order of proper inclusion.
if(!isset($args[0])) $lang
getMessageBlob(ResourceLoaderContext $context)
Get the hash of the message blob.
readStyleFile($path, $flip, $context)
Reads a style file.
static getSkinNames()
Fetch the set of available skins.
Definition: Skin.php:49
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:177
$value
getAllStyleFiles()
Returns all style files and all skin style files used by this module.
$files
getSkipFunction()
Get the skip function.
compileLessFile($fileName, ResourceLoaderContext $context)
Compile a LESS file into CSS.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
array $debugScripts
List of paths to JavaScript files to include in debug mode.
The package scripts
Definition: README.txt:1
static getFallbacksFor($code)
Get the ordered list of fallback languages.
Definition: Language.php:4378
getStyles(ResourceLoaderContext $context)
Get all styles for a given context.
getFlip($context)
Get whether CSS for this module should be flipped.
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 '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. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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!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:1934
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:1230
static getFileContentsHash($filePaths, $algo= 'md4')
Get a hash of the combined contents of one or more files, either by retrieving a previously-computed ...
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 to gather file hashes for getDefinitionSummary.
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
bool $debugRaw
Link to raw files in debug mode.
static array static getLocalFileReferences($source, $path)
Get a list of local files referenced in a stylesheet (includes non-existent files).
Definition: CSSMin.php:69
$wgStylePath
The URL path of the skins directory.
getFileDependencies(ResourceLoaderContext $context)
Get the files this module depends on indirectly for a given skin.
validateScriptFile($fileName, $contents)
Validate a given script file; if valid returns the original source.
enableModuleContentVersion()
Disable module content versioning.
$css
static extractBasePaths($options=[], $localBasePath=null, $remoteBasePath=null)
Extract a pair of local and remote base paths from module definition information. ...
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.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
readScriptFiles(array $scripts)
Gets the contents of a list of JavaScript files.
$summary
string $group
Name of group to load this module in.
readStyleFiles(array $styles, $flip, $context=null)
Gets the contents of a list of CSS files.
array $localFileRefs
Place where readStyleFile() tracks file dependencies.
string $localBasePath
Local base path, see __construct()
$cache
Definition: mcc.php:33
$wgResourceBasePath
The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
getDefinitionSummary(ResourceLoaderContext $context)
Get the definition summary for this module.
wfDeprecated($function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
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.
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:229
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.
getAllSkinStyleFiles()
Gets a list of file paths for all skin style files in the module, for all available skins...
array $scripts
List of paths to JavaScript files to always include.
static getLocalServerInstance($fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition: hooks.txt:1046
$wgExtensionAssetsPath
The URL path of the extensions directory.
array $languageScripts
List of JavaScript files to include when using a specific language.
getStyleSheetLang($path)
Infer the stylesheet language from a stylesheet file path.
getTargets()
Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile'].
const CACHE_ANYTHING
Definition: Defines.php:93
getType()
Get the module's load type.
getScript(ResourceLoaderContext $context)
Gets all scripts for a given context concatenated together.
__construct($options=[], $localBasePath=null, $remoteBasePath=null)
Constructs a new module from an options array.
array $missingLocalFileRefs
Place where readStyleFile() tracks file dependencies for non-existent files.
getLanguageScripts($lang)
Get the set of language scripts for the given language, possibly using a fallback language...
serialize()
Definition: ApiMessage.php:94
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 file paths for all scripts in this module, in order of proper execution.
saveFileDependencies(ResourceLoaderContext $context, $localFileRefs)
Set the files this module depends on indirectly for a given skin.
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2159
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.