2018-09-05 22:03:57 +02:00
|
|
|
<?php
|
2019-02-24 12:07:41 +01:00
|
|
|
namespace Activitypub\Rest;
|
|
|
|
|
2023-05-19 12:00:11 +02:00
|
|
|
use stdClass;
|
|
|
|
use WP_Error;
|
|
|
|
use WP_REST_Server;
|
|
|
|
use WP_REST_Response;
|
2023-11-20 18:15:54 +01:00
|
|
|
use Activitypub\Transformers_Manager;
|
2023-07-03 19:25:49 +02:00
|
|
|
use Activitypub\Activity\Activity;
|
2023-07-03 19:52:54 +02:00
|
|
|
use Activitypub\Collection\Users as User_Collection;
|
2023-05-19 12:00:11 +02:00
|
|
|
|
2023-05-19 18:03:05 +02:00
|
|
|
use function Activitypub\get_context;
|
2023-05-12 22:31:53 +02:00
|
|
|
use function Activitypub\get_rest_url_by_path;
|
|
|
|
|
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
|
|
|
*/
|
2019-02-24 12:07:41 +01:00
|
|
|
class Outbox {
|
|
|
|
/**
|
2019-02-24 13:01:28 +01:00
|
|
|
* Initialize the class, registering WordPress hooks
|
2019-02-24 12:07:41 +01:00
|
|
|
*/
|
|
|
|
public static function init() {
|
2023-10-04 18:15:53 +02:00
|
|
|
self::register_routes();
|
2019-02-24 12:07:41 +01:00
|
|
|
}
|
2018-12-20 11:33:08 +01:00
|
|
|
|
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(
|
2023-05-11 20:25:30 +02:00
|
|
|
ACTIVITYPUB_REST_NAMESPACE,
|
2023-05-26 16:08:08 +02:00
|
|
|
'/users/(?P<user_id>[\w\-\.]+)/outbox',
|
2022-01-27 13:09:11 +01:00
|
|
|
array(
|
2018-09-05 22:03:57 +02:00
|
|
|
array(
|
2023-05-19 12:00:11 +02:00
|
|
|
'methods' => WP_REST_Server::READABLE,
|
2023-04-20 15:22:11 +02:00
|
|
|
'callback' => array( self::class, 'user_outbox_get' ),
|
2020-09-18 16:36:09 +02:00
|
|
|
'args' => self::request_parameters(),
|
|
|
|
'permission_callback' => '__return_true',
|
2018-09-05 22:03:57 +02:00
|
|
|
),
|
|
|
|
)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2018-12-20 11:33:08 +01:00
|
|
|
/**
|
|
|
|
* Renders the user-outbox
|
|
|
|
*
|
|
|
|
* @param WP_REST_Request $request
|
|
|
|
* @return WP_REST_Response
|
|
|
|
*/
|
2021-01-05 21:56:38 +01:00
|
|
|
public static function user_outbox_get( $request ) {
|
2021-01-03 20:40:53 +01:00
|
|
|
$user_id = $request->get_param( 'user_id' );
|
2023-07-03 19:52:54 +02:00
|
|
|
$user = User_Collection::get_by_various( $user_id );
|
2018-09-05 22:03:57 +02:00
|
|
|
|
2023-05-24 16:32:00 +02:00
|
|
|
if ( is_wp_error( $user ) ) {
|
|
|
|
return $user;
|
2018-09-24 20:47:15 +02:00
|
|
|
}
|
|
|
|
|
2023-11-20 18:15:54 +01:00
|
|
|
$post_types = array_keys( \get_option( 'activitypub_transformer_mapping', array( 'post' => 'activitypub/default', 'page' => 'activitypub/default') ) );
|
2023-05-24 16:32:00 +02:00
|
|
|
|
2023-07-07 15:10:22 +02:00
|
|
|
$page = $request->get_param( 'page', 1 );
|
2018-09-24 20:47:15 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Action triggerd prior to the ActivityPub profile being created and sent to the client
|
|
|
|
*/
|
2023-07-25 10:47:59 +02:00
|
|
|
\do_action( 'activitypub_rest_outbox_pre' );
|
2018-09-24 20:47:15 +02:00
|
|
|
|
2023-05-19 12:00:11 +02:00
|
|
|
$json = new stdClass();
|
2018-09-24 20:47:15 +02:00
|
|
|
|
2023-05-19 12:00:11 +02:00
|
|
|
$json->{'@context'} = get_context();
|
2023-07-25 13:47:49 +02:00
|
|
|
$json->id = get_rest_url_by_path( sprintf( 'users/%d/outbox', $user_id ) );
|
2019-09-27 10:12:59 +02:00
|
|
|
$json->generator = 'http://wordpress.org/?v=' . \get_bloginfo_rss( 'version' );
|
2023-07-03 19:52:54 +02:00
|
|
|
$json->actor = $user->get_id();
|
2018-09-27 22:27:49 +02:00
|
|
|
$json->type = 'OrderedCollectionPage';
|
2023-07-03 17:59:42 +02:00
|
|
|
$json->partOf = get_rest_url_by_path( sprintf( 'users/%d/outbox', $user_id ) ); // phpcs:ignore
|
2022-12-05 20:55:13 +01:00
|
|
|
$json->totalItems = 0; // phpcs:ignore
|
2018-09-24 20:47:15 +02:00
|
|
|
|
2022-11-20 01:01:16 +01:00
|
|
|
foreach ( $post_types as $post_type ) {
|
|
|
|
$count_posts = \wp_count_posts( $post_type );
|
|
|
|
$json->totalItems += \intval( $count_posts->publish ); // phpcs:ignore
|
|
|
|
}
|
2018-09-24 20:47:15 +02:00
|
|
|
|
2021-01-09 01:25:49 +01:00
|
|
|
$json->first = \add_query_arg( 'page', 1, $json->partOf ); // phpcs:ignore
|
|
|
|
$json->last = \add_query_arg( 'page', \ceil ( $json->totalItems / 10 ), $json->partOf ); // phpcs:ignore
|
2018-09-24 20:47:15 +02:00
|
|
|
|
2021-01-09 01:25:49 +01:00
|
|
|
if ( $page && ( ( \ceil ( $json->totalItems / 10 ) ) > $page ) ) { // phpcs:ignore
|
|
|
|
$json->next = \add_query_arg( 'page', $page + 1, $json->partOf ); // phpcs:ignore
|
2018-09-24 20:47:15 +02:00
|
|
|
}
|
|
|
|
|
2023-07-07 15:10:22 +02:00
|
|
|
if ( $page && ( $page > 1 ) ) { // phpcs:ignore
|
|
|
|
$json->prev = \add_query_arg( 'page', $page - 1, $json->partOf ); // phpcs:ignore
|
|
|
|
}
|
|
|
|
|
2021-01-09 01:25:49 +01:00
|
|
|
if ( $page ) {
|
2022-01-27 13:09:11 +01:00
|
|
|
$posts = \get_posts(
|
|
|
|
array(
|
|
|
|
'posts_per_page' => 10,
|
2023-07-07 15:10:22 +02:00
|
|
|
'author' => $user_id,
|
|
|
|
'paged' => $page,
|
|
|
|
'post_type' => $post_types,
|
2022-01-27 13:09:11 +01:00
|
|
|
)
|
|
|
|
);
|
2021-01-09 01:25:49 +01:00
|
|
|
|
|
|
|
foreach ( $posts as $post ) {
|
2023-11-20 18:27:29 +01:00
|
|
|
$transformer = \Activitypub\Transformers_Manager::instance()->get_transformer( $post );
|
|
|
|
$transformer->set_wp_post( $wp_post );
|
2023-11-20 18:15:54 +01:00
|
|
|
$post = $transformer->to_object();
|
2023-07-03 17:59:42 +02:00
|
|
|
$activity = new Activity();
|
|
|
|
$activity->set_type( 'Create' );
|
|
|
|
$activity->set_context( null );
|
|
|
|
$activity->set_object( $post );
|
2023-02-20 18:22:17 +01:00
|
|
|
|
2023-07-03 17:59:42 +02:00
|
|
|
$json->orderedItems[] = $activity->to_array(); // phpcs:ignore
|
2021-01-09 01:25:49 +01:00
|
|
|
}
|
2018-09-24 20:47:15 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// filter output
|
2023-08-09 13:07:30 +02:00
|
|
|
$json = \apply_filters( 'activitypub_rest_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
|
|
|
|
2023-10-23 14:57:58 +02:00
|
|
|
$rest_response = new WP_REST_Response( $json, 200 );
|
|
|
|
$rest_response->header( 'Content-Type', 'application/activity+json; charset=' . get_option( 'blog_charset' ) );
|
2018-09-24 20:47:15 +02:00
|
|
|
|
2023-10-23 14:57:58 +02:00
|
|
|
return $rest_response;
|
2018-09-24 20:47:15 +02:00
|
|
|
}
|
|
|
|
|
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',
|
2023-07-07 15:10:22 +02:00
|
|
|
'default' => 1,
|
2018-09-24 20:47:15 +02:00
|
|
|
);
|
|
|
|
|
2021-01-03 20:40:53 +01:00
|
|
|
$params['user_id'] = array(
|
2018-09-24 20:47:15 +02:00
|
|
|
'required' => true,
|
2023-05-24 16:32:00 +02:00
|
|
|
'type' => 'string',
|
2018-09-24 20:47:15 +02:00
|
|
|
);
|
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
|
|
|
}
|
|
|
|
}
|