Add/event objects

includes/activity/class-activity.php

@@ -17,75 +17,15 @@
  * @see https://www.w3.org/TR/activitystreams-core/#intransitiveactivities
  */
 class Activity extends Base_Object {
-	const CONTEXT = array(
+	const JSON_LD_CONTEXT = array(
 		'https://www.w3.org/ns/activitystreams',
-		'https://w3id.org/security/v1',
-		'https://purl.archive.org/socialweb/webfinger',
-		array(
-			'manuallyApprovesFollowers' => 'as:manuallyApprovesFollowers',
-			'PropertyValue' => 'schema:PropertyValue',
-			'schema' => 'http://schema.org#',
-			'pt' => 'https://joinpeertube.org/ns#',
-			'toot' => 'http://joinmastodon.org/ns#',
-			'litepub' => 'http://litepub.social/ns#',
-			'lemmy' => 'https://join-lemmy.org/ns#',
-			'value' => 'schema:value',
-			'Hashtag' => 'as:Hashtag',
-			'featured' => array(
-				'@id' => 'toot:featured',
-				'@type' => '@id',
-			),
-			'featuredTags' => array(
-				'@id' => 'toot:featuredTags',
-				'@type' => '@id',
-			),
-			'alsoKnownAs' => array(
-				'@id' => 'as:alsoKnownAs',
-				'@type' => '@id',
-			),
-			'moderators' => array(
-				'@id' => 'lemmy:moderators',
-				'@type' => '@id',
-			),
-			'postingRestrictedToMods' => 'lemmy:postingRestrictedToMods',
-			'discoverable' => 'toot:discoverable',
-			'indexable' => 'toot:indexable',
-			'sensitive' => 'as:sensitive',
-		),
 	);
 
-	/**
-	 * The object's unique global identifier
-	 *
-	 * @see https://www.w3.org/TR/activitypub/#obj-id
-	 *
-	 * @var string
-	 */
-	protected $id;
-
 	/**
 	 * @var string
 	 */
 	protected $type = 'Activity';
 
-	/**
-	 * The context within which the object exists or an activity was
-	 * performed.
-	 * The notion of "context" used is intentionally vague.
-	 * The intended function is to serve as a means of grouping objects
-	 * and activities that share a common originating context or
-	 * purpose. An example could be all activities relating to a common
-	 * project or event.
-	 *
-	 * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-context
-	 *
-	 * @var string
-	 *    | ObjectType
-	 *    | Link
-	 *    | null
-	 */
-	protected $context = self::CONTEXT;
-
 	/**
 	 * Describes the direct object of the activity.
 	 * For instance, in the activity "John added a movie to his
@@ -94,7 +34,7 @@ class Activity extends Base_Object {
 	 * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object-term
 	 *
 	 * @var string
-	 *    | Base_Objectr
+	 *    | Base_Object
 	 *    | Link
 	 *    | null
 	 */
@@ -225,4 +165,18 @@ public function set_object( $object ) {
 			$this->set( 'id', $object->get_id() . '#activity' );
 		}
 	}
+
+	/**
+	 * The context of an Activity is usually just the context of the object it contains.
+	 *
+	 * @return array $context A compacted JSON-LD context.
+	 */
+	public function get_json_ld_context() {
+		if ( $this->object instanceof Base_Object ) {
+			// Without php 5.6 support this could be just: 'return  $this->object::JSON_LD_CONTEXT;'
+			return call_user_func( array( get_class( $this->object ), 'CONTEXT' ) );
+		} else {
+			return self::JSON_LD_CONTEXT;
+		}
+	}
 }

includes/activity/class-actor.php

@@ -16,6 +16,39 @@
  * @see https://www.w3.org/TR/activitystreams-vocabulary/#actor-types
  */
 class Actor extends Base_Object {
+	// Reduced context for actors. TODO: still unused.
+	const JSON_LD_CONTEXT = array(
+		'https://www.w3.org/ns/activitystreams',
+		'https://w3id.org/security/v1',
+		'https://purl.archive.org/socialweb/webfinger',
+		array(
+			'schema' => 'http://schema.org#',
+			'toot' => 'http://joinmastodon.org/ns#',
+			'webfinger' => 'https://webfinger.net/#',
+			'lemmy' => 'https://join-lemmy.org/ns#',
+			'manuallyApprovesFollowers' => 'as:manuallyApprovesFollowers',
+			'PropertyValue' => 'schema:PropertyValue',
+			'value' => 'schema:value',
+			'Hashtag' => 'as:Hashtag',
+			'featured' => array(
+				'@id' => 'toot:featured',
+				'@type' => '@id',
+			),
+			'featuredTags' => array(
+				'@id' => 'toot:featuredTags',
+				'@type' => '@id',
+			),
+			'moderators' => array(
+				'@id' => 'lemmy:moderators',
+				'@type' => '@id',
+			),
+			'postingRestrictedToMods' => 'lemmy:postingRestrictedToMods',
+			'discoverable' => 'toot:discoverable',
+			'indexable' => 'toot:indexable',
+			'resource' => 'webfinger:resource',
+		),
+	);
+
 	/**
 	 * @var string
 	 */
@@ -133,6 +166,8 @@ class Actor extends Base_Object {
 	 *
 	 * @see https://docs.joinmastodon.org/spec/activitypub/#as
 	 *
+	 * @context as:manuallyApprovesFollowers
+	 *
 	 * @var boolean
 	 */
 	protected $manually_approves_followers = false;

includes/activity/class-base-object.php

@@ -9,6 +9,7 @@
 
 use WP_Error;
 use ReflectionClass;
+use DateTime;
 
 use function Activitypub\camel_to_snake_case;
 use function Activitypub\snake_to_camel_case;
@@ -26,6 +27,13 @@
  * @see https://www.w3.org/TR/activitystreams-core/#object
  */
 class Base_Object {
+	const JSON_LD_CONTEXT = array(
+		'https://www.w3.org/ns/activitystreams',
+		array(
+			'Hashtag' => 'as:Hashtag',
+		),
+	);
+
 	/**
 	 * The object's unique global identifier
 	 *
@@ -457,7 +465,7 @@ public function __call( $method, $params ) {
 		}
 
 		if ( \strncasecmp( $method, 'set', 3 ) === 0 ) {
-			$this->set( $var, $params[0] );
+			return $this->set( $var, $params[0] );
 		}
 
 		if ( \strncasecmp( $method, 'add', 3 ) === 0 ) {
@@ -524,7 +532,7 @@ public function set( $key, $value ) {
 
 		$this->$key = $value;
 
-		return $this->$key;
+		return $this;
 	}
 
 	/**
@@ -622,9 +630,11 @@ public function from_array( $array ) {
 	 * It tries to get the object attributes if they exist
 	 * and falls back to the getters. Empty values are ignored.
 	 *
+	 * @param bool $include_json_ld_context
+	 *
 	 * @return array An array built from the Object.
 	 */
-	public function to_array() {
+	public function to_array( $include_json_ld_context = true ) {
 		$array = array();
 		$vars  = get_object_vars( $this );
 
@@ -640,7 +650,7 @@ public function to_array() {
 			}
 
 			if ( is_object( $value ) ) {
-				$value = $value->to_array();
+				$value = $value->to_array( false );
 			}
 
 			// if value is still empty, ignore it for the array and continue.
@@ -649,11 +659,9 @@ public function to_array() {
 			}
 		}
 
-		// replace 'context' key with '@context' and move it to the top.
-		if ( array_key_exists( 'context', $array ) ) {
-			$context = $array['context'];
-			unset( $array['context'] );
-			$array = array_merge( array( '@context' => $context ), $array );
+		if ( $include_json_ld_context ) {
+			// Get JsonLD context and move it to '@context' at the top.
+			$array = array_merge( array( '@context' => $this->get_json_ld_context() ), $array );
 		}
 
 		$class = new ReflectionClass( $this );
@@ -692,4 +700,13 @@ public function to_json() {
 	public function get_object_var_keys() {
 		return \array_keys( \get_object_vars( $this ) );
 	}
+
+	/**
+	 * Returns the JSON-LD context of this object.
+	 *
+	 * @return array $context A compacted JSON-LD context for the ActivityPub object.
+	 */
+	public function get_json_ld_context() {
+		return $this::JSON_LD_CONTEXT;
+	}
 }

includes/activity/objects/README.md

@@ -0,0 +1,3 @@
+This folder contains more complex ActivityPub objects.
+
+Although they could be created using the Base_Object, they provide an easier structure for creating objects with maximum compatibility.