Add/extendable transformers

activitypub.php

@@ -33,12 +33,15 @@
 \defined( 'ACTIVITYPUB_CUSTOM_POST_CONTENT' ) || \define( 'ACTIVITYPUB_CUSTOM_POST_CONTENT', "<strong>[ap_title]</strong>\n\n[ap_content]\n\n[ap_hashtags]\n\n[ap_shortlink]" );
 \defined( 'ACTIVITYPUB_AUTHORIZED_FETCH' ) || \define( 'ACTIVITYPUB_AUTHORIZED_FETCH', false );
 \defined( 'ACTIVITYPUB_DISABLE_REWRITES' ) || \define( 'ACTIVITYPUB_DISABLE_REWRITES', false );
+\defined( 'ACTIVITYPUB_DEFAULT_TRANSFORMER' ) || \define( 'ACTIVITYPUB_DEFAULT_TRANSFORMER', 'activitypub/default' );
+
 
 \define( 'ACTIVITYPUB_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
 \define( 'ACTIVITYPUB_PLUGIN_BASENAME', plugin_basename( __FILE__ ) );
 \define( 'ACTIVITYPUB_PLUGIN_FILE', plugin_dir_path( __FILE__ ) . '/' . basename( __FILE__ ) );
 \define( 'ACTIVITYPUB_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
 
+
 /**
  * Initialize REST routes.
  */

includes/activity/class-event.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Inspired by the PHP ActivityPub Library by @Landrok
+ *
+ * @link https://github.com/landrok/activitypub
+ */
+
+namespace Activitypub\Activity;
+
+use Activitypub\Activity\Base_Object;
+
+/**
+ * Event is an implementation of one of the
+ * Activity Streams Event object type
+ *
+ * The Object is the primary base type for the Activity Streams
+ * vocabulary.
+ *
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-event
+ */
+class Note extends Base_Object {
+	protected $type = 'Event';
+}

includes/activity/class-note.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Inspired by the PHP ActivityPub Library by @Landrok
+ *
+ * @link https://github.com/landrok/activitypub
+ */
+
+namespace Activitypub\Activity;
+
+use Activitypub\Activity\Base_Object;
+
+/**
+ * Note is an implementation of one of the
+ * Activity Streams Note object type
+ *
+ * The Object is the primary base type for the Activity Streams
+ * vocabulary.
+ *
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-note
+ */
+class Note extends Base_Object {
+	protected $type = 'Note';
+}

includes/class-activity-dispatcher.php

@@ -5,7 +5,7 @@
 use Activitypub\Activity\Activity;
 use Activitypub\Collection\Users;
 use Activitypub\Collection\Followers;
-use Activitypub\Transformer\Post;
+use Activitypub\Transformer\Transformers_Manager;
 
 use function Activitypub\is_single_user;
 use function Activitypub\is_user_disabled;
@@ -65,7 +65,8 @@ public static function send_activity( WP_Post $wp_post, $type ) {
 			return;
 		}
 
-		$object = Post::transform( $wp_post )->to_object();
+		$transformer = Transformers_Manager::instance()->get_transformer( $wp_post );
+		$object = $transformer->to_object();
 
 		$activity = new Activity();
 		$activity->set_type( $type );
@@ -101,7 +102,8 @@ public static function send_announce( WP_Post $wp_post, $type ) {
 			return;
 		}
 
-		$object = Post::transform( $wp_post )->to_object();
+		$transformer = Transformers_Manager::instance()->get_transformer( $wp_post );
+		$object = $transformer->to_object();
 
 		$activity = new Activity();
 		$activity->set_type( 'Announce' );

includes/class-activitypub.php

@@ -20,9 +20,9 @@ public static function init() {
 		\add_filter( 'get_comment_link', array( self::class, 'remote_comment_link' ), 11, 3 );
 
 		// Add support for ActivityPub to custom post types
-		$post_types = \get_option( 'activitypub_support_post_types', array( 'post', 'page' ) ) ? \get_option( 'activitypub_support_post_types', array( 'post', 'page' ) ) : array();
+		$transformer_mapping = \get_option( 'activitypub_transformer_mapping', array( 'post' => 'activitypub/default', 'page' => 'activitypub/default' ) ) ? \get_option( 'activitypub_transformer_mapping', array( 'post' => 'activitypub/default', 'page' => 'activitypub/default' ) ) : array();
 
-		foreach ( $post_types as $post_type ) {
+		foreach ( array_keys( $transformer_mapping ) as $post_type ) {
 			\add_post_type_support( $post_type, 'activitypub' );
 		}
 

includes/class-admin.php

@@ -3,6 +3,7 @@
 
 use WP_User_Query;
 use Activitypub\Model\Blog_User;
+use Activitypub\Base\Transformer\Base as Transformer_Base;
 
 /**
  * ActivityPub Admin Class
@@ -22,6 +23,15 @@ public static function init() {
 		if ( ! is_user_disabled( get_current_user_id() ) ) {
 			\add_action( 'show_user_profile', array( self::class, 'add_profile' ) );
 		}
+
+		add_filter(
+			'activitypub/transformers/is_transformer_enabled',
+			function( $should_register, Transformer_Base $transformer_instance ) {
+				return ! Options::is_transformer_disabled( $transformer_instance->get_name() );
+			},
+			10,
+			2
+		);
 	}
 
 	/**
@@ -154,14 +164,47 @@ public static function register_settings() {
 				'default' => '0',
 			)
 		);
-		\register_setting(
+
+		/**
+		 * Flexible activation of post_types together with mapping ActivityPub transformers.
+		 *
+		 * If a post-type is not mapped to any ActivtiyPub transformer it means it is not activated
+		 * for ActivityPub federation.
+		 *
+		 * @since version_number_transformer_management_placeholder
+		 */
+		register_setting(
 			'activitypub',
-			'activitypub_support_post_types',
+			'activitypub_transformer_mapping',
 			array(
-				'type'         => 'string',
-				'description'  => \esc_html__( 'Enable ActivityPub support for post types', 'activitypub' ),
-				'show_in_rest' => true,
-				'default'      => array( 'post', 'pages' ),
+				'type'         => 'array',
+				'default'      => array(
+					'post' => 'note',
+				),
+				'show_in_rest' => array(
+					'schema' => array(
+						'type'  => 'array',
+						'items' => array(
+							'type' => 'string',
+						),
+					),
+				),
+				'sanitize_callback' => function ( $value ) {
+					// Check if $value is an array
+					if ( ! is_array( $value ) ) {
+						return array();
+					}
+					$value_keys = array_keys( $value );
+
+					$all_public_post_types = \get_post_types( array( 'public' => true ), 'names' );
+
+					// Unset the keys that are missing in $keysToCheck
+					foreach ( array_diff( $value_keys, $all_public_post_types ) as $missing_key ) {
+						unset( $value[ $missing_key ] );
+					}
+					// var_dump($value);
+					return $value;
+				},
 			)
 		);
 		\register_setting(

includes/class-migration.php

@@ -4,6 +4,7 @@
 use Activitypub\Activitypub;
 use Activitypub\Model\Blog_User;
 use Activitypub\Collection\Followers;
+use Activitypub\Admin;
 
 /**
  * ActivityPub Migration Class
@@ -114,12 +115,30 @@ public static function maybe_migrate() {
 		if ( version_compare( $version_from_db, '1.0.0', '<' ) ) {
 			self::migrate_from_0_17();
 		}
+		if ( version_compare( $version_from_db, 'version_number_transformer_management_placeholder', '<' ) ) {
+			self::migrate_from_version_number_transformer_management_placeholder();
+		}
 
 		update_option( 'activitypub_db_version', self::get_target_version() );
 
 		self::unlock();
 	}
 
+	/**
+	 * Updates the supported post type settings to the mapped transformer setting.
+	 * TODO: Test this
+	 * @return void
+	 */
+	private static function migrate_from_version_number_transformer_management_placeholder() {
+		$supported_post_types = \get_option( 'activitypub_support_post_types', array( 'post', 'page' ) );
+		Admin::register_settings();
+		$transformer_mapping = array();
+		foreach ( $supported_post_types as $supported_post_type ) {
+			$transformer_mapping[ $supported_post_type ] = ACTIVITYPUB_DEFAULT_TRANSFORMER;
+		}
+		update_option( 'activitypub_transformer_mapping', $transformer_mapping );
+	}
+
 	/**
 	 * Updates the DB-schema of the followers-list
 	 *

includes/class-scheduler.php

@@ -4,7 +4,6 @@
 
 use Activitypub\Collection\Users;
 use Activitypub\Collection\Followers;
-use Activitypub\Transformer\Post;
 
 /**
  * ActivityPub Scheduler Class

includes/model/class-post.php

@@ -1,7 +1,7 @@
 <?php
 namespace Activitypub\Model;
 
-use Activitypub\Transformer\Post as Post_Transformer;
+use Activitypub\Transformer\Post as Transformer_Post;
 
 /**
  * ActivityPub Post Class
@@ -33,8 +33,9 @@ class Post {
 	public function __construct( $post, $post_author = null ) {
 		_deprecated_function( __CLASS__, '1.0.0', '\Activitypub\Transformer\Post' );
 
-		$this->post   = $post;
-		$this->object = Post_Transformer::transform( $post )->to_object();
+		$this->post = $post;
+		$transformer = new Transformer_Post();
+		$this->object = $transformer->set_wp_post( $post )->to_object();
 	}
 
 	/**

includes/rest/class-collection.php

@@ -4,7 +4,7 @@
 use WP_Error;
 use WP_REST_Server;
 use WP_REST_Response;
-use Activitypub\Transformer\Post;
+use Activitypub\Transformer\Transformers_Manager;
 use Activitypub\Activity\Activity;
 use Activitypub\Collection\Users as User_Collection;
 
@@ -168,7 +168,7 @@ public static function featured_get( $request ) {
 		);
 
 		foreach ( $posts as $post ) {
-			$response['orderedItems'][] = Post::transform( $post )->to_object()->to_array();
+			$response['orderedItems'][] = Transformers_Manager::instance()->get_transformer( $post )->to_object()->to_array();
 		}
 
 		$rest_response = new WP_REST_Response( $response, 200 );

includes/rest/class-outbox.php

@@ -5,7 +5,7 @@
 use WP_Error;
 use WP_REST_Server;
 use WP_REST_Response;
-use Activitypub\Transformer\Post;
+use Activitypub\Transformer\Transformers_Manager;
 use Activitypub\Activity\Activity;
 use Activitypub\Collection\Users as User_Collection;
 
@@ -59,7 +59,7 @@ public static function user_outbox_get( $request ) {
 			return $user;
 		}
 
-		$post_types = \get_option( 'activitypub_support_post_types', array( 'post', 'page' ) );
+		$post_types = array_keys( \get_option( 'activitypub_transformer_mapping', array( 'post' => 'activitypub/default', 'page' => 'activitypub/default' ) ) );
 
 		$page = $request->get_param( 'page', 1 );
 
@@ -105,7 +105,8 @@ public static function user_outbox_get( $request ) {
 			);
 
 			foreach ( $posts as $post ) {
-				$post = Post::transform( $post )->to_object();
+				$transformer = \Activitypub\Transformer\Transformers_Manager::instance()->get_transformer( $post );
+				$post = $transformer->to_object();
 				$activity = new Activity();
 				$activity->set_type( 'Create' );
 				$activity->set_context( null );