Outbox Collection

includes/activity/class-base-object.php

@@ -585,7 +585,7 @@ public static function init_from_json( $json ) {
 		$array = \json_decode( $json, true );
 
 		if ( ! is_array( $array ) ) {
-			$array = array();
+			return new WP_Error( 'invalid_json', __( 'Invalid JSON', 'activitypub' ), array( 'status' => 400 ) );
 		}
 
 		return self::init_from_array( $array );
@@ -600,15 +600,11 @@ public static function init_from_json( $json ) {
 	 */
 	public static function init_from_array( $data ) {
 		if ( ! is_array( $data ) ) {
-			return new WP_Error( 'invalid_array', __( 'Invalid array', 'activitypub' ), array( 'status' => 404 ) );
+			return new WP_Error( 'invalid_array', __( 'Invalid array', 'activitypub' ), array( 'status' => 400 ) );
 		}
 
 		$object = new static();
-
-		foreach ( $data as $key => $value ) {
-			$key = camel_to_snake_case( $key );
-			call_user_func( array( $object, 'set_' . $key ), $value );
-		}
+		$object->from_array( $data );
 
 		return $object;
 	}

includes/class-activitypub.php

@@ -8,6 +8,7 @@
 namespace Activitypub;
 
 use Exception;
+use Activitypub\Collection\Outbox;
 use Activitypub\Collection\Followers;
 use Activitypub\Collection\Extra_Fields;
 
@@ -453,7 +454,7 @@ public static function plugin_update_message( $data ) {
 	}
 
 	/**
-	 * Register the "Followers" Taxonomy.
+	 * Register Custom Post Types.
 	 */
 	private static function register_post_types() {
 		\register_post_type(
@@ -523,6 +524,24 @@ private static function register_post_types() {
 			)
 		);
 
+		// Register Outbox Post-Type.
+		register_post_type(
+			Outbox::POST_TYPE,
+			array(
+				'labels'           => array(
+					'name'          => _x( 'Outbox', 'post_type plural name', 'activitypub' ),
+					'singular_name' => _x( 'Outbox Item', 'post_type single name', 'activitypub' ),
+				),
+				'public'           => false,
+				'hierarchical'     => false,
+				'rewrite'          => false,
+				'query_var'        => false,
+				'delete_with_user' => false,
+				'can_export'       => true,
+				'supports'         => array(),
+			)
+		);
+
 		// Both User and Blog Extra Fields types have the same args.
 		$args = array(
 			'labels'              => array(

includes/class-scheduler.php

@@ -102,7 +102,6 @@ public static function deregister_schedules() {
 		wp_unschedule_hook( 'activitypub_cleanup_followers' );
 	}
 
-
 	/**
 	 * Schedule Activities.
 	 *

includes/collection/class-outbox.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Outbox collection file.
+ *
+ * @package Activitypub
+ */
+
+namespace Activitypub\Collection;
+
+use Activitypub\Transformer\Factory;
+
+/**
+ * ActivityPub Outbox Collection
+ */
+class Outbox {
+	const POST_TYPE = 'ap_outbox';
+
+	/**
+	 * Add an Item to the outbox.
+	 *
+	 * @param string|array|Base_Object|WP_Post|WP_Comment $item The item to add.
+	 * @param int                                         $user_id The user ID.
+	 * @param string                                      $activity_type The activity type.
+	 *
+	 * @return mixed The added item or an error.
+	 */
+	public static function add_item( $item, $user_id, $activity_type = 'Create' ) {
+		$transformer = Factory::get_transformer( $item );
+		$object      = $transformer->transform();
+
+		if ( ! $object || is_wp_error( $object ) ) {
+			return $object;
+		}
+
+		$outbox_item = array(
+			'post_type'    => self::POST_TYPE,
+			'post_title'   => $object->get_id(),
+			'post_content' => $object->to_json(),
+			'post_author'  => $user_id,
+			'post_status'  => 'draft',
+		);
+
+		$has_kses = false !== \has_filter( 'content_save_pre', 'wp_filter_post_kses' );
+		if ( $has_kses ) {
+			// Prevent KSES from corrupting JSON in post_content.
+			\kses_remove_filters();
+		}
+
+		$result = \wp_insert_post( $outbox_item, true );
+
+		if ( $has_kses ) {
+			\kses_init_filters();
+		}
+
+		return $result;
+	}
+}

includes/collection/class-replies.php

@@ -74,7 +74,7 @@ private static function get_id( $wp_object ) {
 		} elseif ( $wp_object instanceof WP_Comment ) {
 			return get_rest_url_by_path( sprintf( 'comments/%d/replies', $wp_object->comment_ID ) );
 		} else {
-			return new WP_Error();
+			return new WP_Error( 'unsupported_object', 'The object is not a post or comment.' );
 		}
 	}
 
@@ -88,7 +88,7 @@ private static function get_id( $wp_object ) {
 	public static function get_collection( $wp_object ) {
 		$id = self::get_id( $wp_object );
 
-		if ( ! $id ) {
+		if ( ! $id || is_wp_error( $id ) ) {
 			return null;
 		}
 

includes/handler/class-update.php

@@ -26,7 +26,7 @@ public static function init() {
 	}
 
 	/**
-	 * Handle "Update" requests
+	 * Handle "Update" requests.
 	 *
 	 * @param array $activity The activity-object.
 	 */

includes/transformer/class-activity-object.php

@@ -0,0 +1,155 @@
+<?php
+/**
+ * Activity Object Transformer Class.
+ *
+ * @package Activitypub
+ */
+
+namespace Activitypub\Transformer;
+
+/**
+ * Activity Object Transformer Class.
+ */
+class Activity_Object extends Base {
+	/**
+	 * Transform the WordPress Object into an ActivityPub Object.
+	 *
+	 * @return Base_Object The ActivityPub Object.
+	 */
+	public function to_object() {
+		return $this->transform_object_properties( $this->item );
+	}
+
+	/**
+	 * Get the ID of the WordPress Object.
+	 *
+	 * @return string The ID of the WordPress Object.
+	 */
+	protected function get_id() {
+		return '';
+	}
+
+	/**
+	 * Helper function to get the @-Mentions from the post content.
+	 *
+	 * @return array The list of @-Mentions.
+	 */
+	protected function get_mentions() {
+		/**
+		 * Filter the mentions in the post content.
+		 *
+		 * @param array   $mentions The mentions.
+		 * @param string  $content  The post content.
+		 * @param WP_Post $post     The post object.
+		 *
+		 * @return array The filtered mentions.
+		 */
+		return apply_filters(
+			'activitypub_extract_mentions',
+			array(),
+			$this->item->get_content() . ' ' . $this->item->get_summary(),
+			$this->item
+		);
+	}
+
+	/**
+	 * Returns a list of Mentions, used in the Post.
+	 *
+	 * @see https://docs.joinmastodon.org/spec/activitypub/#Mention
+	 *
+	 * @return array The list of Mentions.
+	 */
+	protected function get_cc() {
+		$cc       = array();
+		$mentions = $this->get_mentions();
+
+		if ( $mentions ) {
+			foreach ( $mentions as $url ) {
+				$cc[] = $url;
+			}
+		}
+
+		return $cc;
+	}
+
+	/**
+	 * Returns the content map for the post.
+	 *
+	 * @return array The content map for the post.
+	 */
+	protected function get_content_map() {
+		$content = $this->item->get_content();
+
+		if ( ! $content ) {
+			return null;
+		}
+
+		return array(
+			$this->get_locale() => $content,
+		);
+	}
+
+	/**
+	 * Returns the name map for the post.
+	 *
+	 * @return array The name map for the post.
+	 */
+	protected function get_name_map() {
+		$name = $this->item->get_name();
+
+		if ( ! $name ) {
+			return null;
+		}
+
+		return array(
+			$this->get_locale() => $name,
+		);
+	}
+
+	/**
+	 * Returns the summary map for the post.
+	 *
+	 * @return array The summary map for the post.
+	 */
+	protected function get_summary_map() {
+		$summary = $this->item->get_summary();
+
+		if ( ! $summary ) {
+			return null;
+		}
+
+		return array(
+			$this->get_locale() => $summary,
+		);
+	}
+
+	/**
+	 * Returns a list of Tags, used in the Comment.
+	 *
+	 * This includes Hash-Tags and Mentions.
+	 *
+	 * @return array The list of Tags.
+	 */
+	protected function get_tag() {
+		$tags = $this->item->get_tags();
+
+		if ( ! $tags ) {
+			$tags = array();
+		}
+
+		$mentions = $this->get_mentions();
+
+		if ( $mentions ) {
+			foreach ( $mentions as $mention => $url ) {
+				$tag    = array(
+					'type' => 'Mention',
+					'href' => \esc_url( $url ),
+					'name' => \esc_html( $mention ),
+				);
+				$tags[] = $tag;
+			}
+		}
+
+		return \array_unique( $tags, SORT_REGULAR );
+	}
+}

includes/transformer/class-attachment.php

@@ -24,7 +24,7 @@ class Attachment extends Post {
 	 * @return array The Attachments.
 	 */
 	protected function get_attachment() {
-		$mime_type  = get_post_mime_type( $this->wp_object->ID );
+		$mime_type  = get_post_mime_type( $this->item->ID );
 		$media_type = preg_replace( '/(\/[a-zA-Z]+)/i', '', $mime_type );
 		$type       = '';
 
@@ -40,11 +40,11 @@ protected function get_attachment() {
 
 		$attachment = array(
 			'type'      => $type,
-			'url'       => wp_get_attachment_url( $this->wp_object->ID ),
+			'url'       => wp_get_attachment_url( $this->item->ID ),
 			'mediaType' => $mime_type,
 		);
 
-		$alt = \get_post_meta( $this->wp_object->ID, '_wp_attachment_image_alt', true );
+		$alt = \get_post_meta( $this->item->ID, '_wp_attachment_image_alt', true );
 		if ( $alt ) {
 			$attachment['name'] = $alt;
 		}