3 * Abstraction for resource loader 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
26 * Abstraction for resource loader modules, with name registration and maxage functionality.
28 abstract class ResourceLoaderModule
{
30 const TYPE_SCRIPTS
= 'scripts';
31 const TYPE_STYLES
= 'styles';
32 const TYPE_COMBINED
= 'combined';
34 # sitewide core module like a skin file or jQuery component
35 const ORIGIN_CORE_SITEWIDE
= 1;
37 # per-user module generated by the software
38 const ORIGIN_CORE_INDIVIDUAL
= 2;
40 # sitewide module generated from user-editable files, like MediaWiki:Common.js, or
41 # modules accessible to multiple users, such as those generated by the Gadgets extension.
42 const ORIGIN_USER_SITEWIDE
= 3;
44 # per-user module generated from user-editable files, like User:Me/vector.js
45 const ORIGIN_USER_INDIVIDUAL
= 4;
47 # an access constant; make sure this is kept as the largest number in this group
48 const ORIGIN_ALL
= 10;
50 # script and style modules form a hierarchy of trustworthiness, with core modules like
51 # skins and jQuery as most trustworthy, and user scripts as least trustworthy. We can
52 # limit the types of scripts and styles we allow to load on, say, sensitive special
53 # pages like Special:UserLogin and Special:Preferences
54 protected $origin = self
::ORIGIN_CORE_SITEWIDE
;
56 /* Protected Members */
58 protected $name = null;
59 protected $targets = array( 'desktop' );
61 // In-object cache for file dependencies
62 protected $fileDeps = array();
63 // In-object cache for message blob mtime
64 protected $msgBlobMtime = array();
65 // In-object cache for version hash
66 protected $versionHash = array();
67 // In-object cache for module content
68 protected $contents = array();
70 // Whether the position returned by getPosition() is defined in the module configuration
71 // and not a default value
72 protected $isPositionDefined = false;
82 * Get this module's name. This is set when the module is registered
83 * with ResourceLoader::register()
85 * @return string|null Name (string) or null if no name was set
87 public function getName() {
92 * Set this module's name. This is called by ResourceLoader::register()
93 * when registering the module. Other code should not call this.
95 * @param string $name Name
97 public function setName( $name ) {
102 * Get this module's origin. This is set when the module is registered
103 * with ResourceLoader::register()
105 * @return int ResourceLoaderModule class constant, the subclass default
106 * if not set manually
108 public function getOrigin() {
109 return $this->origin
;
113 * Set this module's origin. This is called by ResourceLoader::register()
114 * when registering the module. Other code should not call this.
116 * @param int $origin Origin
118 public function setOrigin( $origin ) {
119 $this->origin
= $origin;
123 * @param ResourceLoaderContext $context
126 public function getFlip( $context ) {
129 return $wgContLang->getDir() !== $context->getDirection();
133 * Get all JS for this module for a given language and skin.
134 * Includes all relevant JS except loader scripts.
136 * @param ResourceLoaderContext $context
137 * @return string JavaScript code
139 public function getScript( ResourceLoaderContext
$context ) {
140 // Stub, override expected
145 * Takes named templates by the module and returns an array mapping.
147 * @return array of templates mapping template alias to content
149 public function getTemplates() {
150 // Stub, override expected.
158 public function getConfig() {
159 if ( $this->config
=== null ) {
160 // Ugh, fall back to default
161 $this->config
= ConfigFactory
::getDefaultInstance()->makeConfig( 'main' );
164 return $this->config
;
168 * @param Config $config
171 public function setConfig( Config
$config ) {
172 $this->config
= $config;
176 * Get the URL or URLs to load for this module's JS in debug mode.
177 * The default behavior is to return a load.php?only=scripts URL for
178 * the module, but file-based modules will want to override this to
179 * load the files directly.
181 * This function is called only when 1) we're in debug mode, 2) there
182 * is no only= parameter and 3) supportsURLLoading() returns true.
183 * #2 is important to prevent an infinite loop, therefore this function
184 * MUST return either an only= URL or a non-load.php URL.
186 * @param ResourceLoaderContext $context
187 * @return array Array of URLs
189 public function getScriptURLsForDebug( ResourceLoaderContext
$context ) {
190 $resourceLoader = $context->getResourceLoader();
191 $derivative = new DerivativeResourceLoaderContext( $context );
192 $derivative->setModules( array( $this->getName() ) );
193 $derivative->setOnly( 'scripts' );
194 $derivative->setDebug( true );
196 $url = $resourceLoader->createLoaderURL(
201 return array( $url );
205 * Whether this module supports URL loading. If this function returns false,
206 * getScript() will be used even in cases (debug mode, no only param) where
207 * getScriptURLsForDebug() would normally be used instead.
210 public function supportsURLLoading() {
215 * Get all CSS for this module for a given skin.
217 * @param ResourceLoaderContext $context
218 * @return array List of CSS strings or array of CSS strings keyed by media type.
219 * like array( 'screen' => '.foo { width: 0 }' );
220 * or array( 'screen' => array( '.foo { width: 0 }' ) );
222 public function getStyles( ResourceLoaderContext
$context ) {
223 // Stub, override expected
228 * Get the URL or URLs to load for this module's CSS in debug mode.
229 * The default behavior is to return a load.php?only=styles URL for
230 * the module, but file-based modules will want to override this to
231 * load the files directly. See also getScriptURLsForDebug()
233 * @param ResourceLoaderContext $context
234 * @return array Array( mediaType => array( URL1, URL2, ... ), ... )
236 public function getStyleURLsForDebug( ResourceLoaderContext
$context ) {
237 $resourceLoader = $context->getResourceLoader();
238 $derivative = new DerivativeResourceLoaderContext( $context );
239 $derivative->setModules( array( $this->getName() ) );
240 $derivative->setOnly( 'styles' );
241 $derivative->setDebug( true );
243 $url = $resourceLoader->createLoaderURL(
248 return array( 'all' => array( $url ) );
252 * Get the messages needed for this module.
254 * To get a JSON blob with messages, use MessageBlobStore::get()
256 * @return array List of message keys. Keys may occur more than once
258 public function getMessages() {
259 // Stub, override expected
264 * Get the group this module is in.
266 * @return string Group name
268 public function getGroup() {
269 // Stub, override expected
274 * Get the origin of this module. Should only be overridden for foreign modules.
276 * @return string Origin name, 'local' for local modules
278 public function getSource() {
279 // Stub, override expected
284 * Where on the HTML page should this module's JS be loaded?
285 * - 'top': in the "<head>"
286 * - 'bottom': at the bottom of the "<body>"
290 public function getPosition() {
295 * Whether the position returned by getPosition() is a default value or comes from the module
296 * definition. This method is meant to be short-lived, and is only useful until classes added
297 * via addModuleStyles with a default value define an explicit position. See getModuleStyles()
298 * in OutputPage for the related migration warning.
303 public function isPositionDefault() {
304 return !$this->isPositionDefined
;
308 * Whether this module's JS expects to work without the client-side ResourceLoader module.
309 * Returning true from this function will prevent mw.loader.state() call from being
310 * appended to the bottom of the script.
314 public function isRaw() {
319 * Get the loader JS for this module, if set.
321 * @return mixed JavaScript loader code as a string or boolean false if no custom loader set
323 public function getLoaderScript() {
324 // Stub, override expected
329 * Get a list of modules this module depends on.
331 * Dependency information is taken into account when loading a module
332 * on the client side.
334 * To add dependencies dynamically on the client side, use a custom
335 * loader script, see getLoaderScript()
337 * Note: It is expected that $context will be made non-optional in the near
340 * @param ResourceLoaderContext $context
341 * @return array List of module names as strings
343 public function getDependencies( ResourceLoaderContext
$context = null ) {
344 // Stub, override expected
349 * Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']
351 * @return array Array of strings
353 public function getTargets() {
354 return $this->targets
;
358 * Get the skip function.
360 * Modules that provide fallback functionality can provide a "skip function". This
361 * function, if provided, will be passed along to the module registry on the client.
362 * When this module is loaded (either directly or as a dependency of another module),
363 * then this function is executed first. If the function returns true, the module will
364 * instantly be considered "ready" without requesting the associated module resources.
366 * The value returned here must be valid javascript for execution in a private function.
367 * It must not contain the "function () {" and "}" wrapper though.
369 * @return string|null A JavaScript function body returning a boolean value, or null
371 public function getSkipFunction() {
376 * Get the files this module depends on indirectly for a given skin.
378 * These are only image files referenced by the module's stylesheet.
380 * @param ResourceLoaderContext $context
381 * @return array List of files
383 protected function getFileDependencies( ResourceLoaderContext
$context ) {
384 $vary = $context->getSkin() . '|' . $context->getLanguage();
386 // Try in-object cache first
387 if ( !isset( $this->fileDeps
[$vary] ) ) {
388 $dbr = wfGetDB( DB_SLAVE
);
389 $deps = $dbr->selectField( 'module_deps',
392 'md_module' => $this->getName(),
398 if ( !is_null( $deps ) ) {
399 $this->fileDeps
[$vary] = self
::expandRelativePaths(
400 (array)FormatJson
::decode( $deps, true )
403 $this->fileDeps
[$vary] = array();
406 return $this->fileDeps
[$vary];
410 * Set in-object cache for file dependencies.
412 * This is used to retrieve data in batches. See ResourceLoader::preloadModuleInfo().
413 * To save the data, use saveFileDependencies().
415 * @param string $skin Skin name
416 * @param array $deps Array of file names
418 public function setFileDependencies( ResourceLoaderContext
$context, $files ) {
419 $vary = $context->getSkin() . '|' . $context->getLanguage();
420 $this->fileDeps
[$vary] = $files;
424 * Set the files this module depends on indirectly for a given skin.
427 * @param ResourceLoaderContext $context
428 * @param array $localFileRefs List of files
430 protected function saveFileDependencies( ResourceLoaderContext
$context, $localFileRefs ) {
432 $localFileRefs = array_values( array_unique( $localFileRefs ) );
433 sort( $localFileRefs );
436 // If the list has been modified since last time we cached it, update the cache
437 if ( $localFileRefs !== $this->getFileDependencies( $context ) ) {
438 $vary = $context->getSkin() . '|' . $context->getLanguage();
439 $dbw = wfGetDB( DB_MASTER
);
440 $dbw->replace( 'module_deps',
441 array( array( 'md_module', 'md_skin' ) ), array(
442 'md_module' => $this->getName(),
444 // Use relative paths to avoid ghost entries when $IP changes (T111481)
445 'md_deps' => FormatJson
::encode( self
::getRelativePaths( $localFileRefs ) ),
449 } catch ( Exception
$e ) {
450 wfDebugLog( 'resourceloader', __METHOD__
. ": failed to update DB: $e" );
455 * Make file paths relative to MediaWiki directory.
457 * This is used to make file paths safe for storing in a database without the paths
458 * becoming stale or incorrect when MediaWiki is moved or upgraded (T111481).
461 * @param array $filePaths
464 public static function getRelativePaths( Array $filePaths ) {
466 return array_map( function ( $path ) use ( $IP ) {
467 return RelPath\
getRelativePath( $path, $IP );
472 * Expand directories relative to $IP.
475 * @param array $filePaths
478 public static function expandRelativePaths( Array $filePaths ) {
480 return array_map( function ( $path ) use ( $IP ) {
481 return RelPath\
joinPath( $IP, $path );
486 * Get the last modification timestamp of the messages in this module for a given language.
487 * @param string $lang Language code
488 * @return int UNIX timestamp
490 public function getMsgBlobMtime( $lang ) {
491 if ( !isset( $this->msgBlobMtime
[$lang] ) ) {
492 if ( !count( $this->getMessages() ) ) {
496 $dbr = wfGetDB( DB_SLAVE
);
497 $msgBlobMtime = $dbr->selectField( 'msg_resource',
500 'mr_resource' => $this->getName(),
505 // If no blob was found, but the module does have messages, that means we need
506 // to regenerate it. Return NOW
507 if ( $msgBlobMtime === false ) {
508 $msgBlobMtime = wfTimestampNow();
510 $this->msgBlobMtime
[$lang] = wfTimestamp( TS_UNIX
, $msgBlobMtime );
512 return $this->msgBlobMtime
[$lang];
516 * Set in-object cache for message blob time.
518 * This is used to retrieve data in batches. See ResourceLoader::preloadModuleInfo().
520 * @param string $lang Language code
521 * @param int $mtime UNIX timestamp
523 public function setMsgBlobMtime( $lang, $mtime ) {
524 $this->msgBlobMtime
[$lang] = $mtime;
528 * Get module-specific LESS variables, if any.
531 * @param ResourceLoaderContext $context
532 * @return array Module-specific LESS variables.
534 protected function getLessVars( ResourceLoaderContext
$context ) {
539 * Get an array of this module's resources. Ready for serving to the web.
542 * @param ResourceLoaderContext $context
545 public function getModuleContent( ResourceLoaderContext
$context ) {
546 $contextHash = $context->getHash();
547 // Cache this expensive operation. This calls builds the scripts, styles, and messages
548 // content which typically involves filesystem and/or database access.
549 if ( !array_key_exists( $contextHash, $this->contents
) ) {
550 $this->contents
[$contextHash] = $this->buildContent( $context );
552 return $this->contents
[$contextHash];
556 * Bundle all resources attached to this module into an array.
559 * @param ResourceLoaderContext $context
562 final protected function buildContent( ResourceLoaderContext
$context ) {
563 $rl = $context->getResourceLoader();
564 $stats = RequestContext
::getMain()->getStats();
565 $statStart = microtime( true );
567 // Only include properties that are relevant to this context (e.g. only=scripts)
568 // and that are non-empty (e.g. don't include "templates" for modules without
569 // templates). This helps prevent invalidating cache for all modules when new
570 // optional properties are introduced.
574 if ( $context->shouldIncludeScripts() ) {
575 // If we are in debug mode, we'll want to return an array of URLs if possible
576 // However, we can't do this if the module doesn't support it
577 // We also can't do this if there is an only= parameter, because we have to give
578 // the module a way to return a load.php URL without causing an infinite loop
579 if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
580 $scripts = $this->getScriptURLsForDebug( $context );
582 $scripts = $this->getScript( $context );
583 // rtrim() because there are usually a few line breaks
584 // after the last ';'. A new line at EOF, a new line
585 // added by ResourceLoaderFileModule::readScriptFiles, etc.
586 if ( is_string( $scripts )
587 && strlen( $scripts )
588 && substr( rtrim( $scripts ), -1 ) !== ';'
590 // Append semicolon to prevent weird bugs caused by files not
591 // terminating their statements right (bug 27054)
595 $content['scripts'] = $scripts;
599 if ( $context->shouldIncludeStyles() ) {
601 // Don't create empty stylesheets like array( '' => '' ) for modules
602 // that don't *have* any stylesheets (bug 38024).
603 $stylePairs = $this->getStyles( $context );
604 if ( count( $stylePairs ) ) {
605 // If we are in debug mode without &only= set, we'll want to return an array of URLs
606 // See comment near shouldIncludeScripts() for more details
607 if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
609 'url' => $this->getStyleURLsForDebug( $context )
612 // Minify CSS before embedding in mw.loader.implement call
613 // (unless in debug mode)
614 if ( !$context->getDebug() ) {
615 foreach ( $stylePairs as $media => $style ) {
616 // Can be either a string or an array of strings.
617 if ( is_array( $style ) ) {
618 $stylePairs[$media] = array();
619 foreach ( $style as $cssText ) {
620 if ( is_string( $cssText ) ) {
621 $stylePairs[$media][] =
622 ResourceLoader
::filter( 'minify-css', $cssText );
625 } elseif ( is_string( $style ) ) {
626 $stylePairs[$media] = ResourceLoader
::filter( 'minify-css', $style );
630 // Wrap styles into @media groups as needed and flatten into a numerical array
632 'css' => $rl->makeCombinedStyles( $stylePairs )
636 $content['styles'] = $styles;
640 $blobs = $rl->getMessageBlobStore()->get(
642 array( $this->getName() => $this ),
643 $context->getLanguage()
645 if ( isset( $blobs[$this->getName()] ) ) {
646 $content['messagesBlob'] = $blobs[$this->getName()];
649 $templates = $this->getTemplates();
651 $content['templates'] = $templates;
654 $statTiming = microtime( true ) - $statStart;
655 $statName = strtr( $this->getName(), '.', '_' );
656 $stats->timing( "resourceloader_build.all", 1000 * $statTiming );
657 $stats->timing( "resourceloader_build.$statName", 1000 * $statTiming );
663 * Get a string identifying the current version of this module in a given context.
665 * Whenever anything happens that changes the module's response (e.g. scripts, styles, and
666 * messages) this value must change. This value is used to store module responses in cache.
667 * (Both client-side and server-side.)
669 * It is not recommended to override this directly. Use getDefinitionSummary() instead.
670 * If overridden, one must call the parent getVersionHash(), append data and re-hash.
672 * This method should be quick because it is frequently run by ResourceLoaderStartUpModule to
673 * propagate changes to the client and effectively invalidate cache.
675 * For backward-compatibility, the following optional data providers are automatically included:
677 * - getModifiedTime()
678 * - getModifiedHash()
681 * @param ResourceLoaderContext $context
682 * @return string Hash (should use ResourceLoader::makeHash)
684 public function getVersionHash( ResourceLoaderContext
$context ) {
685 // The startup module produces a manifest with versions representing the entire module.
686 // Typically, the request for the startup module itself has only=scripts. That must apply
687 // only to the startup module content, and not to the module version computed here.
688 $context = new DerivativeResourceLoaderContext( $context );
689 $context->setModules( array() );
690 // Version hash must cover all resources, regardless of startup request itself.
691 $context->setOnly( null );
692 // Compute version hash based on content, not debug urls.
693 $context->setDebug( false );
695 // Cache this somewhat expensive operation. Especially because some classes
696 // (e.g. startup module) iterate more than once over all modules to get versions.
697 $contextHash = $context->getHash();
698 if ( !array_key_exists( $contextHash, $this->versionHash
) ) {
700 if ( $this->enableModuleContentVersion() ) {
701 // Detect changes directly
702 $str = json_encode( $this->getModuleContent( $context ) );
704 // Infer changes based on definition and other metrics
705 $summary = $this->getDefinitionSummary( $context );
706 if ( !isset( $summary['_cacheEpoch'] ) ) {
707 throw new LogicException( 'getDefinitionSummary must call parent method' );
709 $str = json_encode( $summary );
711 $mtime = $this->getModifiedTime( $context );
712 if ( $mtime !== null ) {
713 // Support: MediaWiki 1.25 and earlier
714 $str .= strval( $mtime );
717 $mhash = $this->getModifiedHash( $context );
718 if ( $mhash !== null ) {
719 // Support: MediaWiki 1.25 and earlier
720 $str .= strval( $mhash );
724 $this->versionHash
[$contextHash] = ResourceLoader
::makeHash( $str );
726 return $this->versionHash
[$contextHash];
730 * Whether to generate version hash based on module content.
732 * If a module requires database or file system access to build the module
733 * content, consider disabling this in favour of manually tracking relevant
734 * aspects in getDefinitionSummary(). See getVersionHash() for how this is used.
738 public function enableModuleContentVersion() {
743 * Get the definition summary for this module.
745 * This is the method subclasses are recommended to use to track values in their
746 * version hash. Call this in getVersionHash() and pass it to e.g. json_encode.
748 * Subclasses must call the parent getDefinitionSummary() and build on that.
749 * It is recommended that each subclass appends its own new array. This prevents
750 * clashes or accidental overwrites of existing keys and gives each subclass
751 * its own scope for simple array keys.
754 * $summary = parent::getDefinitionSummary( $context );
755 * $summary[] = array(
762 * Return an array containing values from all significant properties of this
763 * module's definition.
765 * Be careful not to normalise too much. Especially preserve the order of things
766 * that carry significance in getScript and getStyles (T39812).
768 * Avoid including things that are insiginificant (e.g. order of message keys is
769 * insignificant and should be sorted to avoid unnecessary cache invalidation).
771 * This data structure must exclusively contain arrays and scalars as values (avoid
772 * object instances) to allow simple serialisation using json_encode.
774 * If modules have a hash or timestamp from another source, that may be incuded as-is.
776 * A number of utility methods are available to help you gather data. These are not
777 * called by default and must be included by the subclass' getDefinitionSummary().
779 * - getMsgBlobMtime()
782 * @param ResourceLoaderContext $context
785 public function getDefinitionSummary( ResourceLoaderContext
$context ) {
787 '_class' => get_class( $this ),
788 '_cacheEpoch' => $this->getConfig()->get( 'CacheEpoch' ),
793 * Get this module's last modification timestamp for a given context.
795 * @deprecated since 1.26 Use getDefinitionSummary() instead
796 * @param ResourceLoaderContext $context Context object
797 * @return int|null UNIX timestamp
799 public function getModifiedTime( ResourceLoaderContext
$context ) {
804 * Helper method for providing a version hash to getVersionHash().
806 * @deprecated since 1.26 Use getDefinitionSummary() instead
807 * @param ResourceLoaderContext $context
808 * @return string|null Hash
810 public function getModifiedHash( ResourceLoaderContext
$context ) {
815 * Back-compat dummy for old subclass implementations of getModifiedTime().
817 * This method used to use ObjectCache to track when a hash was first seen. That principle
818 * stems from a time that ResourceLoader could only identify module versions by timestamp.
819 * That is no longer the case. Use getDefinitionSummary() directly.
821 * @deprecated since 1.26 Superseded by getVersionHash()
822 * @param ResourceLoaderContext $context
823 * @return int UNIX timestamp
825 public function getHashMtime( ResourceLoaderContext
$context ) {
826 if ( !is_string( $this->getModifiedHash( $context ) ) ) {
834 * Back-compat dummy for old subclass implementations of getModifiedTime().
837 * @deprecated since 1.26 Superseded by getVersionHash()
838 * @param ResourceLoaderContext $context
839 * @return int UNIX timestamp
841 public function getDefinitionMtime( ResourceLoaderContext
$context ) {
842 if ( $this->getDefinitionSummary( $context ) === null ) {
850 * Check whether this module is known to be empty. If a child class
851 * has an easy and cheap way to determine that this module is
852 * definitely going to be empty, it should override this method to
853 * return true in that case. Callers may optimize the request for this
854 * module away if this function returns true.
855 * @param ResourceLoaderContext $context
858 public function isKnownEmpty( ResourceLoaderContext
$context ) {
862 /** @var JSParser Lazy-initialized; use self::javaScriptParser() */
863 private static $jsParser;
864 private static $parseCacheVersion = 1;
867 * Validate a given script file; if valid returns the original source.
868 * If invalid, returns replacement JS source that throws an exception.
870 * @param string $fileName
871 * @param string $contents
872 * @return string JS with the original, or a replacement error
874 protected function validateScriptFile( $fileName, $contents ) {
875 if ( $this->getConfig()->get( 'ResourceLoaderValidateJS' ) ) {
877 // Use CACHE_ANYTHING since parsing JS is much slower than a DB query
881 self
::$parseCacheVersion,
884 $cache = wfGetCache( CACHE_ANYTHING
);
885 $cacheEntry = $cache->get( $key );
886 if ( is_string( $cacheEntry ) ) {
890 $parser = self
::javaScriptParser();
892 $parser->parse( $contents, $fileName, 1 );
894 } catch ( Exception
$e ) {
895 // We'll save this to cache to avoid having to validate broken JS over and over...
896 $err = $e->getMessage();
897 $result = "mw.log.error(" .
898 Xml
::encodeJsVar( "JavaScript parse error: $err" ) . ");";
901 $cache->set( $key, $result );
911 protected static function javaScriptParser() {
912 if ( !self
::$jsParser ) {
913 self
::$jsParser = new JSParser();
915 return self
::$jsParser;
919 * Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist.
922 * @param string $filePath File path
923 * @return int UNIX timestamp
925 protected static function safeFilemtime( $filePath ) {
926 MediaWiki\
suppressWarnings();
927 $mtime = filemtime( $filePath ) ?
: 1;
928 MediaWiki\restoreWarnings
();
933 * Compute a non-cryptographic string hash of a file's contents.
934 * If the file does not exist or cannot be read, returns an empty string.
936 * @since 1.26 Uses MD4 instead of SHA1.
937 * @param string $filePath File path
938 * @return string Hash
940 protected static function safeFileHash( $filePath ) {
941 return FileContentsHasher
::getFileContentsHash( $filePath );