From d947a554957f16e0e3d51abf344bc495e7c6750d Mon Sep 17 00:00:00 2001
From: Scott Taylor <scott.c.taylor@mac.com>
Date: Sun, 30 Mar 2014 19:28:16 +0000
Subject: [PATCH] Metadata for audio and video files:

* Make attachment metadata for audio files editable by providing a metabox on the Edit Media page
* Standardize on using the attachment title everywhere
* Label the Caption and Description fields for audio and video appropriately
* Make the playlist Underscore templates more straightforward

See #27574.


Built from https://develop.svn.wordpress.org/trunk@27862


git-svn-id: http://core.svn.wordpress.org/trunk@27693 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-admin/edit-form-advanced.php  |  4 +++
 wp-admin/includes/media.php      | 13 +++++---
 wp-admin/includes/meta-boxes.php | 25 ++++++++++++++
 wp-admin/includes/post.php       | 18 ++++++++++
 wp-includes/media.php            | 56 +++++++++++++++++++++-----------
 5 files changed, 93 insertions(+), 23 deletions(-)

diff --git a/wp-admin/edit-form-advanced.php b/wp-admin/edit-form-advanced.php
index f7b22812ae..7f0ea62f6a 100644
--- a/wp-admin/edit-form-advanced.php
+++ b/wp-admin/edit-form-advanced.php
@@ -139,6 +139,10 @@ if ( 'attachment' == $post_type ) {
 	wp_enqueue_style( 'imgareaselect' );
 	add_meta_box( 'submitdiv', __('Save'), 'attachment_submit_meta_box', null, 'side', 'core' );
 	add_action( 'edit_form_after_title', 'edit_form_image_editor' );
+
+	if ( preg_match( '#^audio#', $post->post_mime_type ) ) {
+		add_meta_box( 'attachment-id3', __( 'Metadata' ), 'attachment_id3_data_meta_box', null, 'normal', 'core' );
+	}
 } else {
 	add_meta_box( 'submitdiv', __( 'Publish' ), 'post_submit_meta_box', null, 'side', 'core', $publish_callback_args );
 }
diff --git a/wp-admin/includes/media.php b/wp-admin/includes/media.php
index ccc4ab4b39..47bbfdb509 100644
--- a/wp-admin/includes/media.php
+++ b/wp-admin/includes/media.php
@@ -2661,10 +2661,14 @@ function edit_form_image_editor( $post ) {
 	</div>
 	<div class="wp_attachment_details edit-form-section">
 		<p>
-			<label for="attachment_caption"><strong><?php _e( 'Caption' ); ?></strong></label><br />
+			<label for="attachment_caption"><strong><?php _e( 'Caption' ); ?></strong><?php
+			if ( preg_match( '#^audio|video#', $post->post_mime_type ) ): ?>: <?php
+				_e( "Custom label for item in a playlist. If empty, the file's available data is used." );
+			endif ?></label><br />
 			<textarea class="widefat" name="excerpt" id="attachment_caption"><?php echo $post->post_excerpt; ?></textarea>
 		</p>
 
+
 	<?php if ( 'image' === substr( $post->post_mime_type, 0, 5 ) ) : ?>
 		<p>
 			<label for="attachment_alt"><strong><?php _e( 'Alternative Text' ); ?></strong></label><br />
@@ -2683,7 +2687,10 @@ function edit_form_image_editor( $post ) {
 		);
 	?>
 
-	<label for="content"><strong><?php _e( 'Description' ); ?></strong></label>
+	<label for="content"><strong><?php _e( 'Description' ); ?></strong><?php
+	if ( preg_match( '#^audio|video#', $post->post_mime_type ) ): ?>: <?php
+		_e( 'Displayed on attachment pages.' );
+	endif ?></label>
 	<?php wp_editor( $post->post_content, 'attachment_content', $editor_args ); ?>
 
 	</div>
@@ -2765,8 +2772,6 @@ function attachment_submitbox_metadata() {
 		 */
 		$fields = apply_filters( 'media_submitbox_misc_sections', array(
 			'mime_type'        => __( 'Mime-type:' ),
-			'year'             => __( 'Year:' ),
-			'genre'            => __( 'Genre:' ),
 			'length_formatted' => __( 'Length:' ),
 		) );
 
diff --git a/wp-admin/includes/meta-boxes.php b/wp-admin/includes/meta-boxes.php
index be89c366bf..f91df90347 100644
--- a/wp-admin/includes/meta-boxes.php
+++ b/wp-admin/includes/meta-boxes.php
@@ -1057,3 +1057,28 @@ function post_thumbnail_meta_box( $post ) {
 	$thumbnail_id = get_post_meta( $post->ID, '_thumbnail_id', true );
 	echo _wp_post_thumbnail_html( $thumbnail_id, $post->ID );
 }
+
+/**
+ * Display fields for ID3 data
+ *
+ * @since 3.9.0
+ *
+ * @param WP_Post $post
+ */
+function attachment_id3_data_meta_box( $post ) {
+	$meta = array();
+	if ( ! empty( $post->ID ) ) {
+		$meta = wp_get_attachment_metadata( $post->ID );
+	}
+
+	foreach ( wp_get_relevant_id3_keys() as $key => $label ): ?>
+	<p>
+		<label for="title"><?php echo $label ?></label>
+		<input type="text" name="id3_<?php echo esc_attr( $key ) ?>" id="id3_<?php echo esc_attr( $key ) ?>" class="widefat" value="<?php
+			if ( ! empty( $meta[ $key ] ) ) {
+				echo esc_attr( $meta[ $key ] );
+			}
+		?>" />
+	</p>
+	<?php endforeach;
+}
\ No newline at end of file
diff --git a/wp-admin/includes/post.php b/wp-admin/includes/post.php
index c8ea674c9f..bf59a9a162 100644
--- a/wp-admin/includes/post.php
+++ b/wp-admin/includes/post.php
@@ -237,6 +237,24 @@ function edit_post( $post_data = null ) {
 		}
 	}
 
+	if ( 'attachment' === $post_data['post_type'] && preg_match( '#^audio|video#', $post_data['post_mime_type'] ) ) {
+		$id3data = wp_get_attachment_metadata( $post_ID );
+		if ( ! is_array( $id3data ) ) {
+			$id3data = array();
+		}
+
+		foreach ( wp_get_relevant_id3_keys() as $key => $label ) {
+			if ( isset( $post_data[ 'id3_' . $key ] ) ) {
+				if ( current_user_can( 'unfiltered_html' ) ) {
+					$id3data[ $key ] = wp_unslash( $post_data[ 'id3_' . $key ] );
+				} else {
+					$id3data[ $key ] = wp_unslash( wp_kses_post( $post_data[ 'id3_' . $key ] ) );
+				}
+			}
+		}
+		wp_update_attachment_metadata( $post_ID, $id3data );
+	}
+
 	// Meta Stuff
 	if ( isset($post_data['meta']) && $post_data['meta'] ) {
 		foreach ( $post_data['meta'] as $key => $value ) {
diff --git a/wp-includes/media.php b/wp-includes/media.php
index d9f00267cc..6c1ddaeb01 100644
--- a/wp-includes/media.php
+++ b/wp-includes/media.php
@@ -1018,30 +1018,26 @@ function wp_underscore_playlist_templates() {
 	<# if ( data.image ) { #>
 	<img src="{{{ data.thumb.src }}}"/>
 	<# } #>
-	<# if ( data.meta.title ) { #>
 	<div class="wp-playlist-caption">
-		<span class="wp-caption-meta wp-caption-title">&#8220;{{{ data.meta.title }}}&#8221;</span>
-		<span class="wp-caption-meta wp-caption-album">{{{ data.meta.album }}}</span>
-		<span class="wp-caption-meta wp-caption-artist">{{{ data.meta.artist }}}</span>
+		<span class="wp-caption-meta wp-caption-title">&#8220;{{{ data.title }}}&#8221;</span>
+		<# if ( data.meta.album ) { #><span class="wp-caption-meta wp-caption-album">{{{ data.meta.album }}}</span><# } #>
+		<# if ( data.meta.artist ) { #><span class="wp-caption-meta wp-caption-artist">{{{ data.meta.artist }}}</span><# } #>
 	</div>
-	<# } else { #>
-	<div class="wp-playlist-caption">{{{ data.caption ? data.caption : data.title }}}</div>
-	<# } #>
 </script>
 <script type="text/html" id="tmpl-wp-playlist-item">
 	<div class="wp-playlist-item">
-		<# if ( ( data.title || data.meta.title ) && ( ! data.artists || data.meta.artist ) ) { #>
 		<div class="wp-playlist-caption">
 			{{{ data.index ? ( data.index + '.&nbsp;' ) : '' }}}
-			<span class="wp-caption-title">&#8220;{{{ data.title ? data.title : data.meta.title }}}&#8221;</span>
-			<# if ( data.artists ) { #>
-			<span class="wp-caption-by"><?php _e( 'by' ) ?></span>
-			<span class="wp-caption-artist">{{{ data.meta.artist }}}</span>
+			<# if ( data.caption ) { #>
+				{{{ data.caption }}}
+			<# } else { #>
+				<span class="wp-caption-title">&#8220;{{{ data.title }}}&#8221;</span>
+				<# if ( data.artists && data.meta.artist ) { #>
+				<span class="wp-caption-by"><?php _e( 'by' ) ?></span>
+				<span class="wp-caption-artist">{{{ data.meta.artist }}}</span>
+				<# } #>
 			<# } #>
 		</div>
-		<# } else { #>
-		<div class="wp-playlist-caption">{{{ data.index ? ( data.index + '.' ) : '' }}} {{{ data.caption ? data.caption : data.title }}}</div>
-		<# } #>
 		<# if ( data.meta.length_formatted ) { #>
 		<div class="wp-playlist-item-length">{{{ data.meta.length_formatted }}}</div>
 		<# } #>
@@ -1207,8 +1203,7 @@ function wp_playlist_shortcode( $attr ) {
 		$meta = wp_get_attachment_metadata( $attachment->ID );
 		if ( ! empty( $meta ) ) {
 
-			$keys = array( 'title', 'artist', 'band', 'album', 'genre', 'year', 'length', 'length_formatted' );
-			foreach ( $keys as $key ) {
+			foreach ( wp_get_relevant_id3_keys() as $key => $label ) {
 				if ( ! empty( $meta[ $key ] ) ) {
 					$track['meta'][ $key ] = $meta[ $key ];
 				}
@@ -1317,6 +1312,30 @@ function wp_get_audio_extensions() {
 	return apply_filters( 'wp_audio_extensions', array( 'mp3', 'ogg', 'wma', 'm4a', 'wav' ) );
 }
 
+/**
+ * Return useful keys to use to lookup data from an attachment's stored metadata
+ *
+ * @since 3.9.0
+ *
+ * @return array
+ */
+function wp_get_relevant_id3_keys() {
+	$fields = array(
+		'artist' => __( 'Artist' ),
+		'album' => __( 'Album' ),
+		'genre' => __( 'Genre' ),
+		'year' => __( 'Year' ),
+		'length_formatted' => __( 'Formatted Length' )
+	);
+	/**
+	 * Filter the editable list of keys to lookup data from an attachment's metadata
+	 *
+	 * @since 3.9.0
+	 *
+	 * @param array $fields
+	 */
+	return apply_filters( 'wp_get_relevant_id3_keys', $fields );
+}
 /**
  * The Audio shortcode.
  *
@@ -2312,8 +2331,7 @@ function wp_prepare_attachment_for_js( $attachment ) {
 			$response['fileLength'] = $meta['length_formatted'];
 
 		$response['meta'] = array();
-		$keys = array( 'title', 'artist', 'band', 'album', 'genre', 'year', 'length', 'length_formatted' );
-		foreach ( $keys as $key ) {
+		foreach ( wp_get_relevant_id3_keys() as $key => $label ) {
 			if ( ! empty( $meta[ $key ] ) ) {
 				$response['meta'][ $key ] = $meta[ $key ];
 			}