Source: php/media/class-upgrade.php

  1. <?php
  2. /**
  3.  * Upgrades from a Legecy version of Cloudinary.
  4.  *
  5.  * @package Cloudinary
  6.  */
  8. namespace Cloudinary\Media;
  10. use Cloudinary\Relate;
  11. use Cloudinary\Sync;
  12. use Cloudinary\Utils;
  14. /**
  15.  * Class Filter.
  16.  *
  17.  * Handles filtering of HTML content.
  18.  */
  19. class Upgrade {
  21. 	/**
  22. 	 * Holds the Media instance.
  23. 	 *
  24. 	 * @since   0.1
  25. 	 *
  26. 	 * @var     \Cloudinary\Media Instance of the plugin.
  27. 	 */
  28. 	private $media;
  30. 	/**
  31. 	 * Holds the Sync instance.
  32. 	 *
  33. 	 * @since   0.1
  34. 	 *
  35. 	 * @var     \Cloudinary\Sync Instance of the plugin.
  36. 	 */
  37. 	private $sync;
  39. 	/**
  40. 	 * Filter constructor.
  41. 	 *
  42. 	 * @param \Cloudinary\Media $media The plugin.
  43. 	 */
  44. 	public function __construct( \Cloudinary\Media $media ) {
  45. 		$this->media = $media;
  46. 		$this->sync  = $media->plugin->components['sync'];
  47. 		$this->setup_hooks();
  48. 	}
  50. 	/**
  51. 	 * Convert an image post that was created from Cloudinary v1.
  52. 	 *
  53. 	 * @param int $attachment_id The attachment ID to convert.
  54. 	 *
  55. 	 * @return string Cloudinary ID
  56. 	 */
  57. 	public function convert_cloudinary_version( $attachment_id ) {
  59. 		if ( ! empty( get_post_meta( $attachment_id, Sync::META_KEYS['cloudinary'], true ) ) ) {
  60. 			// V2.5 changed the meta. if it had, theres no upgrades needed.
  61. 			/**
  62. 			 * Action to trigger an upgrade on a synced asset.
  63. 			 *
  64. 			 * @hook  cloudinary_upgrade_asset
  65. 			 * @since 3.0.5
  66. 			 *
  67. 			 * @param $attachment_id {int} The attachment ID.
  68. 			 * @param $version       {string} The current plugin version.
  69. 			 */
  70. 			do_action( 'cloudinary_upgrade_asset', $attachment_id, $this->media->plugin->version );
  72. 			$this->media->update_post_meta( $attachment_id, Sync::META_KEYS['plugin_version'], $this->media->plugin->version );
  73. 			$this->sync->set_signature_item( $attachment_id, 'upgrade' );
  75. 			return $this->media->get_public_id( $attachment_id );
  76. 		}
  77. 		$file = get_post_meta( $attachment_id, '_wp_attached_file', true );
  78. 		if ( ! $this->media->get_post_meta( $attachment_id, Sync::META_KEYS['public_id'], true ) && wp_http_validate_url( $file ) ) {
  79. 			// Version 1 upgrade.
  80. 			$path                  = wp_parse_url( $file, PHP_URL_PATH );
  81. 			$media                 = $this->media;
  82. 			$parts                 = explode( '/', ltrim( $path, '/' ) );
  83. 			$cloud_name            = null;
  84. 			$asset_version         = 1;
  85. 			$asset_transformations = array();
  86. 			$id_parts              = array();
  87. 			$public_id             = $this->get_fetch_public_id( $path, $attachment_id );
  88. 			foreach ( $parts as $val ) {
  89. 				if ( empty( $val ) ) {
  90. 					continue;
  91. 				}
  92. 				if ( is_null( $cloud_name ) ) {
  93. 					// Cloudname will always be the first item.
  94. 					$cloud_name = md5( $val );
  95. 					continue;
  96. 				}
  97. 				if ( in_array( $val, array( 'images', 'image', 'video', 'upload', 'fetch' ), true ) ) {
  98. 					continue;
  99. 				}
  100. 				$transformation_maybe = $media->get_transformations_from_string( $val );
  101. 				if ( ! empty( $transformation_maybe ) ) {
  102. 					$asset_transformations = $transformation_maybe;
  103. 					continue;
  104. 				}
  105. 				if ( substr( $val, 0, 1 ) === 'v' && is_numeric( substr( $val, 1 ) ) ) {
  106. 					$asset_version = substr( $val, 1 );
  107. 					continue;
  108. 				}
  110. 				// Filter out file name.
  111. 				$path = Utils::pathinfo( $val, PATHINFO_FILENAME );
  112. 				if ( ! in_array( $path, $id_parts, true ) ) {
  113. 					$id_parts[] = Utils::pathinfo( $val, PATHINFO_FILENAME );
  114. 				}
  115. 			}
  116. 			// Build public_id.
  117. 			$parts = array_filter( $id_parts );
  118. 			if ( empty( $public_id ) ) {
  119. 				$public_id = implode( '/', $parts );
  120. 			}
  121. 			$this->media->update_post_meta( $attachment_id, Sync::META_KEYS['public_id'], $public_id );
  122. 			$this->media->update_post_meta( $attachment_id, Sync::META_KEYS['version'], $asset_version );
  123. 			$this->media->update_post_meta( $attachment_id, Sync::META_KEYS['upgrading'], true );
  124. 			if ( ! empty( $asset_transformations ) ) {
  125. 				Relate::update_transformations( $attachment_id, $asset_transformations );
  126. 			}
  127. 			$this->sync->set_signature_item( $attachment_id, 'cloud_name', $cloud_name );
  128. 		} else {
  129. 			// v2 upgrade.
  130. 			$public_id = $this->media->get_public_id( $attachment_id, true );
  131. 			$suffix    = $this->media->get_post_meta( $attachment_id, Sync::META_KEYS['suffix'], true );
  132. 			if ( ! empty( $suffix ) ) {
  133. 				// Has suffix. Get delete and cleanup public ID.
  134. 				if ( false !== strpos( $public_id, $suffix ) ) {
  135. 					$public_id = str_replace( $suffix, '', $public_id );
  136. 				}
  137. 				$public_id .= $suffix;
  138. 				$this->media->delete_post_meta( $attachment_id, Sync::META_KEYS['suffix'] );
  139. 				$this->media->update_post_meta( $attachment_id, Sync::META_KEYS['public_id'], $public_id );
  140. 			}
  141. 			// Check folder sync in order and if it's not a URL.
  142. 			if ( ! wp_http_validate_url( $file ) && $this->media->is_folder_synced( $attachment_id ) ) {
  143. 				$public_id_folder = ltrim( dirname( $this->media->get_public_id( $attachment_id ) ) );
  144. 				$test_signature   = md5( false );
  145. 				$folder_signature = md5( $public_id_folder );
  146. 				$signature        = $this->sync->get_signature( $attachment_id );
  147. 				if ( $folder_signature !== $test_signature && $test_signature === $signature['folder'] ) {
  148. 					// The test signature is a hashed false, which is how non-folder-synced items got hashed.
  149. 					// Indicating this is broken link.
  150. 					$this->media->delete_post_meta( $attachment_id, Sync::META_KEYS['folder_sync'] );
  151. 					$this->media->delete_post_meta( $attachment_id, Sync::META_KEYS['sync_error'] ); // Remove any errors from upgrade. they are outdated.
  152. 					delete_post_meta( $attachment_id, Sync::META_KEYS['sync_error'] ); // Remove any errors from upgrade. they are outdated.
  153. 					$this->sync->set_signature_item( $attachment_id, 'folder' );
  154. 				}
  155. 			}
  156. 		}
  157. 		$this->media->update_post_meta( $attachment_id, Sync::META_KEYS['plugin_version'], $this->media->plugin->version );
  158. 		$this->sync->set_signature_item( $attachment_id, 'upgrade' );
  159. 		$this->sync->set_signature_item( $attachment_id, 'public_id' );
  160. 		$this->sync->set_signature_item( $attachment_id, 'storage' );
  161. 		// Update Sync keys.
  162. 		$sync_key        = $public_id;
  163. 		$transformations = $this->media->get_transformation_from_meta( $attachment_id );
  164. 		if ( ! empty( $transformations ) ) {
  165. 			$sync_key .= wp_json_encode( $transformations );
  166. 		}
  167. 		update_post_meta( $attachment_id, '_' . md5( $sync_key ), true );
  168. 		update_post_meta( $attachment_id, '_' . md5( 'base_' . $public_id ), true );
  169. 		// Get a new uncached signature.
  170. 		$this->sync->get_signature( $attachment_id, true );
  172. 		return $public_id;
  173. 	}
  175. 	/**
  176. 	 * Maybe the upgraded attachment is a fetch image.
  177. 	 *
  178. 	 * @param string $path          The attachment path.
  179. 	 * @param int    $attachment_id The attachment ID.
  180. 	 *
  181. 	 * @return string
  182. 	 */
  183. 	public function get_fetch_public_id( $path, $attachment_id ) {
  184. 		$parts = explode( '/image/fetch/', $path );
  186. 		if ( ! empty( $parts[1] ) ) {
  187. 			$this->media->update_post_meta( $attachment_id, Sync::META_KEYS['delivery'], 'fetch' );
  189. 			return $parts[1];
  190. 		}
  192. 		return '';
  193. 	}
  195. 	/**
  196. 	 * Migrate legacy meta data to new meta.
  197. 	 *
  198. 	 * @param int $attachment_id The attachment ID to migrate.
  199. 	 *
  200. 	 * @return array();
  201. 	 */
  202. 	public function migrate_legacy_meta( $attachment_id ) {
  204. 		$old_meta = wp_get_attachment_metadata( $attachment_id, true );
  205. 		$v2_meta  = get_post_meta( $attachment_id, Sync::META_KEYS['cloudinary_legacy'], true );
  206. 		$v3_meta  = array();
  208. 		// Direct from old meta to v3, create v2 to chain the upgrade path.
  209. 		if ( isset( $old_meta[ Sync::META_KEYS['cloudinary_legacy'] ] ) && empty( $v2_meta ) ) {
  210. 			$v2_meta = $old_meta[ Sync::META_KEYS['cloudinary_legacy'] ];
  211. 			// Add public ID.
  212. 			$public_id                               = get_post_meta( $attachment_id, Sync::META_KEYS['public_id'], true );
  213. 			$v2_meta[ Sync::META_KEYS['public_id'] ] = $public_id;
  214. 			delete_post_meta( $attachment_id, Sync::META_KEYS['public_id'] );
  215. 		}
  217. 		// Handle v2 upgrade.
  218. 		if ( ! empty( $v2_meta ) ) {
  219. 			// Migrate to v3.
  220. 			update_post_meta( $attachment_id, Sync::META_KEYS['cloudinary'], $v2_meta );
  221. 			delete_post_meta( $attachment_id, Sync::META_KEYS['cloudinary_legacy'] );
  222. 			$v3_meta = $v2_meta;
  223. 			if ( ! empty( $v3_meta[ Sync::META_KEYS['public_id'] ] ) ) {
  224. 				// Cleanup from v2.7.7.
  225. 				if ( ! empty( $v3_meta[ Sync::META_KEYS['storage'] ] ) && 'cld' === $v3_meta[ Sync::META_KEYS['storage'] ] ) {
  226. 					$file = get_post_meta( $attachment_id, '_wp_attached_file', true );
  227. 					if ( $this->media->is_cloudinary_url( $file ) ) {
  228. 						$file = path_join( dirname( $old_meta['file'] ), wp_basename( $file ) );
  229. 						update_post_meta( $attachment_id, '_wp_attached_file', $file );
  230. 						update_post_meta( $attachment_id, '_' . md5( $file ), $file );
  231. 					}
  232. 				}
  233. 			}
  234. 			// Remove old data style.
  235. 			unset( $old_meta[ Sync::META_KEYS['cloudinary_legacy'] ] );
  236. 		}
  238. 		// Attempt to update old meta, which will fail if nothing changed.
  239. 		update_post_meta( $attachment_id, '_wp_attachment_metadata', $old_meta );
  241. 		// migrate from pre v2 meta.
  242. 		if ( empty( $v2_meta ) && empty( $v3_meta ) ) {
  243. 			// Attempt old post meta.
  244. 			$public_id = get_post_meta( $attachment_id, Sync::META_KEYS['public_id'], true );
  245. 			if ( ! empty( $public_id ) ) {
  246. 				// Loop through all types and create new meta item.
  247. 				$v3_meta = array(
  248. 					Sync::META_KEYS['public_id'] => $public_id,
  249. 				);
  250. 				update_post_meta( $attachment_id, Sync::META_KEYS['cloudinary'], $v3_meta );
  251. 				foreach ( Sync::META_KEYS as $meta_key ) {
  252. 					if ( Sync::META_KEYS['cloudinary'] === $meta_key ) {
  253. 						// Dont use the root as it will be an infinite loop.
  254. 						continue;
  255. 					}
  256. 					$value = get_post_meta( $attachment_id, $meta_key, true );
  257. 					if ( ! empty( $value ) ) {
  258. 						$v3_meta[ $meta_key ] = $value;
  259. 						$this->media->update_post_meta( $attachment_id, $meta_key, $value );
  260. 					}
  261. 				}
  262. 			}
  263. 		}
  265. 		return $v3_meta;
  266. 	}
  268. 	/**
  269. 	 * Setup hooks for the filters.
  270. 	 */
  271. 	public function setup_hooks() {
  273. 		// Add filter to manage legacy items.
  274. 		// @todo: cleanup `convert_cloudinary_version` by v2 upgrades to here.
  275. 		add_filter( 'cloudinary_migrate_legacy_meta', array( $this, 'migrate_legacy_meta' ) );
  277. 		// Add a redirection to the new plugin settings, from the old plugin.
  278. 		if ( is_admin() ) {
  279. 			add_action(
  280. 				'admin_menu',
  281. 				function () {
  282. 					global $plugin_page;
  283. 					if ( ! empty( $plugin_page ) && false !== strpos( $plugin_page, 'cloudinary-image-management-and-manipulation-in-the-cloud-cdn' ) ) {
  284. 						wp_safe_redirect( admin_url( '?page=cloudinary' ) );
  285. 						die;
  286. 					}
  287. 				}
  288. 			);
  289. 		}
  290. 	}
  291. }