Merge pull request #213 from akirk/outgoing-mentions

Outgoing Mentions

Author: pfefferle

README.md

@@ -112,7 +112,7 @@ Project maintained on GitHub at [pfefferle/wordpress-activitypub](https://github
 
 ### 0.14.0 ###
 
-* Friends support: https://wordpress.org/plugins/friends/ . props [@akirk](https://github.com/akirk)
+* Friends support: https://wordpress.org/plugins/friends/ props [@akirk](https://github.com/akirk)
 * Massive guidance improvements. props [mediaformat](https://github.com/mediaformat) & [@akirk](https://github.com/akirk)
 * Add Custom Post Type support to outbox API. props [blueset](https://github.com/blueset)
 * Better hash-tag support. props [bocops](https://github.com/bocops)

activitypub.php

@@ -22,6 +22,8 @@ function init() {
 	\defined( 'ACTIVITYPUB_EXCERPT_LENGTH' ) || \define( 'ACTIVITYPUB_EXCERPT_LENGTH', 400 );
 	\defined( 'ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS' ) || \define( 'ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS', 3 );
 	\defined( 'ACTIVITYPUB_HASHTAGS_REGEXP' ) || \define( 'ACTIVITYPUB_HASHTAGS_REGEXP', '(?:(?<=\s)|(?<=<p>)|(?<=<br>)|^)#([A-Za-z0-9_]+)(?:(?=\s|[[:punct:]]|$))' );
+	\defined( 'ACTIVITYPUB_USERNAME_REGEXP' ) || \define( 'ACTIVITYPUB_USERNAME_REGEXP', '(?:([A-Za-z0-9_-]+)@((?:[A-Za-z0-9_-]+\.)+[A-Za-z]+))' );
+	\defined( 'ACTIVITYPUB_ALLOWED_HTML' ) || \define( 'ACTIVITYPUB_ALLOWED_HTML', '<strong><a><p><ul><ol><li><code><blockquote><pre><img>' );
 	\defined( 'ACTIVITYPUB_CUSTOM_POST_CONTENT' ) || \define( 'ACTIVITYPUB_CUSTOM_POST_CONTENT', "<p><strong>[ap_title]</strong></p>\n\n[ap_content]\n\n<p>[ap_hashtags]</p>\n\n<p>[ap_shortlink]</p>" );
 	\define( 'ACTIVITYPUB_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
 	\define( 'ACTIVITYPUB_PLUGIN_BASENAME', plugin_basename( __FILE__ ) );
@@ -73,6 +75,9 @@ function init() {
 	require_once \dirname( __FILE__ ) . '/includes/class-shortcodes.php';
 	\Activitypub\Shortcodes::init();
 
+	require_once \dirname( __FILE__ ) . '/includes/class-mention.php';
+	\Activitypub\Mention::init();
+
 	require_once \dirname( __FILE__ ) . '/includes/class-debug.php';
 	\Activitypub\Debug::init();
 
@@ -142,11 +147,3 @@ function enable_buddypress_features() {
 	\Activitypub\Integration\Buddypress::init();
 }
 add_action( 'bp_include', '\Activitypub\enable_buddypress_features' );
-
-add_action(
-	'friends_load_parsers',
-	function( \Friends\Feed $friends_feed ) {
-		require_once __DIR__ . '/integration/class-friends-feed-parser-activitypub.php';
-		$friends_feed->register_parser( Friends_Feed_Parser_ActivityPub::SLUG, new Friends_Feed_Parser_ActivityPub( $friends_feed ) );
-	}
-);

includes/class-activity-dispatcher.php

@@ -23,16 +23,35 @@ public static function init() {
 	 *
 	 * @param \Activitypub\Model\Post $activitypub_post
 	 */
-	public static function send_post_activity( $activitypub_post ) {
+	public static function send_post_activity( Model\Post $activitypub_post ) {
 		// get latest version of post
 		$user_id = $activitypub_post->get_post_author();
 
 		$activitypub_activity = new \Activitypub\Model\Activity( 'Create', \Activitypub\Model\Activity::TYPE_FULL );
-		$activitypub_activity->from_post( $activitypub_post->to_array() );
+		$activitypub_activity->from_post( $activitypub_post );
 
-		foreach ( \Activitypub\get_follower_inboxes( $user_id ) as $inbox => $to ) {
+		$inboxes = \Activitypub\get_follower_inboxes( $user_id );
+
+		$followers_url = \get_rest_url( null, '/activitypub/1.0/users/' . intval( $user_id ) . '/followers' );
+		foreach ( $activitypub_activity->get_cc() as $cc ) {
+			if ( $cc === $followers_url ) {
+				continue;
+			}
+			$inbox = \Activitypub\get_inbox_by_actor( $cc );
+			if ( ! $inbox || \is_wp_error( $inbox ) ) {
+				continue;
+			}
+			// init array if empty
+			if ( ! isset( $inboxes[ $inbox ] ) ) {
+				$inboxes[ $inbox ] = array();
+			}
+			$inboxes[ $inbox ][] = $cc;
+		}
+
+		foreach ( $inboxes as $inbox => $to ) {
+			$to = array_values( array_unique( $to ) );
 			$activitypub_activity->set_to( $to );
-			$activity = $activitypub_activity->to_json(); // phpcs:ignore
+			$activity = $activitypub_activity->to_json();
 
 			\Activitypub\safe_remote_post( $inbox, $activity, $user_id );
 		}

includes/class-hashtag.php

@@ -21,15 +21,15 @@ public static function init() {
 	 * Filter to save #tags as real WordPress tags
 	 *
 	 * @param int $id the rev-id
-	 * @param array $data the post-data as array
+	 * @param WP_Post $post the post
 	 *
 	 * @return
 	 */
-	public static function insert_post( $id, $data ) {
-		if ( \preg_match_all( '/' . ACTIVITYPUB_HASHTAGS_REGEXP . '/i', $data->post_content, $match ) ) {
+	public static function insert_post( $id, $post ) {
+		if ( \preg_match_all( '/' . ACTIVITYPUB_HASHTAGS_REGEXP . '/i', $post->post_content, $match ) ) {
 			$tags = \implode( ', ', $match[1] );
 
-			\wp_add_post_tags( $data->post_parent, $tags );
+			\wp_add_post_tags( $post->post_parent, $tags );
 		}
 
 		return $id;

includes/class-mention.php

@@ -0,0 +1,86 @@
+<?php
+namespace Activitypub;
+
+/**
+ * ActivityPub Mention Class
+ *
+ * @author Alex Kirk
+ */
+class Mention {
+	/**
+	 * Initialize the class, registering WordPress hooks
+	 */
+	public static function init() {
+		\add_filter( 'the_content', array( '\Activitypub\Mention', 'the_content' ), 99, 2 );
+		\add_filter( 'activitypub_extract_mentions', array( '\Activitypub\Mention', 'extract_mentions' ), 99, 2 );
+	}
+
+	/**
+	 * Filter to replace the mentions in the content with links
+	 *
+	 * @param string $the_content the post-content
+	 *
+	 * @return string the filtered post-content
+	 */
+	public static function the_content( $the_content ) {
+		$protected_tags = array();
+		$the_content = preg_replace_callback(
+			'#<a.*?href=[^>]+>.*?</a>#i',
+			function( $m ) use ( &$protected_tags ) {
+				$c = count( $protected_tags );
+				$protect = '!#!#PROTECT' . $c . '#!#!';
+				$protected_tags[ $protect ] = $m[0];
+				return $protect;
+			},
+			$the_content
+		);
+
+		$the_content = \preg_replace_callback( '/@' . ACTIVITYPUB_USERNAME_REGEXP . '/', array( '\Activitypub\Mention', 'replace_with_links' ), $the_content );
+
+		$the_content = str_replace( array_keys( $protected_tags ), array_values( $protected_tags ), $the_content );
+
+		return $the_content;
+	}
+
+	/**
+	 * A callback for preg_replace to build the user links
+	 *
+	 * @param array $result the preg_match results
+	 * @return string the final string
+	 */
+	public static function replace_with_links( $result ) {
+		$metadata = \ActivityPub\get_remote_metadata_by_actor( $result[0] );
+		if ( ! is_wp_error( $metadata ) && ! empty( $metadata['url'] ) ) {
+			$username = ltrim( $result[0], '@' );
+			if ( ! empty( $metadata['name'] ) ) {
+				$username = $metadata['name'];
+			}
+			if ( ! empty( $metadata['preferredUsername'] ) ) {
+				$username = $metadata['preferredUsername'];
+			}
+			$username = '@<span>' . $username . '</span>';
+			return \sprintf( '<a rel="mention" class="u-url mention" href="%s">%s</a>', $metadata['url'], $username );
+		}
+
+		return $result[0];
+	}
+
+	/**
+	 * Extract the mentions from the post_content.
+	 *
+	 * @param array $mentions The already found mentions.
+	 * @param string $post_content The post content.
+	 * @return mixed The discovered mentions.
+	 */
+	public static function extract_mentions( $mentions, $post_content ) {
+		\preg_match_all( '/@' . ACTIVITYPUB_USERNAME_REGEXP . '/i', $post_content, $matches );
+		foreach ( $matches[0] as $match ) {
+			$link = \Activitypub\Webfinger::resolve( $match );
+			if ( ! is_wp_error( $link ) ) {
+				$mentions[ $match ] = $link;
+			}
+		}
+		return $mentions;
+
+	}
+}

includes/class-webfinger.php

@@ -28,12 +28,21 @@ public static function get_user_resource( $user_id ) {
 	}
 
 	public static function resolve( $account ) {
-		if ( ! preg_match( '/^@?[^@]+@((?:[a-z0-9-]+\.)+[a-z]+)$/i', $account, $m ) ) {
+		if ( ! preg_match( '/^@?' . ACTIVITYPUB_USERNAME_REGEXP . '$/i', $account, $m ) ) {
 			return null;
 		}
-		$url = \add_query_arg( 'resource', 'acct:' . ltrim( $account, '@' ), 'https://' . $m[1] . '/.well-known/webfinger' );
+		$transient_key = 'activitypub_resolve_' . ltrim( $account, '@' );
+
+		$link = \get_transient( $transient_key );
+		if ( $link ) {
+			return $link;
+		}
+
+		$url = \add_query_arg( 'resource', 'acct:' . ltrim( $account, '@' ), 'https://' . $m[2] . '/.well-known/webfinger' );
 		if ( ! \wp_http_validate_url( $url ) ) {
-			return new \WP_Error( 'invalid_webfinger_url', null, $url );
+			$response = new \WP_Error( 'invalid_webfinger_url', null, $url );
+			\set_transient( $transient_key, $response, HOUR_IN_SECONDS ); // Cache the error for a shorter period.
+			return $response;
 		}
 
 		// try to access author URL
@@ -42,28 +51,34 @@ public static function resolve( $account ) {
 			array(
 				'headers' => array( 'Accept' => 'application/activity+json' ),
 				'redirection' => 0,
+				'timeout' => 2,
 			)
 		);
 
 		if ( \is_wp_error( $response ) ) {
-			return new \WP_Error( 'webfinger_url_not_accessible', null, $url );
+			$link = new \WP_Error( 'webfinger_url_not_accessible', null, $url );
+			\set_transient( $transient_key, $link, HOUR_IN_SECONDS ); // Cache the error for a shorter period.
+			return $link;
 		}
 
-		$response_code = \wp_remote_retrieve_response_code( $response );
-
 		$body = \wp_remote_retrieve_body( $response );
 		$body = \json_decode( $body, true );
 
-		if ( ! isset( $body['links'] ) ) {
-			return new \WP_Error( 'webfinger_url_invalid_response', null, $url );
+		if ( empty( $body['links'] ) ) {
+			$link = new \WP_Error( 'webfinger_url_invalid_response', null, $url );
+			\set_transient( $transient_key, $link, HOUR_IN_SECONDS ); // Cache the error for a shorter period.
+			return $link;
 		}
 
 		foreach ( $body['links'] as $link ) {
 			if ( 'self' === $link['rel'] && 'application/activity+json' === $link['type'] ) {
+				\set_transient( $transient_key, $link['href'], WEEK_IN_SECONDS );
 				return $link['href'];
 			}
 		}
 
-		return new \WP_Error( 'webfinger_url_no_activity_pub', null, $body );
+		$link = new \WP_Error( 'webfinger_url_no_activity_pub', null, $body );
+		\set_transient( $transient_key, $link, HOUR_IN_SECONDS ); // Cache the error for a shorter period.
+		return $link;
 	}
 }

includes/functions.php

@@ -68,7 +68,7 @@ function safe_remote_get( $url, $user_id ) {
 	$wp_version = \get_bloginfo( 'version' );
 	$user_agent = \apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . \get_bloginfo( 'url' ) );
 	$args = array(
-		'timeout' => 100,
+		'timeout' => apply_filters( 'activitypub_remote_get_timeout', 100 ),
 		'limit_response_size' => 1048576,
 		'redirection' => 3,
 		'user-agent' => "$user_agent; ActivityPub",
@@ -110,8 +110,8 @@ function get_remote_metadata_by_actor( $actor ) {
 	if ( $pre ) {
 		return $pre;
 	}
-	if ( preg_match( '/^@?[^@]+@((?:[a-z0-9-]+\.)+[a-z]+)$/i', $actor ) ) {
-		$actor = \Activitypub\Webfinger::resolve( $actor );
+	if ( preg_match( '/^@?' . ACTIVITYPUB_USERNAME_REGEXP . '$/i', $actor ) ) {
+		$actor = Webfinger::resolve( $actor );
 	}
 
 	if ( ! $actor ) {
@@ -122,41 +122,50 @@ function get_remote_metadata_by_actor( $actor ) {
 		return $actor;
 	}
 
-	$metadata = \get_transient( 'activitypub_' . $actor );
+	$transient_key = 'activitypub_' . $actor;
+	$metadata = \get_transient( $transient_key );
 
 	if ( $metadata ) {
 		return $metadata;
 	}
 
 	if ( ! \wp_http_validate_url( $actor ) ) {
-		return new \WP_Error( 'activitypub_no_valid_actor_url', \__( 'The "actor" is no valid URL', 'activitypub' ), $actor );
+		$metadata = new \WP_Error( 'activitypub_no_valid_actor_url', \__( 'The "actor" is no valid URL', 'activitypub' ), $actor );
+		\set_transient( $transient_key, $metadata, HOUR_IN_SECONDS ); // Cache the error for a shorter period.
+		return $metadata;
 	}
 
 	$user = \get_users(
 		array(
 			'number' => 1,
-			'who'    => 'authors',
+			'capability__in' => array( 'publish_posts' ),
 			'fields' => 'ID',
 		)
 	);
 
 	// we just need any user to generate a request signature
 	$user_id = \reset( $user );
-
+	$short_timeout = function() {
+		return 3;
+	};
+	add_filter( 'activitypub_remote_get_timeout', $short_timeout );
 	$response = \Activitypub\safe_remote_get( $actor, $user_id );
-
+	remove_filter( 'activitypub_remote_get_timeout', $short_timeout );
 	if ( \is_wp_error( $response ) ) {
+		\set_transient( $transient_key, $response, HOUR_IN_SECONDS ); // Cache the error for a shorter period.
 		return $response;
 	}
 
 	$metadata = \wp_remote_retrieve_body( $response );
 	$metadata = \json_decode( $metadata, true );
 
 	if ( ! $metadata ) {
-		return new \WP_Error( 'activitypub_invalid_json', \__( 'No valid JSON data', 'activitypub' ), $actor );
+		$metadata = new \WP_Error( 'activitypub_invalid_json', \__( 'No valid JSON data', 'activitypub' ), $actor );
+		\set_transient( $transient_key, $metadata, HOUR_IN_SECONDS ); // Cache the error for a shorter period.
+		return $metadata;
 	}
 
-	\set_transient( 'activitypub_' . $actor, $metadata, WEEK_IN_SECONDS );
+	\set_transient( $transient_key, $metadata, WEEK_IN_SECONDS );
 
 	return $metadata;
 }

includes/model/class-activity.php

@@ -45,20 +45,28 @@ public function __call( $method, $params ) {
 		}
 	}
 
-	public function from_post( $object ) {
-		$this->object = $object;
+	public function from_post( Post $post ) {
+		$this->object = $post->to_array();
+
 		if ( isset( $object['published'] ) ) {
 			$this->published = $object['published'];
 		}
+		$this->cc = array( \get_rest_url( null, '/activitypub/1.0/users/' . intval( $post->get_post_author() ) . '/followers' ) );
+
+		if ( isset( $this->object['attributedTo'] ) ) {
+			$this->actor = $this->object['attributedTo'];
+		}
 
-		if ( isset( $object['attributedTo'] ) ) {
-			$this->actor = $object['attributedTo'];
+		foreach ( $post->get_tags() as $tag ) {
+			if ( 'Mention' === $tag['type'] ) {
+				$this->cc[] = $tag['href'];
+			}
 		}
 
 		$type = \strtolower( $this->type );
 
-		if ( isset( $object['id'] ) ) {
-			$this->id = add_query_arg( 'activity', $type, $object['id'] );
+		if ( isset( $this->object['id'] ) ) {
+			$this->id = add_query_arg( 'activity', $type, $this->object['id'] );
 		}
 	}