Add CLI actor delete/update and improve tombstone handling (#2118)

Author: pfefferle

.github/changelog/2118-from-description

@@ -0,0 +1,4 @@
+Significance: minor
+Type: added
+
+Added a new WP-CLI command to manage Actors.

includes/class-cli.php

@@ -10,6 +10,7 @@
 use Activitypub\Activity\Activity;
 use Activitypub\Collection\Actors;
 use Activitypub\Collection\Outbox;
+use Activitypub\Scheduler\Actor;
 
 /**
  * WP-CLI commands.
@@ -395,6 +396,51 @@ public function comment( $args ) {
 		}
 	}
 
+	/**
+	 * Delete or Update an Actor.
+	 *
+	 * ## OPTIONS
+	 *
+	 * <action>
+	 * : The action to perform. Either `delete` or `update`.
+	 * ---
+	 * options:
+	 *   - delete
+	 *   - update
+	 * ---
+	 *
+	 * <id>
+	 * : The id of the Actor.
+	 *
+	 * ## EXAMPLES
+	 *
+	 *     $ wp activitypub actor delete 1
+	 *
+	 * @synopsis <action> <id>
+	 *
+	 * @param array $args The arguments.
+	 */
+	public function actor( $args ) {
+		if ( Actors::APPLICATION_USER_ID === (int) $args[1] ) {
+			\WP_CLI::error( 'You cannot delete the application actor.' );
+		}
+
+		switch ( $args[0] ) {
+			case 'delete':
+				\add_filter( 'activitypub_user_can_activitypub', '__return_true' );
+				Actor::schedule_user_delete( $args[1] );
+				\remove_filter( 'activitypub_user_can_activitypub', '__return_true' );
+				\WP_CLI::success( '"Delete" activity is queued.' );
+				break;
+			case 'update':
+				Actor::schedule_profile_update( $args[1] );
+				\WP_CLI::success( '"Update" activity is queued.' );
+				break;
+			default:
+				\WP_CLI::error( 'Unknown action.' );
+		}
+	}
+
 	/**
 	 * Undo an activity that was sent to the Fediverse.
 	 *

includes/functions.php

@@ -342,6 +342,7 @@ function is_post_disabled( $post ) {
  * This function checks if a user is enabled for ActivityPub.
  *
  * @param int|string $user_id The user ID.
+ *
  * @return boolean True if the user is enabled, false otherwise.
  */
 function user_can_activitypub( $user_id ) {

includes/handler/class-delete.php

@@ -24,7 +24,9 @@ public static function init() {
 		\add_action( 'activitypub_inbox_delete', array( self::class, 'handle_delete' ) );
 		\add_filter( 'activitypub_defer_signature_verification', array( self::class, 'defer_signature_verification' ), 10, 2 );
 		\add_action( 'activitypub_delete_actor_interactions', array( self::class, 'delete_interactions' ) );
+
 		\add_filter( 'activitypub_get_outbox_activity', array( self::class, 'outbox_activity' ) );
+		\add_action( 'post_activitypub_add_to_outbox', array( self::class, 'post_add_to_outbox' ), 10, 2 );
 	}
 
 	/**
@@ -182,6 +184,7 @@ public static function defer_signature_verification( $defer, $request ) {
 	 * Set the object to the object ID.
 	 *
 	 * @param \Activitypub\Activity\Activity $activity The Activity object.
+	 *
 	 * @return \Activitypub\Activity\Activity The filtered Activity object.
 	 */
 	public static function outbox_activity( $activity ) {
@@ -191,4 +194,17 @@ public static function outbox_activity( $activity ) {
 
 		return $activity;
 	}
+
+	/**
+	 * Add the activity to the outbox.
+	 *
+	 * @param int                            $outbox_id The ID of the outbox activity.
+	 * @param \Activitypub\Activity\Activity $activity  The Activity object.
+	 */
+	public static function post_add_to_outbox( $outbox_id, $activity ) {
+		// Set Tombstones for deleted objects.
+		if ( 'Delete' === $activity->get_type() ) {
+			Tombstone::bury( object_to_uri( $activity->get_object() ) );
+		}
+	}
 }

includes/scheduler/class-actor.php

@@ -186,9 +186,6 @@ public static function schedule_user_delete( $user_id ) {
 			return;
 		}
 
-		Tombstone::bury( $actor->get_id() );
-		Tombstone::bury( $actor->get_url() );
-
 		$activity = new Activity();
 		$activity->set_actor( $actor->get_id() );
 		$activity->set_object( $actor->get_id() );

tests/includes/class-test-tombstone.php

@@ -144,6 +144,25 @@ public function test_check_object() {
 		$this->assertFalse( $response );
 	}
 
+	/**
+	 * Response code is 404 -> is_tombstone returns true
+	 *
+	 * @covers ::bury
+	 */
+	public function test_bury() {
+		$url = 'https://fake.test/object/123';
+
+		$response = Tombstone::exists_local( $url );
+		$this->assertFalse( $response );
+
+		Tombstone::bury( $url );
+
+		$response = Tombstone::exists_local( $url );
+		$this->assertTrue( $response );
+
+		\delete_option( 'activitypub_tombstone_urls' );
+	}
+
 	/**
 	 * Response code is 404 -> is_tombstone returns true
 	 *