wordpress-event-bridge-for-activitypub/includes/activitypub/collection/class-event-sources.php

<?php
/**
 * Event sources collection file.
 *
 * @package Event_Bridge_For_ActivityPub
 * @license AGPL-3.0-or-later
 */

namespace Event_Bridge_For_ActivityPub\ActivityPub\Collection;

use WP_Error;
use WP_Query;
use Event_Bridge_For_ActivityPub\ActivityPub\Model\Event_Source;

use function Activitypub\is_tombstone;
use function Activitypub\get_remote_metadata_by_actor;

/**
 * ActivityPub Event Sources (=Followed Actors) Collection.
 */
class Event_Sources {
	/**
	 * The custom post type.
	 */
	const POST_TYPE = 'ebap_event_source';

	/**
	 * Register the post type used to store the external event sources (i.e., followed ActivityPub actors).
	 */
	public static function register_post_type() {
		register_post_type(
			self::POST_TYPE,
			array(
				'labels'           => array(
					'name'          => _x( 'Event Sources', 'post_type plural name', 'event-bridge-for-activitypub' ),
					'singular_name' => _x( 'Event Source', 'post_type single name', 'event-bridge-for-activitypub' ),
				),
				'public'           => false,
				'hierarchical'     => false,
				'rewrite'          => false,
				'query_var'        => false,
				'delete_with_user' => false,
				'can_export'       => true,
				'supports'         => array(),
			)
		);

		\register_post_meta(
			self::POST_TYPE,
			'activitypub_actor_id',
			array(
				'type'              => 'string',
				'single'            => true,
				'sanitize_callback' => 'sanitize_url',
			)
		);

		\register_post_meta(
			self::POST_TYPE,
			'activitypub_errors',
			array(
				'type'              => 'string',
				'single'            => false,
				'sanitize_callback' => function ( $value ) {
					if ( ! is_string( $value ) ) {
						throw new \Exception( 'Error message is no valid string' );
					}

					return esc_sql( $value );
				},
			)
		);

		\register_post_meta(
			self::POST_TYPE,
			'activitypub_actor_json',
			array(
				'type'              => 'string',
				'single'            => true,
				'sanitize_callback' => function ( $value ) {
					return sanitize_text_field( $value );
				},
			)
		);

		\register_post_meta(
			self::POST_TYPE,
			'event_source_active',
			array(
				'type'              => 'bool',
				'single'            => true,
			)
		);

		\register_post_meta(
			self::POST_TYPE,
			'event_source_utilize_announces',
			array(
				'type'              => 'string',
				'single'            => true,
				'sanitize_callback' => function ( $value ) {
					if ( 'same_origin' === $value ) {
						return 'same_origin';
					}
					return '';
				},
			)
		);
	}

	/**
	 * Add new Event Source.
	 *
	 * @param string $actor The Actor URL/ID.
	 *
	 * @return Event_Source|WP_Error The Followed (WP_Post array) or an WP_Error.
	 */
	public static function add_event_source( $actor ) {
		$meta = get_remote_metadata_by_actor( $actor );

		if ( is_tombstone( $meta ) ) {
			return $meta;
		}

		if ( empty( $meta ) || ! is_array( $meta ) || is_wp_error( $meta ) ) {
			return new WP_Error( 'activitypub_invalid_actor', __( 'Invalid ActivityPub Actor', 'event-bridge-for-activitypub' ), array( 'status' => 400 ) );
		}

		$event_source = new Event_Source();
		$event_source->from_array( $meta );

		$post_id = $event_source->save();

		if ( is_wp_error( $post_id ) ) {
			return $post_id;
		}

		return $event_source;
	}

	/**
	 * Remove an Event Source (=Followed ActivityPub actor).
	 *
	 * @param string $actor  The Actor URL.
	 *
	 * @return bool True on success, false on failure.
	 */
	public static function remove_event_source( $actor ) {
		$actor = true;
		return $actor;
	}

	/**
	 * Get all Event-Sources.
	 *
	 * @return array The Term list of Event Sources.
	 */
	public static function get_event_sources() {
		$args = array(
			'post_type'      => self::POST_TYPE,
			'posts_per_page' => -1,
			'orderby'        => 'ID',
			'order'          => 'DESC',
			// phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
			'meta_query'     => array(
				array(
					'key'     => 'activitypub_actor_id',
					'compare' => 'EXISTS',
				),
			),
		);

		$query = new WP_Query( $args );

		$event_sources = array_map(
			function ( $post ) {
				return Event_Source::init_from_cpt( $post );
			},
			$query->get_posts()
		);

		return $event_sources;
	}

	/**
	 * Get the Event Sources along with a total count for pagination purposes.
	 *
	 * @param int   $number  Maximum number of results to return.
	 * @param int   $page    Page number.
	 * @param array $args    The WP_Query arguments.
	 *
	 * @return array {
	 *      Data about the followers.
	 *
	 *      @type array $followers List of `Follower` objects.
	 *      @type int   $total     Total number of followers.
	 *  }
	 */
	public static function get_event_sources_with_count( $number = -1, $page = null, $args = array() ) {
		$defaults = array(
			'post_type'      => self::POST_TYPE,
			'posts_per_page' => $number,
			'paged'          => $page,
			'orderby'        => 'ID',
			'order'          => 'DESC',
		);

		$args   = wp_parse_args( $args, $defaults );
		$query  = new WP_Query( $args );
		$total  = $query->found_posts;
		$actors = array_map(
			function ( $post ) {
				return Event_Source::init_from_cpt( $post );
			},
			$query->get_posts()
		);

		return compact( 'actors', 'total' );
	}

	/**
	 * Remove a Follower.
	 *
	 * @param string $event_source   The Actor URL.
	 *
	 * @return mixed True on success, false on failure.
	 */
	public static function remove( $event_source ) {
		$post_id = Event_Source::get_wp_post_from_activitypub_actor_id( $event_source );
		return wp_delete_post( $post_id, true );
	}
}