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

150 lines
3.8 KiB
PHP
Raw Permalink Normal View History

2018-12-08 00:02:18 +01:00
<?php
namespace Activitypub\Rest;
2023-04-21 15:57:41 +02:00
use WP_Error;
use stdClass;
use WP_REST_Server;
use WP_REST_Response;
2023-07-03 19:56:06 +02:00
use Activitypub\Collection\Users as User_Collection;
use Activitypub\Collection\Followers as Follower_Collection;
2023-05-17 09:02:37 +02:00
2023-05-12 22:31:53 +02:00
use function Activitypub\get_rest_url_by_path;
2023-04-21 15:57:41 +02:00
2019-02-24 13:01:28 +01:00
/**
* ActivityPub Followers REST-Class
*
* @author Matthias Pfefferle
*
* @see https://www.w3.org/TR/activitypub/#followers
*/
class Followers {
2019-02-24 13:01:28 +01:00
/**
* Initialize the class, registering WordPress hooks
*/
public static function init() {
self::register_routes();
}
2018-12-08 00:02:18 +01:00
/**
* Register routes
*/
public static function register_routes() {
2019-09-27 10:12:59 +02:00
\register_rest_route(
ACTIVITYPUB_REST_NAMESPACE,
2023-05-26 16:08:08 +02:00
'/users/(?P<user_id>[\w\-\.]+)/followers',
2022-01-27 13:09:11 +01:00
array(
2018-12-08 00:02:18 +01:00
array(
2023-04-21 15:57:41 +02:00
'methods' => WP_REST_Server::READABLE,
2023-04-20 15:22:11 +02:00
'callback' => array( self::class, 'get' ),
2020-09-18 16:36:09 +02:00
'args' => self::request_parameters(),
'permission_callback' => '__return_true',
2018-12-08 00:02:18 +01:00
),
)
);
}
2019-02-28 19:31:55 +01:00
/**
* Handle GET request
*
* @param WP_REST_Request $request
*
* @return WP_REST_Response
*/
2018-12-08 00:02:18 +01:00
public static function get( $request ) {
2021-01-03 20:40:53 +01:00
$user_id = $request->get_param( 'user_id' );
2023-07-03 19:56:06 +02:00
$user = User_Collection::get_by_various( $user_id );
2018-12-08 00:02:18 +01:00
if ( is_wp_error( $user ) ) {
return $user;
2018-12-08 00:02:18 +01:00
}
$order = $request->get_param( 'order' );
$per_page = (int) $request->get_param( 'per_page' );
$page = (int) $request->get_param( 'page' );
$context = $request->get_param( 'context' );
2023-07-07 15:02:34 +02:00
2018-12-08 00:02:18 +01: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_followers_pre' );
2018-12-08 00:02:18 +01:00
$data = Follower_Collection::get_followers_with_count( $user_id, $per_page, $page, array( 'order' => ucwords( $order ) ) );
2023-04-21 15:57:41 +02:00
$json = new stdClass();
2018-12-08 00:02:18 +01:00
2019-02-24 12:21:25 +01:00
$json->{'@context'} = \Activitypub\get_context();
2018-12-08 00:02:18 +01:00
2023-07-25 13:47:49 +02:00
$json->id = get_rest_url_by_path( sprintf( 'users/%d/followers', $user->get__id() ) );
$json->generator = 'http://wordpress.org/?v=' . \get_bloginfo_rss( 'version' );
$json->actor = $user->get_id();
$json->type = 'OrderedCollectionPage';
$json->totalItems = $data['total']; // phpcs:ignore
2023-07-07 15:02:34 +02:00
$json->partOf = get_rest_url_by_path( sprintf( 'users/%d/followers', $user->get__id() ) ); // phpcs:ignore
$json->first = \add_query_arg( 'page', 1, $json->partOf ); // phpcs:ignore
$json->last = \add_query_arg( 'page', \ceil ( $json->totalItems / $per_page ), $json->partOf ); // phpcs:ignore
2023-07-07 15:02:34 +02:00
if ( $page && ( ( \ceil ( $json->totalItems / $per_page ) ) > $page ) ) { // phpcs:ignore
2023-07-07 15:02:34 +02:00
$json->next = \add_query_arg( 'page', $page + 1, $json->partOf ); // phpcs:ignore
}
2023-07-07 15:09:22 +02:00
if ( $page && ( $page > 1 ) ) { // phpcs:ignore
$json->prev = \add_query_arg( 'page', $page - 1, $json->partOf ); // phpcs:ignore
}
2023-05-11 09:46:26 +02:00
// phpcs:ignore
$json->orderedItems = array_map(
function ( $item ) use ( $context ) {
if ( 'full' === $context ) {
return $item->to_array();
}
return $item->get_url();
2023-05-11 09:46:26 +02:00
},
$data['followers']
2023-05-11 09:46:26 +02:00
);
2019-03-09 01:23:10 +01:00
$rest_response = new WP_REST_Response( $json, 200 );
$rest_response->header( 'Content-Type', 'application/activity+json; charset=' . get_option( 'blog_charset' ) );
2018-12-08 00:02:18 +01:00
return $rest_response;
2018-12-08 00:02:18 +01:00
}
/**
* The supported parameters
*
* @return array list of parameters
*/
public static function request_parameters() {
$params = array();
$params['page'] = array(
'type' => 'integer',
2023-07-07 15:02:34 +02:00
'default' => 1,
2018-12-08 00:02:18 +01:00
);
$params['per_page'] = array(
'type' => 'integer',
'default' => 20,
);
$params['order'] = array(
'type' => 'string',
'default' => 'desc',
'enum' => array( 'asc', 'desc' ),
);
2021-01-03 20:40:53 +01:00
$params['user_id'] = array(
2018-12-08 00:02:18 +01:00
'required' => true,
'type' => 'string',
2018-12-08 00:02:18 +01:00
);
$params['context'] = array(
'type' => 'string',
'default' => 'simple',
'enum' => array( 'simple', 'full' ),
);
2018-12-08 00:02:18 +01:00
return $params;
}
}