Attachments: add support for audio 🔈 and video 📼 (#536)

* only in the block editor
* update settings page copy: media, not just images

---------

Co-authored-by: Matthias Pfefferle <pfefferle@users.noreply.github.com>

includes/transformer/class-post.php

@@ -143,78 +143,65 @@ class Post {
 	}
 
 	/**
-	 * Returns the Image Attachments for this Post, parsed from blocks.
+	 * Generates all Media Attachments for a Post.
-	 * @param int $max_images The maximum number of images to return.
-	 * @param array $image_ids The image IDs to append new IDs to.
 	 *
-	 * @return array The image IDs.
+	 * @return array The Attachments.
-	 */
-	protected function get_block_image_ids( $max_images, $image_ids = [] ) {
-		$blocks = \parse_blocks( $this->wp_post->post_content );
-		return self::get_image_ids_from_blocks( $blocks, $image_ids, $max_images );
-	}
-
-	/**
-	 * Recursively get image IDs from blocks.
-	 * @param array $blocks The blocks to search for image IDs
-	 * @param array $image_ids The image IDs to append new IDs to
-	 * @param int $max_images The maximum number of images to return.
-	 *
-	 * @return array The image IDs.
-	 */
-	protected static function get_image_ids_from_blocks( $blocks, $image_ids, $max_images ) {
-		foreach ( $blocks as $block ) {
-			// recurse into inner blocks
-			if ( ! empty( $block['innerBlocks'] ) ) {
-				$image_ids = self::get_image_ids_from_blocks( $block['innerBlocks'], $image_ids, $max_images );
-			}
-
-			switch ( $block['blockName'] ) {
-				case 'core/image':
-				case 'core/cover':
-					if ( ! empty( $block['attrs']['id'] ) ) {
-						$image_ids[] = $block['attrs']['id'];
-					}
-					break;
-				case 'jetpack/slideshow':
-				case 'jetpack/tiled-gallery':
-					if ( ! empty( $block['attrs']['ids'] ) ) {
-						$image_ids = array_merge( $image_ids, $block['attrs']['ids'] );
-					}
-					break;
-				case 'jetpack/image-compare':
-					if ( ! empty( $block['attrs']['beforeImageId'] ) ) {
-						$image_ids[] = $block['attrs']['beforeImageId'];
-					}
-					if ( ! empty( $block['attrs']['afterImageId'] ) ) {
-						$image_ids[] = $block['attrs']['afterImageId'];
-					}
-					break;
-			}
-
-			// we could be at or over max, stop unneeded work
-			if ( count( $image_ids ) >= $max_images ) {
-				break;
-			}
-		}
-
-		// still need to slice it because one gallery could knock us over the limit
-		return \array_slice( $image_ids, 0, $max_images );
-	}
-
-	/**
-	 * Generates all Image Attachments for a Post.
-	 *
-	 * @return array The Image Attachments.
 	 */
 	protected function get_attachments() {
-		$max_images = intval( \apply_filters( 'activitypub_max_image_attachments', \get_option( 'activitypub_max_image_attachments', ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS ) ) );
+		// Once upon a time we only supported images, but we now support audio/video as well.
+		// We maintain the image-centric naming for backwards compatibility.
+		$max_media = intval( \apply_filters( 'activitypub_max_image_attachments', \get_option( 'activitypub_max_image_attachments', ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS ) ) );
 
-		$images = array();
+		if ( site_supports_blocks() && \has_blocks( $this->wp_post->post_content ) ) {
+			return $this->get_block_attachments( $max_media );
+		}
 
+		return $this->get_classic_editor_images( $max_media );
+	}
+
+	/**
+	 * Get media attachments from blocks. They will be formatted as ActivityPub attachments, not as WP attachments.
+	 *
+	 * @param int $max_media The maximum number of attachments to return.
+	 *
+	 * @return array The attachments.
+	 */
+	protected function get_block_attachments( $max_media ) {
+		// max media can't be negative or zero
+		if ( $max_media <= 0 ) {
+			return array();
+		}
+
+		$id = $this->wp_post->ID;
+
+		$media_ids = array();
+
+		// list post thumbnail first if this post has one
+		if ( \function_exists( 'has_post_thumbnail' ) && \has_post_thumbnail( $id ) ) {
+			$media_ids[] = \get_post_thumbnail_id( $id );
+		}
+
+		if ( $max_media > 0 ) {
+			$blocks = \parse_blocks( $this->wp_post->post_content );
+			$media_ids = self::get_media_ids_from_blocks( $blocks, $media_ids, $max_media );
+		}
+		$media_ids = \array_unique( $media_ids );
+
+		return \array_filter( \array_map( array( self::class, 'wp_attachment_to_activity_attachment' ), $media_ids ) );
+	}
+
+	/**
+	 * Get image attachments from the classic editor.
+	 * Note that audio/video attachments are only supported in the block editor.
+	 *
+	 * @param int $max_images The maximum number of images to return.
+	 *
+	 * @return array The attachments.
+	 */
+	protected function get_classic_editor_images( $max_images ) {
 		// max images can't be negative or zero
 		if ( $max_images <= 0 ) {
-			return $images;
+			return array();
 		}
 
 		$id = $this->wp_post->ID;
@@ -228,12 +215,6 @@ class Post {
 		}
 
 		if ( $max_images > 0 ) {
-			// first try to get images that are actually in the post content
-			if ( site_supports_blocks() && \has_blocks( $this->wp_post->post_content ) ) {
-				$block_image_ids = $this->get_block_image_ids( $max_images, $image_ids );
-				$image_ids = \array_merge( $image_ids, $block_image_ids );
-			} else {
-				// fallback to images attached to the post
 			$query = new \WP_Query(
 				array(
 					'post_parent' => $id,
@@ -251,12 +232,77 @@ class Post {
 				}
 			}
 		}
-		}
-
 		$image_ids = \array_unique( $image_ids );
 
-		// get URLs for each image
+		return \array_filter( \array_map( array( self::class, 'wp_attachment_to_activity_attachment' ), $image_ids ) );
-		foreach ( $image_ids as $id ) {
+	}
+
+	/**
+	 * Recursively get media IDs from blocks.
+	 * @param array $blocks The blocks to search for media IDs
+	 * @param array $media_ids The media IDs to append new IDs to
+	 * @param int $max_media The maximum number of media to return.
+	 *
+	 * @return array The image IDs.
+	 */
+	protected static function get_media_ids_from_blocks( $blocks, $media_ids, $max_media ) {
+
+		foreach ( $blocks as $block ) {
+			// recurse into inner blocks
+			if ( ! empty( $block['innerBlocks'] ) ) {
+				$media_ids = self::get_media_ids_from_blocks( $block['innerBlocks'], $media_ids, $max_media );
+			}
+
+			switch ( $block['blockName'] ) {
+				case 'core/image':
+				case 'core/cover':
+				case 'core/audio':
+				case 'core/video':
+				case 'videopress/video':
+					if ( ! empty( $block['attrs']['id'] ) ) {
+						$media_ids[] = $block['attrs']['id'];
+					}
+					break;
+				case 'jetpack/slideshow':
+				case 'jetpack/tiled-gallery':
+					if ( ! empty( $block['attrs']['ids'] ) ) {
+						$media_ids = array_merge( $media_ids, $block['attrs']['ids'] );
+					}
+					break;
+				case 'jetpack/image-compare':
+					if ( ! empty( $block['attrs']['beforeImageId'] ) ) {
+						$media_ids[] = $block['attrs']['beforeImageId'];
+					}
+					if ( ! empty( $block['attrs']['afterImageId'] ) ) {
+						$media_ids[] = $block['attrs']['afterImageId'];
+					}
+					break;
+			}
+
+			// stop doing unneeded work
+			if ( count( $media_ids ) >= $max_media ) {
+				break;
+			}
+		}
+
+		// still need to slice it because one gallery could knock us over the limit
+		return array_slice( $media_ids, 0, $max_media );
+	}
+
+	/**
+	 * Converts a WordPress Attachment to an ActivityPub Attachment.
+	 *
+	 * @param int $id The Attachment ID.
+	 *
+	 * @return array The ActivityPub Attachment.
+	 */
+	public static function wp_attachment_to_activity_attachment( $id ) {
+		$attachment = array();
+		$mime_type = \get_post_mime_type( $id );
+		$mime_type_parts = \explode( '/', $mime_type );
+		// switching on image/audio/video
+		switch ( $mime_type_parts[0] ) {
+			case 'image':
 				$image_size = 'full';
 
 				/**
@@ -268,28 +314,45 @@ class Post {
 				 */
 				$thumbnail = apply_filters(
 					'activitypub_get_image',
-				$this->get_image( $id, $image_size ),
+					self::get_image( $id, $image_size ),
 					$id,
 					$image_size
 				);
 
 				if ( $thumbnail ) {
-				$mimetype = \get_post_mime_type( $id );
 					$alt   = \get_post_meta( $id, '_wp_attachment_image_alt', true );
 					$image = array(
 						'type'      => 'Image',
 						'url'       => $thumbnail[0],
-					'mediaType' => $mimetype,
+						'mediaType' => $mime_type,
 					);
 
 					if ( $alt ) {
 						$image['name'] = $alt;
 					}
-				$images[] = $image;
+					$attachment = $image;
 				}
+				break;
+
+			case 'audio':
+			case 'video':
+				$attachment = array(
+					'type'      => 'Document',
+					'mediaType' => $mime_type,
+					'url'       => \wp_get_attachment_url( $id ),
+					'name'      => \get_the_title( $id ),
+				);
+				$meta = wp_get_attachment_metadata( $id );
+				// height and width for videos
+				if ( isset( $meta['width'] ) && isset( $meta['height'] ) ) {
+					$attachment['width'] = $meta['width'];
+					$attachment['height'] = $meta['height'];
+				}
+				// @todo: add `icon` support for audio/video attachments. Maybe use post thumbnail?
+				break;
 		}
 
-		return $images;
+		return \apply_filters( 'activitypub_attachment', $attachment, $id );
 	}
 
 	/**
@@ -300,7 +363,7 @@ class Post {
 	 *
 	 * @return array|false Array of image data, or boolean false if no image is available.
 	 */
-	protected function get_image( $id, $image_size = 'full' ) {
+	protected static function get_image( $id, $image_size = 'full' ) {
 		/**
 		 * Hook into the image retrieval process. Before image retrieval.
 		 *
@@ -309,7 +372,7 @@ class Post {
 		 */
 		do_action( 'activitypub_get_image_pre', $id, $image_size );
 
-		$thumbnail = \wp_get_attachment_image_src( $id, $image_size );
+		$image = \wp_get_attachment_image_src( $id, $image_size );
 
 		/**
 		 * Hook into the image retrieval process. After image retrieval.
@@ -319,7 +382,7 @@ class Post {
 		 */
 		do_action( 'activitypub_get_image_post', $id, $image_size );
 
-		return $thumbnail;
+		return $image;
 	}
 
 	/**

readme.txt

@@ -105,6 +105,10 @@ Where 'blog' is the path to the subdirectory at which your blog resides.
 
 Project maintained on GitHub at [automattic/wordpress-activitypub](https://github.com/automattic/wordpress-activitypub).
 
+= 1.1.0 =
+
+* Improved: audio and video attachments are now supported!
+
 = 1.0.10 =
 
 * Improved: better error messages if remote profile is not accessible

templates/settings.php

@@ -138,7 +138,7 @@
 					</tr>
 					<tr>
 						<th scope="row">
-							<?php \esc_html_e( 'Number of images', 'activitypub' ); ?>
+							<?php \esc_html_e( 'Media attachments', 'activitypub' ); ?>
 						</th>
 						<td>
 							<input value="<?php echo esc_attr( \get_option( 'activitypub_max_image_attachments', ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS ) ); ?>" name="activitypub_max_image_attachments" id="activitypub_max_image_attachments" type="number" min="0" />
@@ -147,13 +147,20 @@
 								echo \wp_kses(
 									\sprintf(
 										// translators:
-										\__( 'The number of images to attach to posts. Default: <code>%s</code>', 'activitypub' ),
+										\__( 'The number of media (images, audio, video) to attach to posts. Default: <code>%s</code>', 'activitypub' ),
 										\esc_html( ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS )
 									),
 									'default'
 								);
 								?>
 							</p>
+							<p class="description">
+								<em>
+									<?php
+										esc_html_e( 'Note: audio and video attachments are only supported from Block Editor.', 'activitypub' );
+									?>
+								</em>
+							</p>
 						</td>
 					</tr>
 					<tr>