Merge pull request #893 from Codeinwp/feat/clear-cache-on-update

Feat/clear cache on update

Author: selul

inc/admin.php

@@ -65,7 +65,7 @@ public function __construct() {
 		add_action( 'admin_notices', [ $this, 'add_notice_conflicts' ] );
 		add_action( self::SYNC_CRON, [ $this, 'daily_sync' ] );
 		add_action( 'admin_init', [ $this, 'redirect_old_dashboard' ] );
-
+		add_action( 'optml_purge_image_cache', [ $this, 'purge_image_cache' ] );
 		if ( $this->settings->is_connected() ) {
 			add_action( 'init', [ $this, 'check_domain_change' ] );
 			add_action( self::ENRICH_CRON, [ $this, 'pull_image_data' ] );
@@ -80,6 +80,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_filter( 'update_attached_file', [ $this, 'listen_update_file' ], 999, 2 );
 			if ( ! wp_next_scheduled( self::ENRICH_CRON ) ) {
 				wp_schedule_event( time() + 10, 'hourly', self::ENRICH_CRON );
 			}
@@ -107,6 +108,32 @@ public function __construct() {
 
 		add_filter( 'themeisle-sdk/survey/' . OPTML_PRODUCT_SLUG, [ $this, 'get_survey_metadata' ], 10, 2 );
 	}
+
+	/**
+	 * Function that purges the image cache for a specific file.
+	 *
+	 * @param string $file Path or url of the file to clear.
+	 *
+	 * @return void
+	 */
+	public function purge_image_cache( $file ) {
+		$basename = wp_basename( $file );
+		$settings = new Optml_Settings();
+		$settings->clear_cache( $basename );
+	}
+	/**
+	 * 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 ) {
+		// Purge the image cache.
+		do_action( 'optml_purge_image_cache', $file );
+		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 = 'images';
 		}
 
 		if ( $lock === 'yes' ) {
@@ -352,59 +356,6 @@ public function get_optimized_images( $api_key = '' ) {
 		return $this->request( '/optml/v1/stats/images', 'GET', [], [ 'application' => $app_key ] );
 	}
 
-	/**
-	 * Get the watermarks from API.
-	 *
-	 * @param string $api_key The API key.
-	 *
-	 * @return array|bool|WP_Error
-	 */
-	public function get_watermarks( $api_key = '' ) {
-		if ( ! empty( $api_key ) ) {
-			$this->api_key = $api_key;
-		}
-
-		return $this->request( '/optml/v1/settings/watermark' );
-	}
-
-	/**
-	 * Remove the watermark from the API.
-	 *
-	 * @param integer $post_id The watermark post ID.
-	 * @param string  $api_key The API key.
-	 *
-	 * @return array|bool|WP_Error
-	 */
-	public function remove_watermark( $post_id, $api_key = '' ) {
-		if ( ! empty( $api_key ) ) {
-			$this->api_key = $api_key;
-		}
-
-		return $this->request( '/optml/v1/settings/watermark', 'DELETE', [ 'watermark' => $post_id ] );
-	}
-
-	/**
-	 * Add watermark.
-	 *
-	 * @param array $file The file to be uploaded.
-	 *
-	 * @return array|bool|mixed|object
-	 */
-	public function add_watermark( $file ) {
-
-		$headers = [
-			'Content-Disposition' => 'attachment; filename=' . $file['file']['name'],
-		];
-
-		$response = $this->request( 'wp/v2/media', 'POST', file_get_contents( $file['file']['tmp_name'] ), $headers );
-
-		if ( $response === false ) {
-			return false;
-		}
-
-		return $response;
-	}
-
 	/**
 	 * Call the images endpoint.
 	 *

inc/rest.php

@@ -81,11 +81,6 @@ class Optml_Rest {
 			'clear_offload_errors' => 'GET',
 			'get_offload_conflicts' => 'GET',
 		],
-		'watermark_routes' => [
-			'poll_watermarks' => 'GET',
-			'add_watermark'   => 'POST',
-			'remove_watermark' => 'POST',
-		],
 		'conflict_routes' => [
 			'poll_conflicts' => 'GET',
 			'dismiss_conflict' => 'POST',
@@ -175,7 +170,6 @@ public function register() {
 		$this->register_service_routes();
 
 		$this->register_image_routes();
-		$this->register_watermark_routes();
 		$this->register_conflict_routes();
 		$this->register_cache_routes();
 		$this->register_media_offload_routes();
@@ -217,14 +211,6 @@ public function register_media_offload_routes() {
 		}
 	}
 
-	/**
-	 * Method to register watermark specific routes.
-	 */
-	public function register_watermark_routes() {
-		foreach ( self::$rest_routes['watermark_routes'] as $route => $details ) {
-			$this->reqister_route( $route, $details );
-		}
-	}
 
 	/**
 	 * Method to register conflicts specific routes.
@@ -650,57 +636,6 @@ public function poll_optimized_images( WP_REST_Request $request ) {
 		return $this->response( $final_images );
 	}
 
-	/**
-	 * Get watermarks from API.
-	 *
-	 * @param WP_REST_Request $request rest request.
-	 *
-	 * @return WP_REST_Response
-	 */
-	public function poll_watermarks( WP_REST_Request $request ) {
-		$api_key    = $request->get_param( 'api_key' );
-		$request    = new Optml_Api();
-		$watermarks = $request->get_watermarks( $api_key );
-		if ( ! isset( $watermarks['watermarks'] ) || empty( $watermarks['watermarks'] ) ) {
-			return $this->response( [] );
-		}
-		$final_images = array_splice( $watermarks['watermarks'], 0, 10 );
-
-		return $this->response( $final_images );
-	}
-
-	/**
-	 * Add watermark.
-	 *
-	 * @param WP_REST_Request $request rest request.
-	 *
-	 * @return WP_REST_Response
-	 */
-	public function add_watermark( WP_REST_Request $request ) {
-		$file     = $request->get_file_params();
-		$request  = new Optml_Api();
-		$response = $request->add_watermark( $file );
-		if ( $response === false ) {
-			return $this->response( __( 'Error uploading image. Please try again.', 'optimole-wp' ), 'error' );
-		}
-
-		return $this->response( __( 'Watermark image uploaded succesfully !', 'optimole-wp' ) );
-	}
-
-	/**
-	 * Remove watermark.
-	 *
-	 * @param WP_REST_Request $request rest request.
-	 *
-	 * @return WP_REST_Response
-	 */
-	public function remove_watermark( WP_REST_Request $request ) {
-		$post_id = $request->get_param( 'postID' );
-		$api_key = $request->get_param( 'api_key' );
-		$request = new Optml_Api();
-
-		return $this->response( $request->remove_watermark( $post_id, $api_key ) );
-	}
 
 	/**
 	 * Get conflicts from API.

inc/settings.php

@@ -16,6 +16,7 @@ class Optml_Settings {
 	const FILTER_TYPE_LAZYLOAD = 'lazyload';
 	const FILTER_TYPE_OPTIMIZE = 'optimize';
 	const OPTML_USER_EMAIL = 'optml_user_email';
+	const INDIVIDUAL_CACHE_TOKENS_KEY = '_optml_cache_tokens_individual';
 	/**
 	 * Holds an array of possible settings to alter via wp cli or wp-config constants.
 	 *
@@ -741,6 +742,7 @@ public function register_settings() {
 		);
 	}
 
+
 	/**
 	 * Clear cache.
 	 *
@@ -752,12 +754,16 @@ 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' ) {
+		// here is an individual cache tokens
+		$individual = get_transient( self::INDIVIDUAL_CACHE_TOKENS_KEY ) ?: [];
+		if ( ( empty( $type ) || $type === 'images' ) ) {
+			if ( ! empty( $token_images ) ) {
+				$token = $token_images;
+			}
+		} elseif ( $type === 'assets' ) {
 			$token = $this->get( 'cache_buster_assets' );
+		} else {
+			$token = $individual[ crc32( $type ) ] ?? $token_images ?: $token;
 		}
 
 		$request = new Optml_Api();
@@ -778,12 +784,17 @@ 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'] );
+			// we delete individual cache tokens since this is a global cache clear.
+			delete_transient( self::INDIVIDUAL_CACHE_TOKENS_KEY );
+		} 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'] );
+			$individual[ crc32( $type ) ] = $data['token'];
+			set_transient( self::INDIVIDUAL_CACHE_TOKENS_KEY, $individual, 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( Optml_Settings::INDIVIDUAL_CACHE_TOKENS_KEY ) ?: [] )[ crc32( wp_basename( $url ) ) ] ?? $main_cache_buster;
+	}
 	/**
 	 * Throw error on object clone
 	 *

phpcs.xml

@@ -30,6 +30,7 @@
         <exclude name="Squiz.Commenting.FileComment"/>
         <exclude name="WordPress.PHP.YodaConditions.NotYoda"/>
         <exclude name="Universal.Arrays.DisallowShortArraySyntax.Found"/>
+        <exclude name="Universal.Operators.DisallowShortTernary.Found"/>
         <exclude name="Squiz.PHP.DisallowMultipleAssignments"/>
         <exclude name="WordPress.NamingConvention.ValidVariableName.StringNotSnakeCase"/>
         <exclude name="WordPress.NamingConventions.ValidVariableName.NotSnakeCase"/>