Merge pull request #498 from Automattic/fix/media-credit-save-postmeta

FIX / Media Credit Plugin Migrator: save by-hand credits into postmeta

src/Command/General/MediaCreditPluginMigrator.php

@@ -9,7 +9,9 @@
  * Media Credit Plugin also allowed Admins to add freeform text by using a [media-credit] 
  * shortcode within posts' post_content.
  * 
- * The command(s) below can be used to process posts with this shortcode.
+ * The main command below can be used to remove the old shortcode (while saving freeform text
+ * into postmeta), then a secondary command can be used to export the saved postmeta into SQL
+ * for visual review/clean-up and phpmyadmin execution.
  * 
  * @link: https://wordpress.org/plugins/media-credit/
  *
@@ -27,6 +29,8 @@
  */
 class MediaCreditPluginMigrator implements InterfaceCommand {
 
+	const POSTMETA_KEY_OTHER_CREDITS = 'newspack_media_credit_other_credits';
+
 	/**
 	 * Dry Run
 	 *
@@ -53,7 +57,7 @@ class MediaCreditPluginMigrator implements InterfaceCommand {
 	 *
 	 * @var array $report
 	 */
-	private $report;
+	private $report = array();
 
 	/**
 	 * Instance
@@ -104,6 +108,14 @@ public function register_commands() {
 				],
 			]
 		);
+
+		WP_CLI::add_command(
+			'newspack-content-migrator review-media-credit-plugin-other-credits',
+			[ $this, 'cmd_review_media_credit_plugin_other_credits' ],
+			[
+				'shortdesc' => 'Review Media Credit Plugin "other credits" that are saved in postmeta. Log will contain possible SQL to run.',
+			]
+		);
 	}
 
 	/**
@@ -204,6 +216,67 @@ public function cmd_migrate_media_credit_plugin( $pos_args, $assoc_args ) {
 		$this->logger->log( $this->log, 'Done.', $this->logger::SUCCESS );
 	}
 
+	/**
+	 * Review Media Credit Plugin other credits saved in postmeta. Log a list of SQL
+	 * for visual review and execution.
+	 * 
+	 * @param array $pos_args Positional arguments.
+	 * @param array $assoc_args Associative arguments.
+	 */
+	public function cmd_review_media_credit_plugin_other_credits( $pos_args, $assoc_args ) {
+
+		global $wpdb;
+
+		$this->log = str_replace( __NAMESPACE__ . '\\', '', __CLASS__ ) . '_' . __FUNCTION__ . '.log';
+
+		$this->logger->log( $this->log, 'Review "other credits", choose a single SQL line per attachment (or none), then run remaining SQL.' );
+
+		// Get attachments that have required postmeta.
+		$args = array(
+			'post_type' => 'attachment',
+			'meta_key'  => self::POSTMETA_KEY_OTHER_CREDITS,
+			'fields'    => 'ids',
+			'orderby'   => 'date',
+			'order'     => 'DESC',
+		);
+
+		$attachment_ids = get_posts( $args );
+
+		foreach ( $attachment_ids as $attachment_id ) {
+
+			// Log the existing media credit value.
+			$this->logger->log( $this->log, '' );
+			$this->logger->log( $this->log, '-- Attachment ID: ' . $attachment_id . ' / Current media credit: ' . get_post_meta( $attachment_id, '_media_credit', true ) );
+			$this->logger->log( $this->log, '' );
+
+			// Get "other credits" (multiple rows may exist (single = false)).
+			$other_credits = get_post_meta( $attachment_id, self::POSTMETA_KEY_OTHER_CREDITS, false );
+
+			// Log SQL statements to a file for human-review.
+			// SQL updates in this loop are NOT executed, they are only logged.
+			// They must be run by-hand (phpmyadmin) later if requested by human-reviewer.
+			foreach ( $other_credits as $other_credit ) {
+
+				$sql = $wpdb->prepare(
+					"
+					UPDATE $wpdb->postmeta set meta_value = %s where meta_key = %s and post_id = %d;
+					",
+					$other_credit,
+					'_media_credit',
+					$attachment_id
+				);
+
+				$this->logger->log( $this->log, trim( $sql ) );
+
+			} // each "other credit"
+
+		} // each attachment
+
+		$this->logger->log( $this->log, '' );
+
+		$this->logger->log( $this->log, 'Done.', $this->logger::SUCCESS );
+	}
+
 	/**
 	 * Process a single post's content for shortcodes.
 	 * 
@@ -490,13 +563,18 @@ private function process_media_credit_shortcode( $post_id, $shortcode_match ) {
 		$this->logger->log( $this->log, 'Different HTML vs DB credits', $this->logger::WARNING );
 
 		if ( $this->dry_run ) {
+
 			$this->report( $post_id, $attachment_id, 'different', $img_postmeta, $atts['name'] );
+
+		} else {
+
+			// Save these differences to postmeta so Publisher can hand-review and pick the one they want.
+			// Since there may be multiple media credits per attachment_id we want to save each one.
+			// Use "add post meta" with argument "$unique = false" so multiple values can be saved.
+			add_post_meta( $attachment_id, self::POSTMETA_KEY_OTHER_CREDITS, $atts['name'], false );
+
 		}
 
-		// Return the shortcode credit name.
-		// NO: just share this in output report instead: return array( $atts['name'], $atts, $attachment_id );
-		// Otherwise, once the [caption] is convert to Blocks, then Newspack Plugin will tack on the media-credit
-		// causing a double credit.
 		return array( null, $atts, $attachment_id );
 	}