Emoji: First pass at support in Interactions

Author: obenland

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Undo API for Outbox items.
 * Metadata to New Follower E-Mail.
 * Allow Activities on URLs instead of requiring Activity-Objects. This is useful especially for sending Announces and Likes.
+* Support for custom emoji in interaction contents and actor names.
 
 ### Changed
 

includes/collection/class-interactions.php

@@ -77,8 +77,8 @@ public static function update_comment( $activity ) {
 		}
 
 		// Found a local comment id.
-		$commentdata['comment_author']  = \esc_attr( $meta['name'] ? $meta['name'] : $meta['preferredUsername'] );
-		$commentdata['comment_content'] = \addslashes( $activity['object']['content'] );
+		$commentdata['comment_author']  = self::replace_custom_emoji( $meta['name'] ? $meta['name'] : $meta['preferredUsername'], $meta );
+		$commentdata['comment_content'] = \addslashes( self::replace_custom_emoji( $activity['object']['content'], $activity['object'] ) );
 
 		return self::persist( $commentdata, self::UPDATE );
 	}
@@ -209,14 +209,22 @@ public static function allowed_comment_html( $allowed_tags, $context = '' ) {
 		}
 
 		// Add `p` and `br` to the list of allowed tags.
-		if ( ! array_key_exists( 'br', $allowed_tags ) ) {
+		if ( ! isset( $allowed_tags['br'] ) ) {
 			$allowed_tags['br'] = array();
 		}
 
-		if ( ! array_key_exists( 'p', $allowed_tags ) ) {
+		if ( ! isset( $allowed_tags['p'] ) ) {
 			$allowed_tags['p'] = array();
 		}
 
+		if ( ! isset( $allowed_tags['img'] ) ) {
+			$allowed_tags['img'] = array(
+				'src'   => array(),
+				'alt'   => array(),
+				'class' => array(),
+			);
+		}
+
 		return $allowed_tags;
 	}
 
@@ -257,9 +265,9 @@ public static function activity_to_comment( $activity ) {
 		}
 
 		$commentdata = array(
-			'comment_author'       => \esc_attr( $comment_author ),
+			'comment_author'       => self::replace_custom_emoji( $comment_author, $actor ),
 			'comment_author_url'   => \esc_url_raw( $url ),
-			'comment_content'      => $comment_content,
+			'comment_content'      => self::replace_custom_emoji( $comment_content, $activity['object'] ),
 			'comment_type'         => 'comment',
 			'comment_author_email' => '',
 			'comment_meta'         => array(
@@ -339,4 +347,34 @@ public static function count_by_type( $post_id, $type ) {
 			)
 		);
 	}
+
+	/**
+	 * Replace custom emoji shortcodes with their corresponding emoji.
+	 *
+	 * @param string $text     The text to process.
+	 * @param array  $activity The activity array containing emoji definitions.
+	 *
+	 * @return string The processed text with emoji replacements.
+	 */
+	private static function replace_custom_emoji( $text, $activity ) {
+		if ( empty( $activity['tag'] ) || ! is_array( $activity['tag'] ) ) {
+			return $text;
+		}
+
+		foreach ( $activity['tag'] as $tag ) {
+			if ( isset( $tag['type'] ) && 'Emoji' === $tag['type'] && ! empty( $tag['name'] ) && ! empty( $tag['icon']['url'] ) ) {
+				$text = str_replace(
+					$tag['name'],
+					sprintf(
+						'<img src="%s" alt="%s" class="emoji" />',
+						\esc_url( $tag['icon']['url'] ),
+						\esc_attr( $tag['name'] )
+					),
+					$text
+				);
+			}
+		}
+
+		return $text;
+	}
 }

readme.txt

@@ -137,6 +137,7 @@ For reasons of data protection, it is not possible to see the followers of other
 * Added: Undo API for Outbox items.
 * Added: Setting to adjust the number of days Outbox items are kept before being purged.
 * Added: Show metadata in the New Follower E-Mail.
+* Added: Support for custom emoji in interaction contents and actor names.
 * Changed: Outbox now precesses the first batch of followers right away to avoid delays in processing new Activities.
 * Changed: Post bulk edits no longer create Outbox items, unless author or post status change.
 * Fixed: The Outbox purging routine no longer is limited to deleting 5 items at a time.

tests/includes/collection/class-test-interactions.php

@@ -471,4 +471,60 @@ function () {
 
 		remove_all_filters( 'pre_get_remote_metadata_by_actor' );
 	}
+
+	/**
+	 * Test emoji replacement in activity_to_comment.
+	 *
+	 * @covers ::activity_to_comment
+	 * @covers ::replace_custom_emoji
+	 */
+	public function test_activity_to_comment_with_emoji() {
+		$activity = array(
+			'@context' => array(
+				'https://www.w3.org/ns/activitystreams',
+				array(
+					'Emoji' => 'http://joinmastodon.org/ns#Emoji',
+				),
+			),
+			'id'       => 'https://example.com/activities/1',
+			'type'     => 'Note',
+			'content'  => 'Hello world :kappa: and :smile:',
+			'actor'    => $this->user_url,
+			'object'   => array(
+				'id'      => 'https://example.com/objects/1',
+				'content' => 'Hello world :kappa: and :smile:',
+				'tag'     => array(
+					array(
+						'type' => 'Emoji',
+						'name' => ':kappa:',
+						'icon' => array(
+							'type'      => 'Image',
+							'mediaType' => 'image/png',
+							'url'       => 'https://example.com/files/kappa.png',
+						),
+					),
+					array(
+						'type' => 'Emoji',
+						'name' => ':smile:',
+						'icon' => array(
+							'type'      => 'Image',
+							'mediaType' => 'image/png',
+							'url'       => 'https://example.com/files/smile.png',
+						),
+					),
+				),
+			),
+		);
+
+		$commentdata = Interactions::activity_to_comment( $activity );
+
+		$this->assertStringContainsString(
+			'<img src="https://example.com/files/kappa.png" alt=":kappa:" class="emoji" />',
+			$commentdata['comment_content']
+		);
+		$this->assertStringContainsString(
+			'<img src="https://example.com/files/smile.png" alt=":smile:" class="emoji" />',
+			$commentdata['comment_content']
+		);
+	}
 }