3 * Abstraction for ResourceLoader modules.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author Trevor Parscal
22 * @author Roan Kattouw
25 use Psr\Log\LoggerAwareInterface
;
26 use Psr\Log\LoggerInterface
;
27 use Psr\Log\NullLogger
;
30 * Abstraction for ResourceLoader modules, with name registration and maxage functionality.
32 abstract class ResourceLoaderModule
implements LoggerAwareInterface
{
34 const TYPE_SCRIPTS
= 'scripts';
35 const TYPE_STYLES
= 'styles';
36 const TYPE_COMBINED
= 'combined';
39 // Module only has styles (loaded via <style> or <link rel=stylesheet>)
40 const LOAD_STYLES
= 'styles';
41 // Module may have other resources (loaded via mw.loader from a script)
42 const LOAD_GENERAL
= 'general';
44 # sitewide core module like a skin file or jQuery component
45 const ORIGIN_CORE_SITEWIDE
= 1;
47 # per-user module generated by the software
48 const ORIGIN_CORE_INDIVIDUAL
= 2;
50 # sitewide module generated from user-editable files, like MediaWiki:Common.js, or
51 # modules accessible to multiple users, such as those generated by the Gadgets extension.
52 const ORIGIN_USER_SITEWIDE
= 3;
54 # per-user module generated from user-editable files, like User:Me/vector.js
55 const ORIGIN_USER_INDIVIDUAL
= 4;
57 # an access constant; make sure this is kept as the largest number in this group
58 const ORIGIN_ALL
= 10;
60 # script and style modules form a hierarchy of trustworthiness, with core modules like
61 # skins and jQuery as most trustworthy, and user scripts as least trustworthy. We can
62 # limit the types of scripts and styles we allow to load on, say, sensitive special
63 # pages like Special:UserLogin and Special:Preferences
64 protected $origin = self
::ORIGIN_CORE_SITEWIDE
;
66 /* Protected Members */
68 protected $name = null;
69 protected $targets = [ 'desktop' ];
71 // In-object cache for file dependencies
72 protected $fileDeps = [];
73 // In-object cache for message blob (keyed by language)
74 protected $msgBlobs = [];
75 // In-object cache for version hash
76 protected $versionHash = [];
77 // In-object cache for module content
78 protected $contents = [];
88 protected $deprecated = false;
91 * @var LoggerInterface
98 * Get this module's name. This is set when the module is registered
99 * with ResourceLoader::register()
101 * @return string|null Name (string) or null if no name was set
103 public function getName() {
108 * Set this module's name. This is called by ResourceLoader::register()
109 * when registering the module. Other code should not call this.
111 * @param string $name Name
113 public function setName( $name ) {
118 * Get this module's origin. This is set when the module is registered
119 * with ResourceLoader::register()
121 * @return int ResourceLoaderModule class constant, the subclass default
122 * if not set manually
124 public function getOrigin() {
125 return $this->origin
;
129 * @param ResourceLoaderContext $context
132 public function getFlip( $context ) {
135 return $wgContLang->getDir() !== $context->getDirection();
139 * Get JS representing deprecation information for the current module if available
141 * @return string JavaScript code
143 protected function getDeprecationInformation() {
144 $deprecationInfo = $this->deprecated
;
145 if ( $deprecationInfo ) {
146 $name = $this->getName();
147 $warning = 'This page is using the deprecated ResourceLoader module "' . $name . '".';
148 if ( !is_bool( $deprecationInfo ) && isset( $deprecationInfo['message'] ) ) {
149 $warning .= "\n" . $deprecationInfo['message'];
151 return Xml
::encodeJsCall(
161 * Get all JS for this module for a given language and skin.
162 * Includes all relevant JS except loader scripts.
164 * @param ResourceLoaderContext $context
165 * @return string JavaScript code
167 public function getScript( ResourceLoaderContext
$context ) {
168 // Stub, override expected
173 * Takes named templates by the module and returns an array mapping.
175 * @return array of templates mapping template alias to content
177 public function getTemplates() {
178 // Stub, override expected.
186 public function getConfig() {
187 if ( $this->config
=== null ) {
188 // Ugh, fall back to default
189 $this->config
= ConfigFactory
::getDefaultInstance()->makeConfig( 'main' );
192 return $this->config
;
196 * @param Config $config
199 public function setConfig( Config
$config ) {
200 $this->config
= $config;
205 * @param LoggerInterface $logger
208 public function setLogger( LoggerInterface
$logger ) {
209 $this->logger
= $logger;
214 * @return LoggerInterface
216 protected function getLogger() {
217 if ( !$this->logger
) {
218 $this->logger
= new NullLogger();
220 return $this->logger
;
224 * Get the URL or URLs to load for this module's JS in debug mode.
225 * The default behavior is to return a load.php?only=scripts URL for
226 * the module, but file-based modules will want to override this to
227 * load the files directly.
229 * This function is called only when 1) we're in debug mode, 2) there
230 * is no only= parameter and 3) supportsURLLoading() returns true.
231 * #2 is important to prevent an infinite loop, therefore this function
232 * MUST return either an only= URL or a non-load.php URL.
234 * @param ResourceLoaderContext $context
235 * @return array Array of URLs
237 public function getScriptURLsForDebug( ResourceLoaderContext
$context ) {
238 $resourceLoader = $context->getResourceLoader();
239 $derivative = new DerivativeResourceLoaderContext( $context );
240 $derivative->setModules( [ $this->getName() ] );
241 $derivative->setOnly( 'scripts' );
242 $derivative->setDebug( true );
244 $url = $resourceLoader->createLoaderURL(
253 * Whether this module supports URL loading. If this function returns false,
254 * getScript() will be used even in cases (debug mode, no only param) where
255 * getScriptURLsForDebug() would normally be used instead.
258 public function supportsURLLoading() {
263 * Get all CSS for this module for a given skin.
265 * @param ResourceLoaderContext $context
266 * @return array List of CSS strings or array of CSS strings keyed by media type.
267 * like [ 'screen' => '.foo { width: 0 }' ];
268 * or [ 'screen' => [ '.foo { width: 0 }' ] ];
270 public function getStyles( ResourceLoaderContext
$context ) {
271 // Stub, override expected
276 * Get the URL or URLs to load for this module's CSS in debug mode.
277 * The default behavior is to return a load.php?only=styles URL for
278 * the module, but file-based modules will want to override this to
279 * load the files directly. See also getScriptURLsForDebug()
281 * @param ResourceLoaderContext $context
282 * @return array [ mediaType => [ URL1, URL2, ... ], ... ]
284 public function getStyleURLsForDebug( ResourceLoaderContext
$context ) {
285 $resourceLoader = $context->getResourceLoader();
286 $derivative = new DerivativeResourceLoaderContext( $context );
287 $derivative->setModules( [ $this->getName() ] );
288 $derivative->setOnly( 'styles' );
289 $derivative->setDebug( true );
291 $url = $resourceLoader->createLoaderURL(
296 return [ 'all' => [ $url ] ];
300 * Get the messages needed for this module.
302 * To get a JSON blob with messages, use MessageBlobStore::get()
304 * @return array List of message keys. Keys may occur more than once
306 public function getMessages() {
307 // Stub, override expected
312 * Get the group this module is in.
314 * @return string Group name
316 public function getGroup() {
317 // Stub, override expected
322 * Get the origin of this module. Should only be overridden for foreign modules.
324 * @return string Origin name, 'local' for local modules
326 public function getSource() {
327 // Stub, override expected
332 * Where on the HTML page should this module's JS be loaded?
333 * - 'top': in the "<head>"
334 * - 'bottom': at the bottom of the "<body>"
338 public function getPosition() {
343 * Whether this module's JS expects to work without the client-side ResourceLoader module.
344 * Returning true from this function will prevent mw.loader.state() call from being
345 * appended to the bottom of the script.
349 public function isRaw() {
354 * Get a list of modules this module depends on.
356 * Dependency information is taken into account when loading a module
357 * on the client side.
359 * Note: It is expected that $context will be made non-optional in the near
362 * @param ResourceLoaderContext $context
363 * @return array List of module names as strings
365 public function getDependencies( ResourceLoaderContext
$context = null ) {
366 // Stub, override expected
371 * Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']
373 * @return array Array of strings
375 public function getTargets() {
376 return $this->targets
;
380 * Get the module's load type.
383 * @return string ResourceLoaderModule LOAD_* constant
385 public function getType() {
386 return self
::LOAD_GENERAL
;
390 * Get the skip function.
392 * Modules that provide fallback functionality can provide a "skip function". This
393 * function, if provided, will be passed along to the module registry on the client.
394 * When this module is loaded (either directly or as a dependency of another module),
395 * then this function is executed first. If the function returns true, the module will
396 * instantly be considered "ready" without requesting the associated module resources.
398 * The value returned here must be valid javascript for execution in a private function.
399 * It must not contain the "function () {" and "}" wrapper though.
401 * @return string|null A JavaScript function body returning a boolean value, or null
403 public function getSkipFunction() {
408 * Get the files this module depends on indirectly for a given skin.
410 * These are only image files referenced by the module's stylesheet.
412 * @param ResourceLoaderContext $context
413 * @return array List of files
415 protected function getFileDependencies( ResourceLoaderContext
$context ) {
416 $vary = $context->getSkin() . '|' . $context->getLanguage();
418 // Try in-object cache first
419 if ( !isset( $this->fileDeps
[$vary] ) ) {
420 $dbr = wfGetDB( DB_REPLICA
);
421 $deps = $dbr->selectField( 'module_deps',
424 'md_module' => $this->getName(),
430 if ( !is_null( $deps ) ) {
431 $this->fileDeps
[$vary] = self
::expandRelativePaths(
432 (array)FormatJson
::decode( $deps, true )
435 $this->fileDeps
[$vary] = [];
438 return $this->fileDeps
[$vary];
442 * Set in-object cache for file dependencies.
444 * This is used to retrieve data in batches. See ResourceLoader::preloadModuleInfo().
445 * To save the data, use saveFileDependencies().
447 * @param ResourceLoaderContext $context
448 * @param string[] $files Array of file names
450 public function setFileDependencies( ResourceLoaderContext
$context, $files ) {
451 $vary = $context->getSkin() . '|' . $context->getLanguage();
452 $this->fileDeps
[$vary] = $files;
456 * Set the files this module depends on indirectly for a given skin.
459 * @param ResourceLoaderContext $context
460 * @param array $localFileRefs List of files
462 protected function saveFileDependencies( ResourceLoaderContext
$context, $localFileRefs ) {
464 $localFileRefs = array_values( array_unique( $localFileRefs ) );
465 sort( $localFileRefs );
468 // If the list has been modified since last time we cached it, update the cache
469 if ( $localFileRefs !== $this->getFileDependencies( $context ) ) {
470 $cache = ObjectCache
::getLocalClusterInstance();
471 $key = $cache->makeKey( __METHOD__
, $this->getName() );
472 $scopeLock = $cache->getScopedLock( $key, 0 );
474 return; // T124649; avoid write slams
477 $vary = $context->getSkin() . '|' . $context->getLanguage();
478 $dbw = wfGetDB( DB_MASTER
);
479 $dbw->replace( 'module_deps',
480 [ [ 'md_module', 'md_skin' ] ],
482 'md_module' => $this->getName(),
484 // Use relative paths to avoid ghost entries when $IP changes (T111481)
485 'md_deps' => FormatJson
::encode( self
::getRelativePaths( $localFileRefs ) ),
489 if ( $dbw->trxLevel() ) {
490 $dbw->onTransactionResolution( function () use ( &$scopeLock ) {
491 ScopedCallback
::consume( $scopeLock ); // release after commit
495 } catch ( Exception
$e ) {
496 wfDebugLog( 'resourceloader', __METHOD__
. ": failed to update DB: $e" );
501 * Make file paths relative to MediaWiki directory.
503 * This is used to make file paths safe for storing in a database without the paths
504 * becoming stale or incorrect when MediaWiki is moved or upgraded (T111481).
507 * @param array $filePaths
510 public static function getRelativePaths( array $filePaths ) {
512 return array_map( function ( $path ) use ( $IP ) {
513 return RelPath\
getRelativePath( $path, $IP );
518 * Expand directories relative to $IP.
521 * @param array $filePaths
524 public static function expandRelativePaths( array $filePaths ) {
526 return array_map( function ( $path ) use ( $IP ) {
527 return RelPath\
joinPath( $IP, $path );
532 * Get the hash of the message blob.
535 * @param ResourceLoaderContext $context
536 * @return string|null JSON blob or null if module has no messages
538 protected function getMessageBlob( ResourceLoaderContext
$context ) {
539 if ( !$this->getMessages() ) {
540 // Don't bother consulting MessageBlobStore
543 // Message blobs may only vary language, not by context keys
544 $lang = $context->getLanguage();
545 if ( !isset( $this->msgBlobs
[$lang] ) ) {
546 $this->getLogger()->warning( 'Message blob for {module} should have been preloaded', [
547 'module' => $this->getName(),
549 $store = $context->getResourceLoader()->getMessageBlobStore();
550 $this->msgBlobs
[$lang] = $store->getBlob( $this, $lang );
552 return $this->msgBlobs
[$lang];
556 * Set in-object cache for message blobs.
558 * Used to allow fetching of message blobs in batches. See ResourceLoader::preloadModuleInfo().
561 * @param string|null $blob JSON blob or null
562 * @param string $lang Language code
564 public function setMessageBlob( $blob, $lang ) {
565 $this->msgBlobs
[$lang] = $blob;
569 * Get module-specific LESS variables, if any.
572 * @param ResourceLoaderContext $context
573 * @return array Module-specific LESS variables.
575 protected function getLessVars( ResourceLoaderContext
$context ) {
580 * Get an array of this module's resources. Ready for serving to the web.
583 * @param ResourceLoaderContext $context
586 public function getModuleContent( ResourceLoaderContext
$context ) {
587 $contextHash = $context->getHash();
588 // Cache this expensive operation. This calls builds the scripts, styles, and messages
589 // content which typically involves filesystem and/or database access.
590 if ( !array_key_exists( $contextHash, $this->contents
) ) {
591 $this->contents
[$contextHash] = $this->buildContent( $context );
593 return $this->contents
[$contextHash];
597 * Bundle all resources attached to this module into an array.
600 * @param ResourceLoaderContext $context
603 final protected function buildContent( ResourceLoaderContext
$context ) {
604 $rl = $context->getResourceLoader();
605 $stats = RequestContext
::getMain()->getStats();
606 $statStart = microtime( true );
608 // Only include properties that are relevant to this context (e.g. only=scripts)
609 // and that are non-empty (e.g. don't include "templates" for modules without
610 // templates). This helps prevent invalidating cache for all modules when new
611 // optional properties are introduced.
615 if ( $context->shouldIncludeScripts() ) {
616 // If we are in debug mode, we'll want to return an array of URLs if possible
617 // However, we can't do this if the module doesn't support it
618 // We also can't do this if there is an only= parameter, because we have to give
619 // the module a way to return a load.php URL without causing an infinite loop
620 if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
621 $scripts = $this->getScriptURLsForDebug( $context );
623 $scripts = $this->getScript( $context );
624 // rtrim() because there are usually a few line breaks
625 // after the last ';'. A new line at EOF, a new line
626 // added by ResourceLoaderFileModule::readScriptFiles, etc.
627 if ( is_string( $scripts )
628 && strlen( $scripts )
629 && substr( rtrim( $scripts ), -1 ) !== ';'
631 // Append semicolon to prevent weird bugs caused by files not
632 // terminating their statements right (bug 27054)
636 $content['scripts'] = $scripts;
640 if ( $context->shouldIncludeStyles() ) {
642 // Don't create empty stylesheets like [ '' => '' ] for modules
643 // that don't *have* any stylesheets (bug 38024).
644 $stylePairs = $this->getStyles( $context );
645 if ( count( $stylePairs ) ) {
646 // If we are in debug mode without &only= set, we'll want to return an array of URLs
647 // See comment near shouldIncludeScripts() for more details
648 if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
650 'url' => $this->getStyleURLsForDebug( $context )
653 // Minify CSS before embedding in mw.loader.implement call
654 // (unless in debug mode)
655 if ( !$context->getDebug() ) {
656 foreach ( $stylePairs as $media => $style ) {
657 // Can be either a string or an array of strings.
658 if ( is_array( $style ) ) {
659 $stylePairs[$media] = [];
660 foreach ( $style as $cssText ) {
661 if ( is_string( $cssText ) ) {
662 $stylePairs[$media][] =
663 ResourceLoader
::filter( 'minify-css', $cssText );
666 } elseif ( is_string( $style ) ) {
667 $stylePairs[$media] = ResourceLoader
::filter( 'minify-css', $style );
671 // Wrap styles into @media groups as needed and flatten into a numerical array
673 'css' => $rl->makeCombinedStyles( $stylePairs )
677 $content['styles'] = $styles;
681 $blob = $this->getMessageBlob( $context );
683 $content['messagesBlob'] = $blob;
686 $templates = $this->getTemplates();
688 $content['templates'] = $templates;
691 $statTiming = microtime( true ) - $statStart;
692 $statName = strtr( $this->getName(), '.', '_' );
693 $stats->timing( "resourceloader_build.all", 1000 * $statTiming );
694 $stats->timing( "resourceloader_build.$statName", 1000 * $statTiming );
700 * Get a string identifying the current version of this module in a given context.
702 * Whenever anything happens that changes the module's response (e.g. scripts, styles, and
703 * messages) this value must change. This value is used to store module responses in cache.
704 * (Both client-side and server-side.)
706 * It is not recommended to override this directly. Use getDefinitionSummary() instead.
707 * If overridden, one must call the parent getVersionHash(), append data and re-hash.
709 * This method should be quick because it is frequently run by ResourceLoaderStartUpModule to
710 * propagate changes to the client and effectively invalidate cache.
712 * For backward-compatibility, the following optional data providers are automatically included:
714 * - getModifiedTime()
715 * - getModifiedHash()
718 * @param ResourceLoaderContext $context
719 * @return string Hash (should use ResourceLoader::makeHash)
721 public function getVersionHash( ResourceLoaderContext
$context ) {
722 // The startup module produces a manifest with versions representing the entire module.
723 // Typically, the request for the startup module itself has only=scripts. That must apply
724 // only to the startup module content, and not to the module version computed here.
725 $context = new DerivativeResourceLoaderContext( $context );
726 $context->setModules( [] );
727 // Version hash must cover all resources, regardless of startup request itself.
728 $context->setOnly( null );
729 // Compute version hash based on content, not debug urls.
730 $context->setDebug( false );
732 // Cache this somewhat expensive operation. Especially because some classes
733 // (e.g. startup module) iterate more than once over all modules to get versions.
734 $contextHash = $context->getHash();
735 if ( !array_key_exists( $contextHash, $this->versionHash
) ) {
737 if ( $this->enableModuleContentVersion() ) {
738 // Detect changes directly
739 $str = json_encode( $this->getModuleContent( $context ) );
741 // Infer changes based on definition and other metrics
742 $summary = $this->getDefinitionSummary( $context );
743 if ( !isset( $summary['_cacheEpoch'] ) ) {
744 throw new LogicException( 'getDefinitionSummary must call parent method' );
746 $str = json_encode( $summary );
748 $mtime = $this->getModifiedTime( $context );
749 if ( $mtime !== null ) {
750 // Support: MediaWiki 1.25 and earlier
751 $str .= strval( $mtime );
754 $mhash = $this->getModifiedHash( $context );
755 if ( $mhash !== null ) {
756 // Support: MediaWiki 1.25 and earlier
757 $str .= strval( $mhash );
761 $this->versionHash
[$contextHash] = ResourceLoader
::makeHash( $str );
763 return $this->versionHash
[$contextHash];
767 * Whether to generate version hash based on module content.
769 * If a module requires database or file system access to build the module
770 * content, consider disabling this in favour of manually tracking relevant
771 * aspects in getDefinitionSummary(). See getVersionHash() for how this is used.
775 public function enableModuleContentVersion() {
780 * Get the definition summary for this module.
782 * This is the method subclasses are recommended to use to track values in their
783 * version hash. Call this in getVersionHash() and pass it to e.g. json_encode.
785 * Subclasses must call the parent getDefinitionSummary() and build on that.
786 * It is recommended that each subclass appends its own new array. This prevents
787 * clashes or accidental overwrites of existing keys and gives each subclass
788 * its own scope for simple array keys.
791 * $summary = parent::getDefinitionSummary( $context );
799 * Return an array containing values from all significant properties of this
800 * module's definition.
802 * Be careful not to normalise too much. Especially preserve the order of things
803 * that carry significance in getScript and getStyles (T39812).
805 * Avoid including things that are insiginificant (e.g. order of message keys is
806 * insignificant and should be sorted to avoid unnecessary cache invalidation).
808 * This data structure must exclusively contain arrays and scalars as values (avoid
809 * object instances) to allow simple serialisation using json_encode.
811 * If modules have a hash or timestamp from another source, that may be incuded as-is.
813 * A number of utility methods are available to help you gather data. These are not
814 * called by default and must be included by the subclass' getDefinitionSummary().
819 * @param ResourceLoaderContext $context
822 public function getDefinitionSummary( ResourceLoaderContext
$context ) {
824 '_class' => get_class( $this ),
825 '_cacheEpoch' => $this->getConfig()->get( 'CacheEpoch' ),
830 * Get this module's last modification timestamp for a given context.
832 * @deprecated since 1.26 Use getDefinitionSummary() instead
833 * @param ResourceLoaderContext $context Context object
834 * @return int|null UNIX timestamp
836 public function getModifiedTime( ResourceLoaderContext
$context ) {
841 * Helper method for providing a version hash to getVersionHash().
843 * @deprecated since 1.26 Use getDefinitionSummary() instead
844 * @param ResourceLoaderContext $context
845 * @return string|null Hash
847 public function getModifiedHash( ResourceLoaderContext
$context ) {
852 * Back-compat dummy for old subclass implementations of getModifiedTime().
854 * This method used to use ObjectCache to track when a hash was first seen. That principle
855 * stems from a time that ResourceLoader could only identify module versions by timestamp.
856 * That is no longer the case. Use getDefinitionSummary() directly.
858 * @deprecated since 1.26 Superseded by getVersionHash()
859 * @param ResourceLoaderContext $context
860 * @return int UNIX timestamp
862 public function getHashMtime( ResourceLoaderContext
$context ) {
863 if ( !is_string( $this->getModifiedHash( $context ) ) ) {
871 * Back-compat dummy for old subclass implementations of getModifiedTime().
874 * @deprecated since 1.26 Superseded by getVersionHash()
875 * @param ResourceLoaderContext $context
876 * @return int UNIX timestamp
878 public function getDefinitionMtime( ResourceLoaderContext
$context ) {
879 if ( $this->getDefinitionSummary( $context ) === null ) {
887 * Check whether this module is known to be empty. If a child class
888 * has an easy and cheap way to determine that this module is
889 * definitely going to be empty, it should override this method to
890 * return true in that case. Callers may optimize the request for this
891 * module away if this function returns true.
892 * @param ResourceLoaderContext $context
895 public function isKnownEmpty( ResourceLoaderContext
$context ) {
899 /** @var JSParser Lazy-initialized; use self::javaScriptParser() */
900 private static $jsParser;
901 private static $parseCacheVersion = 1;
904 * Validate a given script file; if valid returns the original source.
905 * If invalid, returns replacement JS source that throws an exception.
907 * @param string $fileName
908 * @param string $contents
909 * @return string JS with the original, or a replacement error
911 protected function validateScriptFile( $fileName, $contents ) {
912 if ( $this->getConfig()->get( 'ResourceLoaderValidateJS' ) ) {
914 $cache = ObjectCache
::getMainWANInstance();
915 $key = $cache->makeKey(
918 self
::$parseCacheVersion,
921 $cacheEntry = $cache->get( $key );
922 if ( is_string( $cacheEntry ) ) {
926 $parser = self
::javaScriptParser();
928 $parser->parse( $contents, $fileName, 1 );
930 } catch ( Exception
$e ) {
931 // We'll save this to cache to avoid having to validate broken JS over and over...
932 $err = $e->getMessage();
933 $result = "mw.log.error(" .
934 Xml
::encodeJsVar( "JavaScript parse error: $err" ) . ");";
937 $cache->set( $key, $result );
947 protected static function javaScriptParser() {
948 if ( !self
::$jsParser ) {
949 self
::$jsParser = new JSParser();
951 return self
::$jsParser;
955 * Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist.
958 * @param string $filePath File path
959 * @return int UNIX timestamp
961 protected static function safeFilemtime( $filePath ) {
962 MediaWiki\
suppressWarnings();
963 $mtime = filemtime( $filePath ) ?
: 1;
964 MediaWiki\restoreWarnings
();
969 * Compute a non-cryptographic string hash of a file's contents.
970 * If the file does not exist or cannot be read, returns an empty string.
972 * @since 1.26 Uses MD4 instead of SHA1.
973 * @param string $filePath File path
974 * @return string Hash
976 protected static function safeFileHash( $filePath ) {
977 return FileContentsHasher
::getFileContentsHash( $filePath );