326 lines
12 KiB
PHP
326 lines
12 KiB
PHP
<?php
|
|
namespace Activitypub;
|
|
|
|
/**
|
|
* ActivityPub Class
|
|
*
|
|
* @author Matthias Pfefferle
|
|
*/
|
|
class Activitypub {
|
|
/**
|
|
* Initialize the class, registering WordPress hooks.
|
|
*/
|
|
public static function init() {
|
|
\add_filter( 'template_include', array( '\Activitypub\Activitypub', 'render_json_template' ), 99 );
|
|
\add_filter( 'query_vars', array( '\Activitypub\Activitypub', 'add_query_vars' ) );
|
|
\add_action( 'init', array( '\Activitypub\Activitypub', 'add_rewrite_endpoint' ) );
|
|
\add_filter( 'pre_get_avatar_data', array( '\Activitypub\Activitypub', 'pre_get_avatar_data' ), 11, 2 );
|
|
|
|
// Add support for ActivityPub to custom post types
|
|
$post_types = \get_option( 'activitypub_support_post_types', array( 'post', 'page' ) ) ? \get_option( 'activitypub_support_post_types', array( 'post', 'page' ) ) : array();
|
|
|
|
foreach ( $post_types as $post_type ) {
|
|
\add_post_type_support( $post_type, 'activitypub' );
|
|
}
|
|
|
|
\add_action( 'transition_post_status', array( '\Activitypub\Activitypub', 'schedule_post_activity' ), 10, 3 );
|
|
|
|
\add_filter( 'preprocess_comment' , array( '\Activitypub\Activitypub', 'preprocess_comment' ) );
|
|
\add_filter( 'comment_post' , array( '\Activitypub\Activitypub', 'postprocess_comment' ), 10, 3 );
|
|
\add_filter( 'wp_update_comment_data', array( '\Activitypub\Activitypub', 'comment_updated_published' ), 20, 3 );
|
|
\add_action( 'transition_comment_status', array( '\Activitypub\Activitypub', 'schedule_comment_activity' ), 20, 3 );
|
|
\add_action( 'edit_comment', array( '\Activitypub\Activitypub', 'edit_comment' ), 20, 2 );//schedule_admin_comment_activity
|
|
\add_filter( 'get_comment_text', array( '\Activitypub\Activitypub', 'comment_append_edit_datetime' ), 10, 3 );
|
|
|
|
}
|
|
|
|
/**
|
|
* Return a AS2 JSON version of an author, post or page.
|
|
*
|
|
* @param string $template The path to the template object.
|
|
*
|
|
* @return string The new path to the JSON template.
|
|
*/
|
|
public static function render_json_template( $template ) {
|
|
if ( ! \is_author() && ! \is_singular() && ! \is_home() && ! \Activitypub\is_ap_comment() ) {
|
|
return $template;
|
|
}
|
|
|
|
if ( \is_author() ) {
|
|
$json_template = \dirname( __FILE__ ) . '/../templates/author-json.php';
|
|
} elseif ( \Activitypub\is_ap_replies() ) {
|
|
$json_template = \dirname( __FILE__ ) . '/../templates/replies-json.php';
|
|
} elseif ( \Activitypub\is_ap_comment() ) {
|
|
$json_template = \dirname( __FILE__ ) . '/../templates/comment-json.php';
|
|
} elseif ( \is_singular() ) {
|
|
$json_template = \dirname( __FILE__ ) . '/../templates/post-json.php';
|
|
} elseif ( \is_home() ) {
|
|
$json_template = \dirname( __FILE__ ) . '/../templates/blog-json.php';
|
|
}
|
|
|
|
global $wp_query;
|
|
|
|
if ( isset( $wp_query->query_vars['activitypub'] ) ) {
|
|
return $json_template;
|
|
}
|
|
|
|
if ( ! isset( $_SERVER['HTTP_ACCEPT'] ) ) {
|
|
return $template;
|
|
}
|
|
|
|
$accept_header = $_SERVER['HTTP_ACCEPT'];
|
|
|
|
if (
|
|
\stristr( $accept_header, 'application/activity+json' ) ||
|
|
\stristr( $accept_header, 'application/ld+json' )
|
|
) {
|
|
return $json_template;
|
|
}
|
|
|
|
// Accept header as an array.
|
|
$accept = \explode( ',', \trim( $accept_header ) );
|
|
|
|
if (
|
|
\in_array( 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"', $accept, true ) ||
|
|
\in_array( 'application/activity+json', $accept, true ) ||
|
|
\in_array( 'application/ld+json', $accept, true ) ||
|
|
\in_array( 'application/json', $accept, true )
|
|
) {
|
|
return $json_template;
|
|
}
|
|
|
|
return $template;
|
|
}
|
|
|
|
/**
|
|
* Add the 'activitypub' query variable so WordPress won't mangle it.
|
|
*/
|
|
public static function add_query_vars( $vars ) {
|
|
$vars[] = 'activitypub';
|
|
$vars[] = 'ap_comment_id';//comment_id doesn't work, 'c' is probably too short and prone to collisions
|
|
|
|
//Collections review
|
|
$vars[] = 'replies';
|
|
$vars[] = 'collection_page';
|
|
$vars[] = 'only_other_accounts';
|
|
|
|
return $vars;
|
|
}
|
|
|
|
/**
|
|
* Add our rewrite endpoint to permalinks and pages.
|
|
*/
|
|
public static function add_rewrite_endpoint() {
|
|
\add_rewrite_endpoint( 'activitypub', EP_AUTHORS | EP_PERMALINK | EP_PAGES );
|
|
}
|
|
|
|
/**
|
|
* Schedule Activities.
|
|
*
|
|
* @param string $new_status New post status.
|
|
* @param string $old_status Old post status.
|
|
* @param WP_Post $post Post object.
|
|
*/
|
|
public static function schedule_post_activity( $new_status, $old_status, $post ) {
|
|
// Do not send activities if post is password protected.
|
|
if ( \post_password_required( $post ) ) {
|
|
return;
|
|
}
|
|
|
|
// Check if post-type supports ActivityPub.
|
|
$post_types = \get_post_types_by_support( 'activitypub' );
|
|
if ( ! \in_array( $post->post_type, $post_types, true ) ) {
|
|
return;
|
|
}
|
|
|
|
$activitypub_post = new \Activitypub\Model\Post( $post );
|
|
|
|
if ( 'publish' === $new_status && 'publish' !== $old_status ) {
|
|
\wp_schedule_single_event( \time(), 'activitypub_send_post_activity', array( $activitypub_post ) );
|
|
} elseif ( 'publish' === $new_status ) { //this triggers when restored post from trash, which may not be desired
|
|
\wp_schedule_single_event( \time(), 'activitypub_send_update_activity', array( $activitypub_post ) );
|
|
} elseif ( 'trash' === $new_status ) {
|
|
\wp_schedule_single_event( \time(), 'activitypub_send_delete_activity', array( $activitypub_post ) );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* preprocess local comments for federated replies
|
|
*/
|
|
public static function preprocess_comment( $commentdata ) {
|
|
// only process replies from local actors
|
|
if ( !empty( $commentdata['user_id'] ) ) {
|
|
$commentdata['comment_type'] = 'activitypub';
|
|
// transform webfinger mentions to links and add @mentions to cc
|
|
$tagged_content = \Activitypub\transform_tags( $commentdata['comment_content'] );
|
|
$commentdata['comment_content'] = $tagged_content['content'];
|
|
$commentdata['comment_meta']['mentions'] = $tagged_content['mentions'];
|
|
}
|
|
return $commentdata;
|
|
}
|
|
|
|
/**
|
|
* comment_post()
|
|
* postprocess_comment for federating replies and inbox-forwarding
|
|
*/
|
|
public static function postprocess_comment( $comment_id, $comment_approved, $commentdata ) {
|
|
//Admin users comments bypass transition_comment_status (auto approved)
|
|
|
|
if ( $commentdata['comment_type'] === 'activitypub' ) {
|
|
if (
|
|
( $comment_approved === 1 ) &&
|
|
! empty( $commentdata['user_id'] ) &&
|
|
( $user = get_userdata( $commentdata['user_id'] ) ) && // get the user data
|
|
in_array( 'administrator', $user->roles ) // check the roles
|
|
) {
|
|
// Only for Admins?
|
|
$mentions = \get_comment_meta( $comment_id, 'mentions', true );
|
|
//\ActivityPub\Activity_Dispatcher::send_comment_activity( $comment_id ); // performance > followers collection
|
|
\wp_schedule_single_event( \time(), 'activitypub_send_comment_activity', array( $comment_id ) );
|
|
|
|
} else {
|
|
// TODO check that this is unused
|
|
// TODO comment test as anon / no auth_url, no fetchable status?
|
|
// TODO comment test as registered
|
|
// TODO comment test as anyother site settings
|
|
|
|
|
|
// $replyto = get_comment_meta( $comment_id, 'replyto', true );
|
|
|
|
//inbox forward prep
|
|
// if ( !empty( $ap_object ) ) {
|
|
// //if is remote user (has ap_object)
|
|
// //error_log( print_r( $ap_object, true ) );
|
|
// // TODO verify that deduplication check happens at object create.
|
|
|
|
// //if to/cc/audience contains local followers collection
|
|
// //$local_user = \get_comment_author_url( $comment_id );
|
|
// //$is_local_user = \Activitypub\url_to_authorid( $commentdata['comment_author_url'] );
|
|
|
|
// }
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* edit_comment()
|
|
*
|
|
* Fires immediately after a comment is updated in the database.
|
|
* Fires immediately before comment status transition hooks are fired. (useful only for admin)
|
|
*/
|
|
public static function edit_comment( $comment_ID, $data ) {
|
|
// advantage of ap_published is it would be set once, (does preprocess fire on edit?)
|
|
if ( ! is_null( $data['user_id'] ) ) {
|
|
\wp_schedule_single_event( \time(), 'activitypub_send_update_comment_activity', array( $comment_ID ) );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Schedule Activities
|
|
*
|
|
* transition_comment_status()
|
|
* @param int $comment
|
|
*/
|
|
public static function schedule_comment_activity( $new_status, $old_status, $activitypub_comment ) {
|
|
// TODO format $activitypub_comment = new \Activitypub\Model\Comment( $comment );
|
|
if ( 'approved' === $new_status && 'approved' !== $old_status ) {
|
|
//should only federate replies from local actors
|
|
//should only federate replies to federated actors
|
|
|
|
$ap_object = unserialize( \get_comment_meta( $activitypub_comment->comment_ID, 'ap_object', true ) );
|
|
if ( empty( $ap_object ) ) {
|
|
\wp_schedule_single_event( \time(), 'activitypub_send_comment_activity', array( $activitypub_comment->comment_ID ) );
|
|
} else {
|
|
$local_user = \get_author_posts_url( $ap_object['user_id'] );
|
|
if ( !is_null( $local_user ) ) {
|
|
if ( in_array( $local_user, $ap_object['to'] )
|
|
|| in_array( $local_user, $ap_object['cc'] )
|
|
|| in_array( $local_user, $ap_object['audience'] )
|
|
|| in_array( $local_user, $ap_object['tag'] )
|
|
) {
|
|
//if inReplyTo, object, target and/or tag are (local-wp) objects
|
|
\wp_schedule_single_event( \time(), 'activitypub_inbox_forward_activity', array( $activitypub_comment->comment_ID ) );
|
|
}
|
|
}
|
|
}
|
|
} elseif ( 'trash' === $new_status ) {
|
|
\wp_schedule_single_event( \time(), 'activitypub_send_delete_comment_activity', array( $activitypub_comment ) );
|
|
} elseif ( $old_status === $new_status ) {
|
|
//TODO Test with non-admin user
|
|
\wp_schedule_single_event( \time(), 'activitypub_send_update_comment_activity', array( $activitypub_comment->comment_ID ) );
|
|
} else {
|
|
//error_log( 'schedule_update_comment_activity: else?:' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* get_comment_text( $comment )
|
|
*
|
|
* Filters the comment content before it is updated in the database.
|
|
*/
|
|
public static function comment_append_edit_datetime( $comment_text, $comment, $args ) {
|
|
if ( 'activitypub' === $comment->comment_type ) {
|
|
$updated = \wp_date( 'Y-m-d H:i:s', \strtotime( \get_comment_meta( $comment->comment_ID, 'ap_last_modified', true ) ) );
|
|
if( $updated ) {
|
|
$append_updated = "<div>(Last edited on <time class='modified' datetime='{$updated}'>$updated</time>)</div>";
|
|
$comment_text .= $append_updated;
|
|
}
|
|
}
|
|
return $comment_text;
|
|
}
|
|
|
|
/**
|
|
* Replaces the default avatar.
|
|
*
|
|
* @param array $args Arguments passed to get_avatar_data(), after processing.
|
|
* @param int|string|object $id_or_email A user ID, email address, or comment object.
|
|
*
|
|
* @return array $args
|
|
*/
|
|
public static function pre_get_avatar_data( $args, $id_or_email ) {
|
|
if (
|
|
! $id_or_email instanceof \WP_Comment ||
|
|
! isset( $id_or_email->comment_type ) ||
|
|
$id_or_email->user_id
|
|
) {
|
|
return $args;
|
|
}
|
|
|
|
$allowed_comment_types = \apply_filters( 'get_avatar_comment_types', array( 'comment', 'activitypub' ) );
|
|
if ( ! empty( $id_or_email->comment_type ) && ! \in_array( $id_or_email->comment_type, (array) $allowed_comment_types, true ) ) {
|
|
$args['url'] = false;
|
|
/** This filter is documented in wp-includes/link-template.php */
|
|
return \apply_filters( 'get_avatar_data', $args, $id_or_email );
|
|
}
|
|
|
|
// Check if comment has an avatar.
|
|
$avatar = self::get_avatar_url( $id_or_email->comment_ID );
|
|
|
|
if ( $avatar ) {
|
|
if ( ! isset( $args['class'] ) || ! \is_array( $args['class'] ) ) {
|
|
$args['class'] = array( 'u-photo' );
|
|
} else {
|
|
$args['class'][] = 'u-photo';
|
|
$args['class'] = \array_unique( $args['class'] );
|
|
}
|
|
$args['url'] = $avatar;
|
|
$args['class'][] = 'avatar-activitypub';
|
|
}
|
|
|
|
return $args;
|
|
}
|
|
|
|
/**
|
|
* Function to retrieve Avatar URL if stored in meta.
|
|
*
|
|
* @param int|WP_Comment $comment
|
|
*
|
|
* @return string $url
|
|
*/
|
|
public static function get_avatar_url( $comment ) {
|
|
if ( \is_numeric( $comment ) ) {
|
|
$comment = \get_comment( $comment );
|
|
}
|
|
return \get_comment_meta( $comment->comment_ID, 'avatar_url', true );
|
|
}
|
|
}
|