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

589 lines
15 KiB
PHP
Raw Normal View History

2018-09-27 22:28:49 +02:00
<?php
namespace Activitypub\Rest;
2023-05-19 12:00:11 +02:00
use WP_Error;
use WP_REST_Server;
2023-04-21 08:51:38 +02:00
use WP_REST_Response;
2023-07-03 17:59:42 +02:00
use Activitypub\Activity\Activity;
2023-07-03 19:56:06 +02:00
use Activitypub\Collection\Users as User_Collection;
2023-04-20 15:22:11 +02:00
2023-05-19 12:00:11 +02:00
use function Activitypub\get_context;
use function Activitypub\url_to_authorid;
2023-05-12 22:31:53 +02:00
use function Activitypub\get_rest_url_by_path;
2023-05-19 12:00:11 +02:00
use function Activitypub\get_remote_metadata_by_actor;
2023-04-20 15:22:11 +02:00
2018-09-27 22:28:49 +02:00
/**
2019-02-24 13:01:28 +01:00
* ActivityPub Inbox REST-Class
2018-09-27 22:28:49 +02:00
*
* @author Matthias Pfefferle
2019-02-24 13:01:28 +01:00
*
* @see https://www.w3.org/TR/activitypub/#inbox
2018-09-27 22:28:49 +02:00
*/
class Inbox {
2019-02-24 13:01:28 +01:00
/**
* 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' ) );
2023-04-24 20:46:51 +02:00
2023-04-20 15:22:11 +02:00
\add_action( 'activitypub_inbox_create', array( self::class, 'handle_create' ), 10, 2 );
}
2019-02-28 19:31:55 +01:00
2018-09-27 22:28:49 +02:00
/**
* Register routes
*/
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
'/inbox',
array(
2018-09-27 22:28:49 +02:00
array(
2023-05-19 12:00:11 +02:00
'methods' => WP_REST_Server::EDITABLE,
2023-04-20 15:22:11 +02:00
'callback' => array( self::class, 'shared_inbox_post' ),
'args' => self::shared_inbox_post_parameters(),
2020-09-18 16:36:09 +02:00
'permission_callback' => '__return_true',
2018-09-27 22:28:49 +02:00
),
)
);
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\-\.]+)/inbox',
2022-01-27 13:09:11 +01:00
array(
2018-09-27 22:28:49 +02:00
array(
2023-05-19 12:00:11 +02:00
'methods' => WP_REST_Server::EDITABLE,
2023-04-20 15:22:11 +02:00
'callback' => array( self::class, 'user_inbox_post' ),
'args' => self::user_inbox_post_parameters(),
2020-09-18 16:36:09 +02:00
'permission_callback' => '__return_true',
2018-09-27 22:28:49 +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_inbox_get' ),
'args' => self::user_inbox_get_parameters(),
'permission_callback' => '__return_true',
),
2018-09-27 22:28:49 +02:00
)
);
}
/**
* Renders the user-inbox
*
* @param WP_REST_Request $request
* @return WP_REST_Response
*/
public static function user_inbox_get( $request ) {
$user_id = $request->get_param( 'user_id' );
2023-07-03 19:56:06 +02:00
$user = User_Collection::get_by_various( $user_id );
if ( is_wp_error( $user ) ) {
return $user;
}
$page = $request->get_param( 'page', 0 );
/*
* 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_inbox_pre' );
$json = new \stdClass();
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/inbox', $user->get__id() ) );
$json->generator = 'http://wordpress.org/?v=' . \get_bloginfo_rss( 'version' );
$json->type = 'OrderedCollectionPage';
2023-06-28 14:22:27 +02:00
$json->partOf = get_rest_url_by_path( sprintf( 'users/%d/inbox', $user->get__id() ) ); // phpcs:ignore
$json->totalItems = 0; // phpcs:ignore
$json->orderedItems = array(); // phpcs:ignore
$json->first = $json->partOf; // phpcs:ignore
// filter output
$json = \apply_filters( 'activitypub_rest_inbox_array', $json );
/*
* Action triggerd after the ActivityPub profile has been created and sent to the client
*/
\do_action( 'activitypub_inbox_post' );
2023-04-21 08:51:38 +02:00
$response = new WP_REST_Response( $json, 200 );
$response->header( 'Content-Type', 'application/activity+json' );
return $response;
}
/**
* Handles user-inbox requests
*
* @param WP_REST_Request $request
2019-02-28 19:31:55 +01:00
*
* @return WP_REST_Response
*/
public static function user_inbox_post( $request ) {
$user_id = $request->get_param( 'user_id' );
2023-07-05 15:33:07 +02:00
$user = User_Collection::get_by_various( $user_id );
if ( is_wp_error( $user ) ) {
return $user;
}
2019-11-27 08:25:04 +01:00
2023-09-05 21:03:25 +02:00
$data = $request->get_json_params();
$type = $request->get_param( 'type' );
2021-11-17 21:11:34 +01:00
$type = \strtolower( $type );
2018-10-02 22:16:47 +02:00
2023-06-28 14:22:27 +02:00
\do_action( 'activitypub_inbox', $data, $user->get__id(), $type );
\do_action( "activitypub_inbox_{$type}", $data, $user->get__id() );
2023-04-21 08:51:38 +02:00
return new WP_REST_Response( array(), 202 );
2018-09-27 22:28:49 +02:00
}
2018-09-30 22:51:22 +02:00
/**
* The shared inbox
*
* @param WP_REST_Request $request
2018-09-30 22:51:22 +02:00
*
* @return WP_REST_Response
2018-09-30 22:51:22 +02:00
*/
public static function shared_inbox_post( $request ) {
2023-09-05 21:03:25 +02:00
$data = $request->get_json_params();
2021-01-09 01:26:26 +01:00
$type = $request->get_param( 'type' );
$users = self::extract_recipients( $data );
if ( ! $users ) {
2023-05-19 12:00:11 +02:00
return new WP_Error(
2022-01-27 13:09:11 +01:00
'rest_invalid_param',
\__( 'No recipients found', 'activitypub' ),
array(
'status' => 404,
'params' => array(
'to' => \__( 'Please check/validate "to" field', 'activitypub' ),
'bto' => \__( 'Please check/validate "bto" field', 'activitypub' ),
'cc' => \__( 'Please check/validate "cc" field', 'activitypub' ),
'bcc' => \__( 'Please check/validate "bcc" field', 'activitypub' ),
'audience' => \__( 'Please check/validate "audience" field', 'activitypub' ),
),
)
);
2021-01-09 01:26:26 +01:00
}
foreach ( $users as $user ) {
$user = User_Collection::get_by_various( $user );
if ( is_wp_error( $user ) ) {
continue;
}
2021-11-17 21:11:34 +01:00
$type = \strtolower( $type );
2021-01-09 01:26:26 +01:00
\do_action( 'activitypub_inbox', $data, $user->ID, $type );
\do_action( "activitypub_inbox_{$type}", $data, $user->ID );
}
2019-11-18 20:57:00 +01:00
2023-04-21 08:51:38 +02:00
return new WP_REST_Response( array(), 202 );
2018-09-27 22:28:49 +02:00
}
2018-09-30 22:51:22 +02:00
/**
* The supported parameters
*
* @return array list of parameters
*/
public static function user_inbox_get_parameters() {
2018-09-27 22:28:49 +02:00
$params = array();
$params['page'] = array(
'type' => 'integer',
);
$params['user_id'] = array(
2018-09-27 22:28:49 +02:00
'required' => true,
'type' => 'string',
);
return $params;
}
/**
* The supported parameters
*
* @return array list of parameters
*/
public static function user_inbox_post_parameters() {
$params = array();
$params['page'] = array(
'type' => 'integer',
);
$params['user_id'] = array(
'required' => true,
'type' => 'string',
2018-09-27 22:28:49 +02:00
);
$params['id'] = array(
'required' => true,
'sanitize_callback' => 'esc_url_raw',
);
$params['actor'] = array(
'required' => true,
'sanitize_callback' => function( $param, $request, $key ) {
2020-02-22 13:02:58 +01:00
if ( ! \is_string( $param ) ) {
$param = $param['id'];
}
return \esc_url_raw( $param );
},
);
$params['type'] = array(
'required' => true,
2020-05-04 00:06:48 +02:00
//'type' => 'enum',
//'enum' => array( 'Create' ),
2021-11-17 21:11:34 +01:00
//'sanitize_callback' => function( $param, $request, $key ) {
2023-07-20 03:39:58 +02:00
// return \strtolower( $param );
2021-11-17 21:11:34 +01:00
//},
);
$params['object'] = array(
'required' => true,
);
return $params;
}
/**
* The supported parameters
*
* @return array list of parameters
*/
public static function shared_inbox_post_parameters() {
$params = array();
$params['page'] = array(
'type' => 'integer',
);
$params['id'] = array(
'required' => true,
'type' => 'string',
'sanitize_callback' => 'esc_url_raw',
);
$params['actor'] = array(
'required' => true,
//'type' => array( 'object', 'string' ),
'sanitize_callback' => function( $param, $request, $key ) {
if ( ! \is_string( $param ) ) {
$param = $param['id'];
}
return \esc_url_raw( $param );
},
);
$params['type'] = array(
'required' => true,
//'type' => 'enum',
//'enum' => array( 'Create' ),
2021-11-17 21:11:34 +01:00
//'sanitize_callback' => function( $param, $request, $key ) {
2023-07-20 03:39:58 +02:00
// return \strtolower( $param );
2021-11-17 21:11:34 +01:00
//},
);
$params['object'] = array(
'required' => true,
2020-05-04 00:06:48 +02:00
//'type' => 'object',
);
$params['to'] = array(
2021-01-09 01:26:26 +01:00
'required' => false,
'sanitize_callback' => function( $param, $request, $key ) {
if ( \is_string( $param ) ) {
$param = array( $param );
}
return $param;
},
);
$params['cc'] = array(
'sanitize_callback' => function( $param, $request, $key ) {
if ( \is_string( $param ) ) {
$param = array( $param );
}
return $param;
},
);
$params['bcc'] = array(
'sanitize_callback' => function( $param, $request, $key ) {
if ( \is_string( $param ) ) {
$param = array( $param );
}
return $param;
},
);
2018-09-27 22:28:49 +02:00
return $params;
}
/**
* Converts a new ActivityPub object to comment data suitable for creating a comment
*
* @param array $object The activity-object.
*
* @return array Comment data suitable for creating a comment.
*/
2023-09-29 17:47:17 +02:00
public static function convert_object_to_comment_data( $object, $user_id ) {
$object['user_id'] = $user_id;
2022-11-09 15:08:32 +01:00
if ( ! isset( $object['object']['inReplyTo'] ) ) {
return;
2023-01-24 06:32:29 +01:00
}
// check if Activity is public or not
if ( ! self::is_activity_public( $object ) ) {
// @todo maybe send email
return false;
}
$meta = \Activitypub\get_remote_metadata_by_actor( $object['actor'] );
2021-02-18 07:12:32 +01:00
$id = $object['object']['id'];
2022-04-15 09:17:00 +02:00
// Only handle replies
if ( ! isset( $object['object']['inReplyTo'] ) ) {
return;
2022-04-15 09:17:00 +02:00
}
$in_reply_to = $object['object']['inReplyTo'];
// Comment already exists
if ( \Activitypub\object_id_to_comment( $id ) ) {
return;
2021-02-18 07:12:32 +01:00
}
$parent_comment = \Activitypub\object_id_to_comment( $in_reply_to );
// save only replies and reactions
2023-01-24 06:32:29 +01:00
$comment_post_id = \Activitypub\object_to_post_id_by_field_name( $object, 'context' );
if ( ! $comment_post_id ) {
$comment_post_id = \Activitypub\object_to_post_id_by_field_name( $object, 'inReplyTo' );
}
if ( ! $comment_post_id ) {
$comment_post_id = $parent_comment->comment_post_ID;
}
if ( ! $comment_post_id ) {
return;
}
return array(
'comment_post_ID' => $comment_post_id,
2019-09-27 10:12:59 +02:00
'comment_author' => \esc_attr( $meta['name'] ),
'comment_author_url' => \esc_url_raw( $object['actor'] ),
'comment_content' => \wp_filter_kses( $object['object']['content'] ),
2023-08-02 18:19:21 +02:00
'comment_type' => 'comment',
'comment_author_email' => '',
'comment_parent' => $parent_comment ? $parent_comment->comment_ID : 0,
'comment_meta' => array(
'ap_object' => \serialize( $object ),
'source_id' => \esc_url_raw( $id ),
'source_url' => \esc_url_raw( $object['object']['url'] ),
'avatar_url' => \esc_url_raw( $meta['icon']['url'] ),
'protocol' => 'activitypub',
),
);
}
/**
* Handles "Create" requests
*
* @param array $object The activity-object
* @param int $user_id The id of the local blog-user
*/
public static function handle_create( $object, $user_id ) {
$commentdata = self::convert_object_to_comment_data( $object, $user_id );
2023-01-24 06:32:29 +01:00
if ( ! $commentdata ) {
return false;
}
2023-02-04 23:37:09 +01:00
// disable flood control
\remove_action( 'check_comment_flood', 'check_comment_flood_db', 10 );
2020-12-28 23:33:26 +01:00
2023-02-04 23:37:09 +01:00
// do not require email for AP entries
\add_filter( 'pre_option_require_name_email', '__return_false' );
// No nonce possible for this submission route
\add_filter(
'akismet_comment_nonce',
function() {
return 'inactive';
}
);
2023-02-04 23:37:09 +01:00
$state = \wp_new_comment( $commentdata, true );
2020-10-09 13:19:17 +02:00
2023-02-04 23:37:09 +01:00
\remove_filter( 'pre_option_require_name_email', '__return_false' );
2020-12-28 23:33:26 +01:00
2023-02-04 23:37:09 +01:00
// re-add flood control
\add_action( 'check_comment_flood', 'check_comment_flood_db', 10, 4 );
do_action( 'activitypub_handled_create', $object, $user_id, $state, $commentdata );
}
2021-01-09 01:26:26 +01:00
2022-04-15 03:04:43 +02:00
/**
* Handles "Update" requests
*
* @param array $object The activity-object
* @param int $user_id The id of the local blog-user
*/
public static function handle_update( $object, $user_id ) {
$meta = \Activitypub\get_remote_metadata_by_actor( $object['actor'] );
//Determine comment_ID
2022-09-28 19:18:30 +02:00
$object_comment_id = \Activitypub\url_to_commentid( \esc_url_raw( $object['object']['id'] ) );
if ( ! is_null( $object_comment_id ) ) {
2022-04-15 09:17:00 +02:00
2022-04-15 03:04:43 +02:00
//found a local comment id
2022-09-28 19:18:30 +02:00
$commentdata = \get_comment( $object_comment_id, ARRAY_A );
2022-12-23 13:17:12 +01:00
$commentdata['comment_author'] = \esc_attr( $meta['name'] ? $meta['name'] : $meta['preferredUsername'] );
2022-04-15 03:04:43 +02:00
$commentdata['comment_content'] = \wp_filter_kses( $object['object']['content'] );
2022-12-23 13:17:12 +01:00
$commentdata['comment_meta']['avatar_url'] = \esc_url_raw( $meta['icon']['url'] );
2022-04-15 03:04:43 +02:00
$commentdata['comment_meta']['ap_published'] = \wp_date( 'Y-m-d H:i:s', strtotime( $object['object']['published'] ) );
$commentdata['comment_meta']['ap_last_modified'] = $object['object']['updated'];
$commentdata['comment_meta']['ap_object'] = \serialize( $object );
2022-04-15 09:17:00 +02:00
// disable flood control
2022-04-15 03:04:43 +02:00
\remove_action( 'check_comment_flood', 'check_comment_flood_db', 10 );
// do not require email for AP entries
\add_filter( 'pre_option_require_name_email', '__return_false' );
$state = \wp_update_comment( $commentdata, true );
\remove_filter( 'pre_option_require_name_email', '__return_false' );
// re-add flood control
2022-04-15 09:17:00 +02:00
\add_action( 'check_comment_flood', 'check_comment_flood_db', 10, 4 );
}
2022-04-15 03:04:43 +02:00
}
/**
* Handles "Delete" requests
*
* @param array $object The activity-object
* @param int $user_id The id of the local blog-user
*/
public static function handle_delete( $object, $user_id ) {
if ( ! isset( $object['object']['id'] ) ) {
return;
}
//Determine comment_ID
2022-09-28 19:18:30 +02:00
$object_comment_id = \Activitypub\url_to_commentid( \esc_url_raw( $object['object']['id'] ) );
if ( ! is_null( $object_comment_id ) ) {
2022-04-15 09:17:00 +02:00
2022-04-15 03:04:43 +02:00
//found a local comment id
2022-09-28 19:18:30 +02:00
$commentdata = \get_comment( $object_comment_id, ARRAY_A );
2022-04-15 09:17:00 +02:00
// disable flood control
2022-04-15 03:04:43 +02:00
\remove_action( 'check_comment_flood', 'check_comment_flood_db', 10 );
// do not require email for AP entries
\add_filter( 'pre_option_require_name_email', '__return_false' );
// Should we trash or send back to moderation
$state = \wp_trash_comment( $commentdata['comment_ID'], true );
2022-09-28 19:18:30 +02:00
\remove_filter( 'pre_option_require_name_email', '__return_false' );
2022-04-15 03:04:43 +02:00
// re-add flood control
2022-04-15 09:17:00 +02:00
\add_action( 'check_comment_flood', 'check_comment_flood_db', 10, 4 );
}
2022-04-15 03:04:43 +02:00
}
/**
* Extract recipient URLs from Activity object
*
* @param array $data
*
* @return array The list of user URLs
*/
2021-01-09 01:26:26 +01:00
public static function extract_recipients( $data ) {
$recipient_items = array();
2021-01-09 01:26:26 +01:00
foreach ( array( 'to', 'bto', 'cc', 'bcc', 'audience' ) as $i ) {
if ( array_key_exists( $i, $data ) ) {
2023-02-16 09:12:01 +01:00
if ( is_array( $data[ $i ] ) ) {
$recipient = $data[ $i ];
} else {
$recipient = array( $data[ $i ] );
}
$recipient_items = array_merge( $recipient_items, $recipient );
2021-01-09 01:26:26 +01:00
}
if ( array_key_exists( $i, $data['object'] ) ) {
2023-02-16 09:12:01 +01:00
if ( is_array( $data['object'][ $i ] ) ) {
$recipient = $data['object'][ $i ];
} else {
$recipient = array( $data['object'][ $i ] );
}
$recipient_items = array_merge( $recipient_items, $recipient );
2021-01-09 01:26:26 +01:00
}
}
$recipients = array();
// flatten array
foreach ( $recipient_items as $recipient ) {
if ( is_array( $recipient ) ) {
// check if recipient is an object
if ( array_key_exists( 'id', $recipient ) ) {
$recipients[] = $recipient['id'];
}
} else {
$recipients[] = $recipient;
2021-01-09 01:26:26 +01:00
}
}
return array_unique( $recipients );
}
/**
* Get local user recipients
*
* @param array $data
*
* @return array The list of local users
*/
public static function get_recipients( $data ) {
$recipients = self::extract_recipients( $data );
$users = array();
2021-01-09 01:26:26 +01:00
foreach ( $recipients as $recipient ) {
2023-05-19 12:00:11 +02:00
$user_id = url_to_authorid( $recipient );
2021-01-09 01:26:26 +01:00
$user = get_user_by( 'id', $user_id );
if ( $user ) {
$users[] = $user;
}
}
return $users;
}
/**
* Check if passed Activity is Public
*
* @param array $data
* @return boolean
*/
public static function is_activity_public( $data ) {
$recipients = self::extract_recipients( $data );
return in_array( 'https://www.w3.org/ns/activitystreams#Public', $recipients, true );
}
2018-09-27 22:28:49 +02:00
}