feature: add Cache expiry settings

README.md

@@ -153,6 +153,25 @@ $wgExternalContentBasicAuthCredentials = [
 The above example shows how you can get credentials from ENV vars, which might be preferred over
 storing them as plaintext in [LocalSettings.php].
 
+### Disable Caching
+
+Variable: `$wgExternalContentDisableCache`
+
+Default: `false`
+
+Note: changing this to `true` is NOT advised. It will have a negative effect on performance since every page view where External Content
+is used will require an external file fetch.
+
+### Default Content Cache Expiry
+
+Variable: `$wgExternalContentDefaultExpiry`
+
+Default: `86400` (24 hours)
+
+Example: `604800` (1 week) `0` (no caching)
+
+See also: run the [maintenance script](#refreshing-external-content) to expire the cache for all External Content
+
 ### Connection details
 
 Content of files is fetched via MediaWiki's native HTTP client. This process is affected by

extension.json

@@ -1,6 +1,6 @@
 {
 	"name": "External Content",
-	"version": "1.3.0",
+	"version": "1.4.0",
 	"license-name": "GPL-2.0-or-later",
 
 	"author": [
@@ -39,6 +39,14 @@
 		"ExternalContentBasicAuthCredentials": {
 			"description": "Per-domain Basic Auth credentials.",
 			"value": []
+		},
+		"ExternalContentDisableCache": {
+			"description": "Disable caching of external content. '''Use with caution''' as this forces a remote file fetch on every page view where this extension is used!",
+			"value": false
+		},
+		"ExternalContentDefaultExpiry": {
+			"description": "Default content expiry in seconds (86400 = 1 day). This will only have an effect if lower than MediaWiki's default sitewide [https://www.mediawiki.org/wiki/Manual:$wgParserCacheExpireTime $wgParserCacheExpireTime]",
+			"value": 86400
 		}
 	},
 

src/EmbedExtensionFactory.php

@@ -29,6 +29,8 @@ class EmbedExtensionFactory {
 		'ExternalContentFileExtensionWhitelist' => [ 'md' ],
 		'wgExternalContentEnableEmbedFunction' => true,
 		'wgExternalContentEnableBitbucketFunction' => true,
+		'ExternalContentDefaultExpiry' => 86400,
+		'ExternalContentDisableCache' => false,
 	];
 
 	protected static ?self $instance;

src/EntryPoints/MediaWikiHooks.php

@@ -15,6 +15,14 @@
 final class MediaWikiHooks {
 
 	public static function onParserFirstCallInit( Parser $parser ): void {
+		if ( $parser ) {
+			if ( self::cacheIsDisabled() ) {
+				$parser->getOutput()->updateCacheExpiry( 0 );
+				// We only need to set the External Content cache expiry if it is lower than the sitewide expiry
+			} elseif ( is_int( self::getCacheExpiry() ) && !self::hasReducedExpiry() ) {
+				$parser->getOutput()->updateCacheExpiry( self::getCacheExpiry() );
+			}
+		}
 		if ( self::embedFunctionIsEnabled() ) {
 			$parser->setFunctionHook(
 				'embed',
@@ -32,6 +40,22 @@ public static function onParserFirstCallInit( Parser $parser ): void {
 		}
 	}
 
+	/**
+	 * Compatibility shim for hasReducedExpiry() coming in 1.37
+	 */
+	private static function hasReducedExpiry(): bool {
+		$parserCacheExpireTime = MediaWikiServices::getInstance()->getMainConfig()->get( 'ParserCacheExpireTime' );
+		return self::getCacheExpiry() < $parserCacheExpireTime;
+	}
+
+	private static function cacheIsDisabled(): bool {
+		return MediaWikiServices::getInstance()->getMainConfig()->get( 'ExternalContentDisableCache' );
+	}
+
+	private static function getCacheExpiry(): int {
+		return MediaWikiServices::getInstance()->getMainConfig()->get( 'ExternalContentDefaultExpiry' );
+	}
+
 	/**
 	 * @psalm-suppress MixedInferredReturnType
 	 * @psalm-suppress MixedReturnStatement