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

159 lines
3.4 KiB
PHP
Raw Normal View History

2018-12-08 00:02:18 +01:00
<?php
namespace Activitypub\Rest;
2018-12-08 00:02:18 +01:00
2023-04-20 15:22:11 +02:00
use WP_Error;
use WP_REST_Response;
2023-07-03 20:02:00 +02:00
use Activitypub\Collection\Users as User_Collection;
2023-04-20 15:22:11 +02:00
2019-02-24 13:01:28 +01:00
/**
* ActivityPub WebFinger REST-Class
*
* @author Matthias Pfefferle
*
* @see https://webfinger.net/
*/
class Webfinger {
2019-02-24 13:01:28 +01:00
/**
2023-07-11 14:26:07 +02:00
* Initialize the class, registering WordPress hooks.
*
* @return void
2019-02-24 13:01:28 +01:00
*/
public static function init() {
2023-04-20 15:22:11 +02:00
\add_action( 'rest_api_init', array( self::class, 'register_routes' ) );
2023-07-05 15:32:49 +02:00
\add_filter( 'webfinger_user_data', array( self::class, 'add_user_discovery' ), 10, 3 );
\add_filter( 'webfinger_data', array( self::class, 'add_pseudo_user_discovery' ), 99, 2 );
}
2019-02-28 19:31:55 +01:00
/**
2023-07-11 14:26:07 +02:00
* Register routes.
*
* @return void
*/
public static function register_routes() {
2019-09-27 10:12:59 +02:00
\register_rest_route(
ACTIVITYPUB_REST_NAMESPACE,
2022-01-27 13:09:11 +01:00
'/webfinger',
array(
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, 'webfinger' ),
2020-09-18 16:36:09 +02:00
'args' => self::request_parameters(),
'permission_callback' => '__return_true',
),
)
);
}
/**
2023-07-11 14:26:07 +02:00
* WebFinger endpoint.
*
* @param WP_REST_Request $request The request object.
*
2023-07-11 14:26:07 +02:00
* @return WP_REST_Response The response object.
*/
public static function webfinger( $request ) {
2023-07-25 10:47:59 +02:00
/*
* Action triggerd prior to the ActivityPub profile being created and sent to the client
*/
\do_action( 'activitypub_rest_webfinger_pre' );
$resource = $request->get_param( 'resource' );
2023-07-05 15:32:49 +02:00
$response = self::get_profile( $resource );
2023-07-05 15:32:49 +02:00
return new WP_REST_Response( $response, 200 );
}
/**
* The supported parameters
*
* @return array list of parameters
*/
public static function request_parameters() {
$params = array();
$params['resource'] = array(
'required' => true,
'type' => 'string',
'pattern' => '^acct:(.+)@(.+)$',
);
return $params;
}
2018-12-08 00:02:18 +01:00
/**
* Add WebFinger discovery links
*
* @param array $array the jrd array
* @param string $resource the WebFinger resource
* @param WP_User $user the WordPress user
2023-07-11 14:26:07 +02:00
*
* @return array the jrd array
2018-12-08 00:02:18 +01:00
*/
2023-07-05 15:32:49 +02:00
public static function add_user_discovery( $array, $resource, $user ) {
2023-07-11 14:26:07 +02:00
$user = User_Collection::get_by_id( $user->ID );
2018-12-08 00:02:18 +01:00
$array['links'][] = array(
'rel' => 'self',
'type' => 'application/activity+json',
2023-07-11 14:26:07 +02:00
'href' => $user->get_url(),
2018-12-08 00:02:18 +01:00
);
return $array;
}
2023-07-05 15:32:49 +02:00
/**
* Add WebFinger discovery links
*
* @param array $array the jrd array
* @param string $resource the WebFinger resource
* @param WP_User $user the WordPress user
2023-07-11 14:26:07 +02:00
*
* @return array the jrd array
2023-07-05 15:32:49 +02:00
*/
public static function add_pseudo_user_discovery( $array, $resource ) {
2023-07-11 14:26:07 +02:00
if ( $array ) {
return $array;
2023-07-05 15:32:49 +02:00
}
2023-07-11 14:26:07 +02:00
return self::get_profile( $resource );
2023-07-05 15:32:49 +02:00
}
2023-07-11 14:26:07 +02:00
/**
* Get the WebFinger profile.
*
* @param string $resource the WebFinger resource.
*
* @return array the WebFinger profile.
*/
2023-07-05 15:32:49 +02:00
public static function get_profile( $resource ) {
$user = User_Collection::get_by_resource( $resource );
if ( is_wp_error( $user ) ) {
return $user;
}
$aliases = array(
$user->get_url(),
);
$profile = array(
'subject' => $resource,
'aliases' => array_values( array_unique( $aliases ) ),
'links' => array(
array(
'rel' => 'self',
'type' => 'application/activity+json',
'href' => $user->get_url(),
),
array(
'rel' => 'http://webfinger.net/rel/profile-page',
'type' => 'text/html',
'href' => $user->get_url(),
),
),
);
return $profile;
}
2018-12-08 00:02:18 +01:00
}