Convert [img] shortcodes back to tags/captions

inc/class-img-shortcode-data-migration.php

@@ -7,8 +7,8 @@
 
 class Img_Shortcode_Data_Migration {
 
-	private static function img_shortcode_regex() {
-		$img_shortcode_regex =
+	private static function img_tag_regex() {
+		$img_tag_regex =
 			'(?:<a[^>]+' .
 					'href="(?P<href>[^"]*)"' .
 					'[^>]*>)?' .
@@ -25,20 +25,24 @@ private static function img_shortcode_regex() {
 					'[^>]*>' .
 			'(?:<\/a>)?';
 
-		return $img_shortcode_regex;
+		return $img_tag_regex;
 	}
 
-
 	private static function caption_shortcode_regex() {
 		$caption_shortcode_regex =
 			'\[caption' .
 				'[^\]]*' .  '\]\]?' .
-				self::img_shortcode_regex() .
+				self::img_tag_regex() .
 				'(?: (?P<caption>[^\]]*))' .
 			'\[\[?\/caption\]\]?';
 		return $caption_shortcode_regex;
 	}
 
+	private static function img_shortcode_regex() {
+		$img_shortcode_regex = '\[img ' .  '[^\]]*]';
+		return $img_shortcode_regex;
+	}
+
 	public static function find_img_tags_for_replacement_on_post( $post ) {
 		if ( ! $post = self::maybe_get_post_from_id( $post ) ) {
 			return false;
@@ -57,10 +61,10 @@ public static function find_img_tags_for_replacement( $post_content ) {
 
 		$replacements = array();
 
-		$img_shortcode_regex = self::img_shortcode_regex();
+		$img_tag_regex = self::img_tag_regex();
 
 		preg_match_all(
-			"/$img_shortcode_regex/s",
+			"/$img_tag_regex/s",
 			$post_content,
 			$matches,
 			PREG_SET_ORDER
@@ -183,6 +187,84 @@ public static function convert_img_tag_to_shortcode( $img_tag, $attributes ) {
 	}
 
 
+	/**
+	 * Get all [img] shortcodes in a string for replacement.
+	 *
+	 * Used in converting data added by this plugin back to the default format
+	 * of <img> tags and [caption] shortcodes.
+	 *
+	 */
+	public static function find_img_shortcodes_for_replacement( $post_content ) {
+
+		$replacements = array();
+
+		$img_shortcode_regex = self::img_shortcode_regex();
+
+		preg_match_all(
+			"/$img_shortcode_regex/s",
+			$post_content,
+			$matches,
+			PREG_SET_ORDER
+		);
+
+		if ( 0 === count( $matches ) ) {
+			return array();
+		}
+
+		foreach ( $matches as $matched_pattern ) {
+			$replacements[ $matched_pattern[0] ] = self::convert_img_shortcode_to_tag(
+				$matched_pattern[0]
+			);
+		}
+
+		return $replacements;
+
+	}
+
+
+	/**
+	 * Convert an [img] shortcode as inserted by this plugin to the WP default
+	 * representation.
+	 *
+	 * @param string `[img]` shortcode element
+	 * @return string A `[caption]` shortcode element, or an <img> tag
+	 */
+	public static function convert_img_shortcode_to_tag( $img_shortcode ) {
+		$atts = shortcode_parse_atts( $img_shortcode );
+
+		$caption = isset( $atts['caption'] ) ? $atts['caption'] : '';
+		unset( $atts['caption'] );
+
+		$width = isset( $atts['width'] ) ? $atts['width'] : null;
+
+		$align = isset( $atts['align'] ) ? $atts['align'] : 'alignnone';
+
+		$size = isset( $atts['size'] ) ? $atts['size'] : 'medium';
+
+		$content = Img_Shortcode::callback( $atts );
+
+		if ( ! isset( $width ) && isset( $atts['attachment'] ) ) {
+			$attachment = wp_get_attachment_image_src(
+				(int) $atts['attachment'], $size
+			);
+			$width = intval( $attachment[1] );
+		}
+
+		if ( $caption ) {
+			$content =
+				'[caption ' .
+					'id="attachment_' . $atts['attachment'] . '" ' .
+					'width="' . $width . '" ' .
+					'align="' . $align . '"' .
+					']' .
+				$content .
+				$caption .
+				'[/caption]';
+		}
+
+		return $content;
+	}
+
 	/**
 	 * Get a post from a Post ID or post object.
 	 *

inc/class-wp-cli-img-shortcode-command.php

@@ -25,7 +25,7 @@ public function __construct() {
 	 * ## EXAMPLES
 	 *
 	 *     ## Migrate all Posts to the Image Shortcake syntax
-	 *     wp image-shortcake-shortcode migrate `wp post list --post_type=post` --ids`
+	 *     wp image-shortcake migrate `wp post list --post_type=post` --ids`
 	 *
 	 *     ## Converts images to shortcodes on one post, preserving a log to rollback in case of errors.
 	 *     wp image-shortcake migrate 123 > potential-oops.txt
@@ -102,6 +102,86 @@ public function migrate( $args, $assoc_args ) {
 
 	}
 
+
+	/**
+	 * Revert post content from image shortcodes back to <img> tags and [caption] shortcodes
+	 *
+	 * ## OPTIONS
+	 *
+	 * <id>...
+	 * : One or more IDs of posts to update.
+	 *
+	 * [--dry-run]
+	 * : Only show the content which is to be changed, don't update posts.
+	 *
+	 * ## EXAMPLES
+	 *
+	 *     ## Revert all Posts from the Image Shortcake syntax
+	 *     wp image-shortcake migrate `wp post list --post_type=post` --ids`
+	 *
+	 *     ## Converts shortcodes back to images on one post, preserving a log to rollback in case of errors.
+	 *     wp image-shortcake migrate 123 > potential-oops.txt
+	 *
+	 * @synopsis <id>... [--dry-run]
+	 */
+	public function revert( $args, $assoc_args ) {
+
+		foreach ( array_filter( $args ) as $post_ID ) {
+
+			$post = $this->fetcher->get_check( $post_ID );
+
+			$_content = $post->post_content;
+
+			$replacements = Img_Shortcode_Data_Migration::find_img_shortcodes_for_replacement( $_content );
+
+			$_content = str_replace(
+				array_keys( $replacements ),
+				array_values( $replacements ),
+				$_content
+			);
+
+			WP_CLI::log( '' );
+
+			if ( 0 === count( $replacements ) ) {
+				WP_CLI::log( 'Nothing to replace on post ' . $post->ID . '. Skipping.' );
+				WP_CLI::log( '' );
+				continue;
+			}
+
+			$header = 'Image shortcode replacements for post ' . $post->ID;
+
+			WP_CLI::log( $header );
+			WP_CLI::log( str_repeat( '=', strlen( $header ) ) );
+			WP_CLI::log( '' );
+
+			foreach ( $replacements as $del => $ins ) {
+				\WP_CLI::log( \cli\Colors::colorize( '%C-%n' ) . $del, true );
+				\WP_CLI::log( \cli\Colors::colorize( '%G+%n' ) . $ins, true );
+			}
+
+			WP_CLI::log( '' );
+
+			if ( isset( $assoc_args['dry-run'] ) ) {
+				WP_CLI::log( 'Post not updated: --dry-run specifed.' );
+				WP_CLI::log( '' );
+				continue;
+			}
+
+			global $wpdb;
+
+			// @codingStandardsIgnoreStart
+			$updated = $wpdb->update( $wpdb->posts, array( 'post_content' => $_content ), array( 'ID' => $post_ID ) );
+			// @codingStandardsIgnoreEnd
+
+			if ( 1 === $updated ) {
+				clean_post_cache( $post );
+				WP_CLI::success( 'Updated post ' . $post->ID . '.' );
+			} else {
+				WP_CLI::warning( 'There was an unexpected error updating post ' . $post->ID . '.' );
+			}
+		}
+	}
+
 }
 
 

tests/test-img-shortcode-data-migration.php

@@ -72,6 +72,81 @@ function test_img_tag_from_attachment() {
 		$this->assertNotContains( 'src="', $replacements[ $img_tag ] );
 	}
 
+	/**
+	 * Case: [img] shortcode conversion to <img>
+	 *
+	 */
+	function test_img_shortcode_conversion_to_img() {
+
+		$attachment_id = $this->attachment_id;
+		$upload_dir = wp_upload_dir();
+		$expected_src_attr = $upload_dir['url'] . '/fusion_image_placeholder_16x9_h2000.png';
+
+		// Test vanilla shortcode
+		$shortcode = '[img attachment="' . $attachment_id . '" /]';
+		$conversion = Img_Shortcode_Data_Migration::convert_img_shortcode_to_tag( $shortcode );
+		$this->assertContains( '<img class="size-full alignnone" src="' . $expected_src_attr . '" width="2000" height="1125" />' , $conversion );
+
+		// Test link href: linkto="file"
+		$shortcode = '[img attachment="' . $attachment_id . '" linkto="file" /]';
+		$conversion = Img_Shortcode_Data_Migration::convert_img_shortcode_to_tag( $shortcode );
+		$this->assertContains( 'href="' . $expected_src_attr . '"', $conversion );
+
+		// Test link href: linkto="attachment"
+		$shortcode = '[img attachment="' . $attachment_id . '" linkto="attachment" /]';
+		$conversion = Img_Shortcode_Data_Migration::convert_img_shortcode_to_tag( $shortcode );
+		$expected_href_attr = get_permalink( $attachment_id );
+		$this->assertContains( 'href="' . $expected_href_attr . '"', $conversion );
+
+		// Test caption attribute
+		$caption = <<<EOL
+This is a "<em>caption</em>". It should contain <abbr>HTML</abbr> and <span class="icon">markup</span>.
+EOL;
+		$shortcode = '[img attachment="' . $attachment_id . '" caption="' . esc_attr( $caption ) . '" /]';
+		$conversion = Img_Shortcode_Data_Migration::convert_img_shortcode_to_tag( $shortcode );
+		$expected_caption = esc_html( $caption );
+		$this->assertContains( '[caption id="attachment_' . $attachment_id . '" width="300" align="alignnone"]', $conversion );
+		$this->assertContains( $expected_caption . '[/caption]', $conversion );
+
+		// Test no attachment
+		// @todo Determine ideal behavior here
+		// $shortcode = '[img caption="' . esc_attr( $caption ) . '" /]';
+		// $conversion = Img_Shortcode_Data_Migration::convert_img_shortcode_to_tag( $shortcode );
+
+		// Test cadillac 1
+		$shortcode = '[img attachment="' . $attachment_id . '" linkto="attachment" size="full" caption="' . esc_attr( $caption ) . '" align="alignright" /]';
+		$conversion = Img_Shortcode_Data_Migration::convert_img_shortcode_to_tag( $shortcode );
+		$expected = '[caption id="attachment_' .
+			$attachment_id .
+			'" width="2000" align="alignright"]<a href="' .
+			$expected_href_attr .
+			'" ><img class="size-full alignright" src="' .
+			$expected_src_attr .
+			'" width="2000" height="1125" /></a>' .
+			$expected_caption .
+			'[/caption]';
+
+		$this->assertContains( $expected, $conversion );
+
+		// Test cadillac 2
+		$shortcode = '[img attachment="' . $attachment_id . '" linkto="attachment" size="medium" caption="' . esc_attr( $caption ) . '" align="alignnone" /]';
+		$conversion = Img_Shortcode_Data_Migration::convert_img_shortcode_to_tag( $shortcode );
+		$expected_src = wp_get_attachment_image_src( $attachment_id, 'medium' );
+		$expected_src_attr = $expected_src[0];
+		$expected = '[caption id="attachment_' .
+			$attachment_id .
+			'" width="300" align="alignnone"]<a href="' .
+			$expected_href_attr .
+			'" ><img class="size-medium alignnone" src="' .
+			$expected_src_attr .
+			'" width="300" height="169" /></a>' .
+			$expected_caption .
+			'[/caption]';
+
+		$this->assertContains( $expected, $conversion );
+
+	}
+
 	/**
 	 * Case: <img> tags with an external src
 	 *