add cache clearing on image update

Author: selul

inc/admin.php

@@ -74,6 +74,7 @@ public function __construct() {
 			add_action( 'updated_post_meta', [ $this, 'detect_image_alt_change' ], 10, 4 );
 			add_action( 'added_post_meta', [ $this, 'detect_image_alt_change' ], 10, 4 );
 			add_action( 'init', [ $this, 'schedule_data_enhance_cron' ] );
+			add_filter( 'update_attached_file', [ $this, 'listen_update_file' ], 999, 2 );
 		}
 		add_action( 'init', [ $this, 'update_default_settings' ] );
 		add_action( 'init', [ $this, 'update_limit_dimensions' ] );
@@ -98,6 +99,21 @@ public function __construct() {
 
 		add_filter( 'themeisle-sdk/survey/' . OPTML_PRODUCT_SLUG, [ $this, 'get_survey_metadata' ], 10, 2 );
 	}
+
+	/**
+	 * Listen when the file is updated and clear the cache for the file.
+	 *
+	 * @param string $file The file path.
+	 * @param int    $post_id The post ID.
+	 *
+	 * @return string The file path.
+	 */
+	public function listen_update_file( $file, $post_id ) {
+		$basename = wp_basename( $file );
+		$settings = new Optml_Settings();
+		$settings->clear_cache( $basename );
+		return $file;
+	}
 	/**
 	 * Check if the file is an SVG, if so handle appropriately
 	 *

inc/api.php

@@ -127,9 +127,13 @@ public function get_cache_token( $token = '', $type = '', $api_key = '' ) {
 		if ( ! empty( $api_key ) ) {
 			$this->api_key = $api_key;
 		}
-		$lock = get_transient( 'optml_cache_lock' );
-		if ( ! empty( $type ) && $type === 'assets' ) {
+		$lock = '';
+		if ( empty( $type ) || $type === 'images' ) {
+			$lock = get_transient( 'optml_cache_lock' );
+		} elseif ( $type === 'assets' ) {
 			$lock = get_transient( 'optml_cache_lock_assets' );
+		} else {
+			$type = '_file_' . crc32( $type );
 		}
 
 		if ( $lock === 'yes' ) {

inc/settings.php

@@ -732,6 +732,7 @@ public function register_settings() {
 		);
 	}
 
+
 	/**
 	 * Clear cache.
 	 *
@@ -743,12 +744,15 @@ public function clear_cache( $type = '' ) {
 		$token        = $this->get( 'cache_buster' );
 		$token_images = $this->get( 'cache_buster_images' );
 
-		if ( ! empty( $token_images ) ) {
-			$token = $token_images;
-		}
-
-		if ( ! empty( $type ) && $type === 'assets' ) {
+		if ( ( empty( $type ) || $type === 'images' ) ) {
+			if ( ! empty( $token_images ) ) {
+				$token = $token_images;
+			}
+		} elseif ( $type === 'assets' ) {
 			$token = $this->get( 'cache_buster_assets' );
+		} else {
+			// here is an individual clear cache based on filename.
+			$token = get_transient( '_file_' . crc32( $type ) ) ?? '';
 		}
 
 		$request = new Optml_Api();
@@ -769,12 +773,14 @@ public function clear_cache( $type = '' ) {
 			return new WP_Error( 'optimole_cache_buster_error', __( 'Can not get new token from Optimole service', 'optimole-wp' ) . $extra );
 		}
 
-		if ( ! empty( $type ) && $type === 'assets' ) {
+		if ( empty( $type ) || $type === 'images' ) {
+			set_transient( 'optml_cache_lock', 'yes', 5 * MINUTE_IN_SECONDS );
+			$this->update( 'cache_buster_images', $data['token'] );
+		} elseif ( $type === 'assets' ) {
 			set_transient( 'optml_cache_lock_assets', 'yes', 5 * MINUTE_IN_SECONDS );
 			$this->update( 'cache_buster_assets', $data['token'] );
 		} else {
-			set_transient( 'optml_cache_lock', 'yes', 5 * MINUTE_IN_SECONDS );
-			$this->update( 'cache_buster_images', $data['token'] );
+			set_transient( '_file_' . crc32( $type ), $data['token'], 6 * HOUR_IN_SECONDS );
 		}
 
 		return $data['token'];

inc/url_replacer.php

@@ -228,7 +228,7 @@ private function normalize_image( $url, $original_url, $args, $is_uploaded = fal
 		}
 
 		$args = apply_filters( 'optml_image_args', $args, $original_url );
-		$image = Optimole::image( apply_filters( 'optml_processed_url', $url ), $this->active_cache_buster );
+		$image = Optimole::image( apply_filters( 'optml_processed_url', $url ), self::get_active_cache_booster( $url, $this->active_cache_buster ) );
 
 		$image->width( ! empty( $args['width'] ) && is_int( $args['width'] ) ? $args['width'] : 'auto' );
 		$image->height( ! empty( $args['height'] ) && is_int( $args['height'] ) ? $args['height'] : 'auto' );
@@ -275,6 +275,17 @@ private function normalize_image( $url, $original_url, $args, $is_uploaded = fal
 		return $image->getUrl();
 	}
 
+	/**
+	 * Get the active cache booster.
+	 *
+	 * @param string $url The URL.
+	 * @param string $main_cache_buster The default value.
+	 *
+	 * @return string
+	 */
+	public static function get_active_cache_booster( $url, $main_cache_buster ) {
+		return get_transient( '_file_' . crc32( wp_basename( $url ) ) ) ?? $main_cache_buster;
+	}
 	/**
 	 * Throw error on object clone
 	 *