wordpress-activitypub/includes/rest/class-outbox.php

128 lines
3.4 KiB
PHP
Raw Normal View History

2018-09-05 22:03:57 +02:00
<?php
namespace Activitypub\Rest;
2018-09-05 22:03:57 +02:00
/**
2019-02-24 13:01:28 +01:00
* ActivityPub Outbox REST-Class
2018-09-05 22:03:57 +02:00
*
* @author Matthias Pfefferle
2019-02-24 13:01:28 +01:00
*
* @see https://www.w3.org/TR/activitypub/#outbox
2018-09-05 22:03:57 +02:00
*/
class Outbox {
/**
2019-02-24 13:01:28 +01:00
* Initialize the class, registering WordPress hooks
*/
public static function init() {
2019-09-27 10:12:59 +02:00
\add_action( 'rest_api_init', array( '\Activitypub\Rest\Outbox', 'register_routes' ) );
}
2018-09-05 22:03:57 +02:00
/**
2018-09-24 20:47:15 +02:00
* Register routes
2018-09-05 22:03:57 +02:00
*/
public static function register_routes() {
2019-09-27 10:12:59 +02:00
\register_rest_route(
2021-01-03 20:40:53 +01:00
'activitypub/1.0', '/users/(?P<user_id>\d+)/outbox', array(
2018-09-05 22:03:57 +02:00
array(
2020-09-18 16:36:09 +02:00
'methods' => \WP_REST_Server::READABLE,
'callback' => array( '\Activitypub\Rest\Outbox', 'user_outbox' ),
'args' => self::request_parameters(),
'permission_callback' => '__return_true',
2018-09-05 22:03:57 +02:00
),
)
);
}
/**
* Renders the user-outbox
*
* @param WP_REST_Request $request
* @return WP_REST_Response
*/
public static function user_outbox( $request ) {
2021-01-03 20:40:53 +01:00
$user_id = $request->get_param( 'user_id' );
2019-09-27 10:12:59 +02:00
$author = \get_user_by( 'ID', $user_id );
2018-09-05 22:03:57 +02:00
2018-09-24 20:47:15 +02:00
if ( ! $author ) {
2020-05-12 20:30:06 +02:00
return new \WP_Error( 'rest_invalid_param', \__( 'User not found', 'activitypub' ), array(
'status' => 404,
'params' => array(
2019-09-27 10:12:59 +02:00
'user_id' => \__( 'User not found', 'activitypub' ),
),
2018-09-24 20:47:15 +02:00
) );
}
2018-09-30 22:51:22 +02:00
$page = $request->get_param( 'page', 0 );
2018-09-24 20:47:15 +02:00
/*
* Action triggerd prior to the ActivityPub profile being created and sent to the client
*/
2019-09-27 10:12:59 +02:00
\do_action( 'activitypub_outbox_pre' );
2018-09-24 20:47:15 +02:00
$json = new \stdClass();
2018-09-24 20:47:15 +02:00
$json->{'@context'} = \Activitypub\get_context();
2019-09-27 10:12:59 +02:00
$json->id = \home_url( \add_query_arg( null, null ) );
$json->generator = 'http://wordpress.org/?v=' . \get_bloginfo_rss( 'version' );
$json->actor = \get_author_posts_url( $user_id );
2018-09-27 22:27:49 +02:00
$json->type = 'OrderedCollectionPage';
2019-09-27 10:12:59 +02:00
$json->partOf = \get_rest_url( null, "/activitypub/1.0/users/$user_id/outbox" ); // phpcs:ignore
2018-09-24 20:47:15 +02:00
2019-09-27 10:12:59 +02:00
$count_posts = \wp_count_posts();
$json->totalItems = \intval( $count_posts->publish ); // phpcs:ignore
2018-09-24 20:47:15 +02:00
2019-09-27 10:12:59 +02:00
$posts = \get_posts( array(
2018-09-30 22:51:22 +02:00
'posts_per_page' => 10,
'author' => $user_id,
2018-09-30 22:51:22 +02:00
'offset' => $page * 10,
2018-09-24 20:47:15 +02:00
) );
2019-09-27 10:12:59 +02:00
$json->first = \add_query_arg( 'page', 0, $json->partOf ); // phpcs:ignore
$json->last = \add_query_arg( 'page', ( \ceil ( $json->totalItems / 10 ) ) - 1, $json->partOf ); // phpcs:ignore
2018-09-24 23:45:11 +02:00
if ( ( \ceil ( $json->totalItems / 10 ) ) - 1 > $page ) { // phpcs:ignore
2019-09-27 10:12:59 +02:00
$json->next = \add_query_arg( 'page', ++$page, $json->partOf ); // phpcs:ignore
2018-09-24 20:47:15 +02:00
}
foreach ( $posts as $post ) {
2019-11-18 20:57:00 +01:00
$activitypub_post = new \Activitypub\Model\Post( $post );
$activitypub_activity = new \Activitypub\Model\Activity( 'Create', \Activitypub\Model\Activity::TYPE_NONE );
$activitypub_activity->from_post( $activitypub_post->to_array() );
$json->orderedItems[] = $activitypub_activity->to_array(); // phpcs:ignore
2018-09-24 20:47:15 +02:00
}
// filter output
2019-09-27 10:12:59 +02:00
$json = \apply_filters( 'activitypub_outbox_array', $json );
2018-09-24 20:47:15 +02:00
/*
* Action triggerd after the ActivityPub profile has been created and sent to the client
*/
2019-09-27 10:12:59 +02:00
\do_action( 'activitypub_outbox_post' );
2018-09-24 20:47:15 +02:00
$response = new \WP_REST_Response( $json, 200 );
2018-09-24 20:47:15 +02:00
2018-09-27 22:27:49 +02:00
$response->header( 'Content-Type', 'application/activity+json' );
2018-09-24 20:47:15 +02:00
return $response;
}
2019-02-28 19:31:55 +01:00
/**
* The supported parameters
*
* @return array list of parameters
*/
2018-09-24 20:47:15 +02:00
public static function request_parameters() {
$params = array();
$params['page'] = array(
'type' => 'integer',
);
2021-01-03 20:40:53 +01:00
$params['user_id'] = array(
2018-09-24 20:47:15 +02:00
'required' => true,
'type' => 'integer',
);
2018-09-05 22:03:57 +02:00
2018-09-24 20:47:15 +02:00
return $params;
2018-09-05 22:03:57 +02:00
}
}