Merge pull request #955 from cloudinary/feature/wpml-support

Feature WPML support

Author: pereirinha

php/class-assets.php

@@ -1020,7 +1020,8 @@ public function get_asset( $post_id, $type = 'object' ) {
 		global $wpdb;
 
 		$wpdb->cld_table = Utils::get_relationship_table();
-		$prepare         = $wpdb->prepare( "SELECT * FROM $wpdb->cld_table WHERE post_id = %d;", (int) $post_id );
+		$media_context   = Utils::get_media_context( $post_id );
+		$prepare         = $wpdb->prepare( "SELECT * FROM $wpdb->cld_table WHERE post_id = %d AND media_context = %s;", (int) $post_id, $media_context );
 		$result          = $wpdb->get_row( $prepare, ARRAY_A ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery, WordPress.DB.PreparedSQL.NotPrepared
 
 		return $this->build_item( $result );

php/class-delivery.php

@@ -11,13 +11,9 @@
 use Cloudinary\Connect\Api;
 use Cloudinary\Media\Filter;
 use Cloudinary\Media\Global_Transformations;
-use Cloudinary\Sync;
-use Cloudinary\String_Replace;
 use Cloudinary\UI\Component\HTML;
 use Cloudinary\Delivery\Bypass;
 use Cloudinary\Relate\Relationship;
-use WP_Post;
-use Cloudinary\Utils;
 
 /**
  * Plugin Delivery class.
@@ -335,11 +331,12 @@ public function generate_signature( $attachment_id ) {
 		if ( $relationship instanceof Relationship ) {
 			$public_id = $relationship->public_id;
 		}
+
 		$sizes              = $this->get_sized( $attachment_id );
 		$settings_signature = self::get_settings_signature();
 		$relation_signature = $this->media->get_post_meta( $attachment_id, Sync::META_KEYS['relationship'], true );
 
-		return wp_json_encode( $sizes ) . $public_id . $sql . $settings_signature . $relation_signature;
+		return wp_json_encode( $sizes ) . $public_id . $sql . $settings_signature . $relation_signature . Utils::get_media_context( $attachment_id );
 	}
 
 	/**
@@ -544,9 +541,10 @@ public static function update_size_relations_public_id( $attachment_id, $public_
 		$relationship = Relationship::get_relationship( $attachment_id );
 
 		if ( $relationship instanceof Relationship ) {
-			$relationship->public_id   = $public_id;
-			$relationship->public_hash = md5( (string) $public_id );
-			$relationship->signature   = self::get_settings_signature();
+			$relationship->public_id     = $public_id;
+			$relationship->public_hash   = md5( (string) $public_id );
+			$relationship->signature     = self::get_settings_signature();
+			$relationship->media_context = Utils::get_media_context( $attachment_id );
 			$relationship->save();
 		}
 	}
@@ -624,6 +622,7 @@ public static function create_size_relation( $attachment_id, $sized_url, $size =
 			'post_id'         => $attachment_id,
 			'parent_path'     => $parent_path,
 			'sized_url'       => $sized_url,
+			'media_context'   => Utils::get_media_context( $attachment_id ),
 			'width'           => $width_height[0] ? $width_height[0] : 0,
 			'height'          => $width_height[1] ? $width_height[1] : 0,
 			'format'          => Utils::pathinfo( $sized_url, PATHINFO_EXTENSION ),
@@ -1013,6 +1012,9 @@ public function convert_tags( $content, $context = 'view' ) {
 			$base           = $type . ':' . $url;
 			$public_id      = ! is_admin() ? $relation['public_id'] . '.' . $relation['format'] : null;
 			$cloudinary_url = $this->media->cloudinary_url( $relation['post_id'], array(), $relation['transformations'], $public_id );
+			if ( empty( $cloudinary_url ) ) {
+				continue;
+			}
 			if ( ! empty( $relation['slashed'] ) && $relation['slashed'] ) {
 				$aliases[ $base . '?' ] = addcslashes( $cloudinary_url . '&', '/' );
 				$aliases[ $base ]       = addcslashes( $cloudinary_url, '/' );

php/class-plugin.php

@@ -14,6 +14,7 @@
 use Cloudinary\Delivery\Lazy_Load;
 use Cloudinary\Delivery\Responsive_Breakpoints;
 use Cloudinary\Assets as CLD_Assets;
+use Cloudinary\Integrations\WPML;
 use Cloudinary\Media\Gallery;
 use Cloudinary\Sync\Storage;
 use Cloudinary\UI\State;
@@ -30,7 +31,7 @@ final class Plugin {
 	 *
 	 * @since   0.1
 	 *
-	 * @var Admin|CLD_Assets|Connect|Dashboard|Deactivation|Delivery|Extensions|Gallery|Lazy_Load|Media|Meta_Box|Relate|Report|Responsive_Breakpoints|REST_API|State|Storage|SVG|Sync|URL|null
+	 * @var     Admin|CLD_Assets|Connect|Dashboard|Deactivation|Delivery|Extensions|Gallery|Lazy_Load|Media|Meta_Box|Relate|Report|Responsive_Breakpoints|REST_API|State|Storage|SVG|Sync|URL[]|WPML|null
 	 */
 	public $components;
 	/**
@@ -89,29 +90,6 @@ final class Plugin {
 	 */
 	public $plugin_file;
 
-	/**
-	 * Directory in plugin containing autoloaded classes.
-	 *
-	 * @var string
-	 */
-	protected $autoload_class_dir = 'php';
-
-	/**
-	 * Autoload matches cache.
-	 *
-	 * @var array
-	 */
-	protected $autoload_matches_cache = array();
-
-	/**
-	 * Holds the list of hooks.
-	 *
-	 * @since   0.1
-	 *
-	 * @var     array
-	 */
-	public $hooks;
-
 	/**
 	 * Holds the list of keys.
 	 */
@@ -166,6 +144,7 @@ public function init() {
 		$this->components['relate']                 = new Relate( $this );
 		$this->components['metabox']                = new Meta_Box( $this );
 		$this->components['url']                    = new URL( $this );
+		$this->components['wpml']                   = new WPML( $this );
 	}
 
 	/**

php/class-report.php

@@ -212,7 +212,7 @@ public function get_attachment_data( $post_id = null ) {
 		unset( $meta[ Sync::META_KEYS['cloudinary'] ], $meta[ Sync::META_KEYS['process_log'] ], $meta['_wp_attachment_metadata'] );
 		array_walk(
 			$meta,
-			static function( &$row ) {
+			static function ( &$row ) {
 				$row = reset( $row );
 			}
 		);
@@ -226,9 +226,11 @@ static function( &$row ) {
 		}
 
 		$wpdb->cld_table = Utils::get_relationship_table();
+		$media_context   = Utils::get_media_context( $post->ID );
 		$prepare         = $wpdb->prepare(
-			"SELECT * FROM {$wpdb->cld_table} WHERE post_id = %d;",
-			$post->ID
+			"SELECT * FROM {$wpdb->cld_table} WHERE post_id = %d AND media_context = %s;",
+			$post->ID,
+			$media_context
 		);
 		$relationship    = $wpdb->get_row( $prepare ); // phpcs:ignore WordPress.DB.PreparedSQL,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
 

php/class-utils.php

@@ -288,6 +288,7 @@ public static function get_table_sql() {
 	  public_id varchar(1000) DEFAULT NULL,
 	  parent_path varchar(1000) DEFAULT NULL,
 	  sized_url varchar(1000) DEFAULT NULL,
+	  media_context varchar(12) DEFAULT 'default',
 	  width int(11) DEFAULT NULL,
 	  height int(11) DEFAULT NULL,
 	  format varchar(12) DEFAULT NULL,
@@ -299,7 +300,7 @@ public static function get_table_sql() {
 	  url_hash varchar(45) DEFAULT NULL,
 	  parent_hash varchar(45) DEFAULT NULL,
 	  PRIMARY KEY (id),
-	  UNIQUE KEY url_hash (url_hash),
+	  UNIQUE KEY media (url_hash, media_context),
 	  KEY post_id (post_id),
 	  KEY parent_hash (parent_hash),
 	  KEY public_hash (public_hash),
@@ -360,17 +361,27 @@ protected static function upgrade_install() {
 	 * @return array
 	 */
 	protected static function get_upgrade_sequence() {
-		$sequence         = array();
+		$upgrade_sequence = array();
 		$sequences        = array(
-			'3.0.0' => array( 'Cloudinary\Utils', 'upgrade_3_0_1' ),
+			'3.0.0' => array(
+				'range'  => array( '3.0.0' ),
+				'method' => array( 'Cloudinary\Utils', 'upgrade_3_0_1' ),
+			),
+			'3.1.9' => array(
+				'range'  => array( '3.0.1', '3.1.9' ),
+				'method' => array( 'Cloudinary\Utils', 'upgrade_3_1_9' ),
+			),
+
 		);
-		$upgrade_versions = array_keys( $sequences );
 		$previous_version = get_option( Sync::META_KEYS['db_version'], '3.0.0' );
 		$current_version  = get_plugin_instance()->version;
-		if ( version_compare( $current_version, $previous_version, '>' ) ) {
-			$index = array_search( $previous_version, $upgrade_versions, true );
-			if ( false !== $index ) {
-				$sequence = array_slice( $sequences, $index );
+		foreach ( $sequences as $sequence ) {
+			if (
+				version_compare( $current_version, $previous_version, '>' )
+				&& version_compare( $previous_version, reset( $sequence['range'] ), '>=' )
+				&& version_compare( $previous_version, end( $sequence['range'] ), '<' )
+			) {
+				$upgrade_sequence[] = $sequence['method'];
 			}
 		}
 
@@ -380,11 +391,11 @@ protected static function get_upgrade_sequence() {
 		 * @hook   cloudinary_upgrade_sequence
 		 * @since  3.0.1
 		 *
-		 * @param $sequence {array} The default sequence.
+		 * @param $upgrade_sequence {array} The default sequence.
 		 *
 		 * @return {array}
 		 */
-		return apply_filters( 'cloudinary_upgrade_sequence', $sequence );
+		return apply_filters( 'cloudinary_upgrade_sequence', $upgrade_sequence );
 	}
 
 	/**
@@ -417,6 +428,24 @@ public static function upgrade_3_0_1() {
 		update_option( Sync::META_KEYS['db_version'], get_plugin_instance()->version );
 	}
 
+	/**
+	 * Upgrade DB from v3.0.1 to v3.1.9.
+	 */
+	public static function upgrade_3_1_9() {
+		global $wpdb;
+		$tablename = self::get_relationship_table();
+
+		// Add new columns.
+		$wpdb->query( "ALTER TABLE {$tablename} ADD COLUMN `media_context` VARCHAR(12) DEFAULT 'default' AFTER `sized_url`" ); // phpcs:ignore WordPress.DB
+
+		// Update indexes.
+		$wpdb->query( "ALTER TABLE {$tablename} DROP INDEX url_hash" ); // phpcs:ignore WordPress.DB
+		$wpdb->query( "ALTER TABLE {$tablename} ADD UNIQUE INDEX media (url_hash, media_context)" ); // phpcs:ignore WordPress.DB
+
+		// Set DB Version.
+		update_option( Sync::META_KEYS['db_version'], get_plugin_instance()->version );
+	}
+
 	/**
 	 * Gets the URL for opening a Support Request.
 	 *
@@ -970,25 +999,30 @@ public static function attachment_url_to_postid( $url ) {
 	public static function query_relations( $public_ids, $urls = array() ) {
 		global $wpdb;
 
-		$wheres = array();
+		$media_context   = self::get_media_context();
+		$wheres          = array();
+		$searched_things = array();
 		if ( ! empty( $urls ) ) {
 			// Do the URLS.
-			$list     = implode( ', ', array_fill( 0, count( $urls ), '%s' ) );
-			$wheres[] = "url_hash IN( {$list} )";
+			$list            = implode( ', ', array_fill( 0, count( $urls ), '%s' ) );
+			$where           = "(url_hash IN( {$list} ) AND media_context = %s)";
+			$searched_things = array_merge( $searched_things, array_map( 'md5', $urls ), array( $media_context ) );
+			$wheres[]        = $where;
 		}
 		if ( ! empty( $public_ids ) ) {
 			// Do the public_ids.
-			$list     = implode( ', ', array_fill( 0, count( $public_ids ), '%s' ) );
-			$wheres[] = "public_hash IN( {$list} )";
-			$urls     = array_merge( $urls, $public_ids );
+			$list            = implode( ', ', array_fill( 0, count( $public_ids ), '%s' ) );
+			$where           = "(public_hash IN( {$list} ) AND media_context = %s)";
+			$searched_things = array_merge( $searched_things, array_map( 'md5', $public_ids ), array( $media_context ) );
+			$wheres[]        = $where;
 		}
 
 		$results = array();
 
-		if ( ! empty( array_filter( $urls ) ) ) {
+		if ( ! empty( array_filter( $wheres ) ) ) {
 			$tablename = self::get_relationship_table();
 			$sql       = "SELECT * from {$tablename} WHERE " . implode( ' OR ', $wheres );
-			$prepared  = $wpdb->prepare( $sql, array_map( 'md5', $urls ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+			$prepared  = $wpdb->prepare( $sql, $searched_things ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 			$cache_key = md5( $prepared );
 			$results   = wp_cache_get( $cache_key, 'cld_delivery' );
 			if ( empty( $results ) ) {
@@ -1083,4 +1117,32 @@ public static function descaled_url( $url ) {
 
 		return $url;
 	}
+
+	/**
+	 * Get the media context.
+	 *
+	 * @param int|null $attachment_id The attachment ID.
+	 *
+	 * @return string
+	 */
+	public static function get_media_context( $attachment_id = null ) {
+		/**
+		 * Filter the media context.
+		 *
+		 * This filter allows you to set a media context for the media for cases where the same asset is used in
+		 * different use cases, such as in a multilingual context.
+		 *
+		 * @hook    cloudinary_media_context
+		 * @since   3.1.9
+		 * @default {'default'}
+		 *
+		 * @param $media_context {string}   The media context.
+		 * @param $attachment_id {int|null} The attachment ID.
+		 *
+		 * @return {string}
+		 */
+		$context = apply_filters( 'cloudinary_media_context', 'default', $attachment_id );
+
+		return sanitize_key( $context );
+	}
 }

php/connect/class-api.php

@@ -12,6 +12,7 @@
 use Cloudinary\Utils;
 use Cloudinary\Plugin;
 use Cloudinary\Media;
+use function Cloudinary\get_plugin_instance;
 
 /**
  * Class API.
@@ -527,7 +528,11 @@ public function upload( $attachment_id, $args, $headers = array(), $try_remote =
 			$disable_https_fetch = true;
 		}
 
-		if ( ! $this->media->is_uploadable_media( $attachment_id ) ) {
+		if ( ! $this->media ) {
+			$this->media = get_plugin_instance()->get_component( 'media' );
+		}
+
+		if ( $this->media && ! $this->media->is_uploadable_media( $attachment_id ) ) {
 			$disable_https_fetch = false; // Remote can upload via url.
 			// translators: variable is thread name and queue size.
 			$action_message = sprintf( __( 'Uploading remote url:  %1$s.', 'cloudinary' ), $file_url );

php/integrations/class-integrations.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Integrations class for the Cloudinary plugin.
+ *
+ * @package Cloudinary
+ */
+
+namespace Cloudinary\Integrations;
+
+use Cloudinary\Plugin;
+
+/**
+ * Abstract class Integrations
+ */
+abstract class Integrations {
+	/**
+	 * The plugin instance.
+	 *
+	 * @var Plugin
+	 */
+	protected $plugin;
+
+	/**
+	 * Integrations constructor.
+	 *
+	 * @param Plugin $plugin The plugin instance.
+	 */
+	public function __construct( $plugin ) {
+		if ( ! $this->can_enable() ) {
+			return;
+		}
+
+		$this->plugin = $plugin;
+		$this->register_hooks();
+	}
+
+	/**
+	 * Check if the integration can be enabled.
+	 *
+	 * @return bool
+	 */
+	abstract public function can_enable();
+
+	/**
+	 * Register hooks for the integration.
+	 */
+	abstract public function register_hooks();
+}