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

130 lines
3.1 KiB
PHP
Raw Permalink Normal View History

2019-03-12 22:20:04 +01:00
<?php
namespace Activitypub\Rest;
2023-07-03 19:56:06 +02:00
use Activitypub\Collection\Users as User_Collection;
use function Activitypub\is_single_user;
2023-05-12 22:31:53 +02:00
use function Activitypub\get_rest_url_by_path;
2019-03-12 22:20:04 +01:00
/**
* ActivityPub Following REST-Class
*
* @author Matthias Pfefferle
*
* @see https://www.w3.org/TR/activitypub/#following
*/
class Following {
/**
* Initialize the class, registering WordPress hooks
*/
public static function init() {
2023-04-20 15:22:11 +02:00
\add_action( 'rest_api_init', array( self::class, 'register_routes' ) );
\add_filter( 'activitypub_rest_following', array( self::class, 'default_following' ), 10, 2 );
2019-03-12 22:20:04 +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\-\.]+)/following',
2022-01-27 13:09:11 +01:00
array(
2019-03-12 22:20:04 +01:00
array(
2020-09-18 16:36:09 +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',
2019-03-12 22:20:04 +01:00
),
)
);
}
/**
* Handle GET request
*
* @param WP_REST_Request $request
*
* @return WP_REST_Response
*/
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 );
2019-03-12 22:20:04 +01:00
if ( is_wp_error( $user ) ) {
return $user;
2019-03-12 22:20:04 +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_following_pre' );
2019-03-12 22:20:04 +01:00
$json = new \stdClass();
$json->{'@context'} = \Activitypub\get_context();
2023-07-25 13:47:49 +02:00
$json->id = get_rest_url_by_path( sprintf( 'users/%d/following', $user->get__id() ) );
$json->generator = 'http://wordpress.org/?v=' . \get_bloginfo_rss( 'version' );
$json->actor = $user->get_id();
$json->type = 'OrderedCollectionPage';
2023-06-28 14:22:27 +02:00
$json->partOf = get_rest_url_by_path( sprintf( 'users/%d/following', $user->get__id() ) ); // phpcs:ignore
$items = apply_filters( 'activitypub_rest_following', array(), $user ); // phpcs:ignore
$json->totalItems = count( $items ); // phpcs:ignore
$json->orderedItems = $items; // phpcs:ignore
2019-03-12 22:20:04 +01:00
$json->first = $json->partOf; // phpcs:ignore
$response = new \WP_REST_Response( $json, 200 );
$response->header( 'Content-Type', 'application/activity+json' );
return $response;
}
/**
* The supported parameters
*
* @return array list of parameters
*/
public static function request_parameters() {
$params = array();
$params['page'] = array(
'type' => 'integer',
);
2021-01-03 20:40:53 +01:00
$params['user_id'] = array(
2019-03-12 22:20:04 +01:00
'required' => true,
'type' => 'string',
2019-03-12 22:20:04 +01:00
);
return $params;
}
/**
* Add the Blog Authors to the following list of the Blog Actor
* if Blog not in single mode.
*
* @param array $array The array of following urls.
* @param User $user The user object.
*
* @return array The array of following urls.
*/
public static function default_following( $array, $user ) {
if ( 0 !== $user->get__id() || is_single_user() ) {
return $array;
}
$users = User_Collection::get_collection();
foreach ( $users as $user ) {
$array[] = $user->get_url();
}
return $array;
}
2019-03-12 22:20:04 +01:00
}