wordpress-activitypub/includes/class-activitypub.php

214 lines
6.5 KiB
PHP
Raw Normal View History

2018-08-18 12:35:39 +02:00
<?php
namespace Activitypub;
2018-09-30 22:51:22 +02:00
/**
* ActivityPub Class
*
* @author Matthias Pfefferle
*/
2018-09-05 22:03:57 +02:00
class Activitypub {
2019-02-24 13:01:28 +01:00
/**
2020-05-14 21:04:33 +02:00
* Initialize the class, registering WordPress hooks.
2019-02-24 13:01:28 +01:00
*/
public static function init() {
2019-09-27 10:12:59 +02:00
\add_filter( 'template_include', array( '\Activitypub\Activitypub', 'render_json_template' ), 99 );
\add_filter( 'query_vars', array( '\Activitypub\Activitypub', 'add_query_vars' ) );
\add_filter( 'pre_get_avatar_data', array( '\Activitypub\Activitypub', 'pre_get_avatar_data' ), 11, 2 );
2019-02-24 12:27:26 +01:00
// 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' );
}
2019-02-24 12:27:26 +01:00
2023-01-16 20:28:45 +01:00
\add_action( 'transition_post_status', array( '\Activitypub\Activitypub', 'schedule_post_activity' ), 33, 3 );
2022-12-27 16:01:59 +01:00
\add_action( 'wp_trash_post', array( '\Activitypub\Activitypub', 'trash_post' ), 1 );
\add_action( 'untrash_post', array( '\Activitypub\Activitypub', 'untrash_post' ), 1 );
}
2018-09-30 22:51:22 +02:00
/**
2020-05-14 21:04:33 +02:00
* Return a AS2 JSON version of an author, post or page.
2018-09-30 22:51:22 +02:00
*
2020-05-14 21:04:33 +02:00
* @param string $template The path to the template object.
2018-09-30 22:51:22 +02:00
*
2020-05-14 21:04:33 +02:00
* @return string The new path to the JSON template.
2018-09-30 22:51:22 +02:00
*/
public static function render_json_template( $template ) {
if ( ! \is_author() && ! \is_singular() && ! \is_home() && ! \Activitypub\is_ap_comment() && ! \Activitypub\is_ap_replies() ) {
2018-08-18 12:35:39 +02:00
return $template;
}
// check if user can publish posts
if ( \is_author() && ! user_can( \get_the_author_meta( 'ID' ), 'publish_posts' ) ) {
return $template;
}
2019-09-27 10:12:59 +02:00
if ( \is_author() ) {
$json_template = \dirname( __FILE__ ) . '/../templates/author-json.php';
2022-04-15 03:04:43 +02:00
} 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';
2019-09-27 10:12:59 +02:00
} elseif ( \is_singular() ) {
2023-01-13 09:19:02 +01:00
$json_template = ACTIVITYPUB_PLUGIN_DIR . '/templates/post-json.php';
2021-01-08 17:43:35 +01:00
} elseif ( \is_home() ) {
2023-01-13 09:19:02 +01:00
$json_template = ACTIVITYPUB_PLUGIN_DIR . '/templates/blog-json.php';
}
2018-08-18 12:35:39 +02:00
global $wp_query;
2019-07-26 17:06:53 +02:00
if ( isset( $wp_query->query_vars['activitypub'] ) ) {
2018-08-18 12:35:39 +02:00
return $json_template;
}
if ( ! isset( $_SERVER['HTTP_ACCEPT'] ) ) {
return $template;
}
2019-09-29 18:22:59 +02:00
$accept_header = $_SERVER['HTTP_ACCEPT'];
if (
\stristr( $accept_header, 'application/activity+json' ) ||
\stristr( $accept_header, 'application/ld+json' )
2019-09-29 18:22:59 +02:00
) {
2019-09-30 07:59:19 +02:00
return $json_template;
2018-08-18 12:35:39 +02:00
}
2019-09-29 18:22:59 +02:00
2020-05-14 21:04:33 +02:00
// Accept header as an array.
$accept = \explode( ',', \trim( $accept_header ) );
2018-08-18 12:35:39 +02:00
if (
2019-09-30 07:59:19 +02:00
\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 )
2018-08-18 12:35:39 +02:00
) {
2019-09-30 07:59:19 +02:00
return $json_template;
2018-08-18 12:35:39 +02:00
}
2019-09-30 07:59:19 +02:00
return $template;
2018-08-18 12:35:39 +02:00
}
/**
2020-05-14 21:04:33 +02:00
* Add the 'activitypub' query variable so WordPress won't mangle it.
2018-08-18 12:35:39 +02:00
*/
public static function add_query_vars( $vars ) {
2019-07-26 17:06:53 +02:00
$vars[] = 'activitypub';
$vars[] = 'replytocom';
2022-04-15 03:04:43 +02:00
//Collections review
$vars[] = 'replies';
$vars[] = 'collection_page';
2018-09-24 20:47:15 +02:00
2018-08-18 12:35:39 +02:00
return $vars;
}
/**
2020-05-14 21:04:33 +02:00
* Schedule Activities.
*
2020-05-14 21:04:33 +02:00
* @param string $new_status New post status.
* @param string $old_status Old post status.
* @param WP_Post $post Post object.
*/
2019-02-17 21:10:53 +01:00
public static function schedule_post_activity( $new_status, $old_status, $post ) {
2020-05-14 21:04:33 +02:00
// Do not send activities if post is password protected.
2019-09-27 10:12:59 +02:00
if ( \post_password_required( $post ) ) {
return;
}
2020-05-14 21:04:33 +02:00
// Check if post-type supports ActivityPub.
2019-09-27 10:12:59 +02:00
$post_types = \get_post_types_by_support( 'activitypub' );
if ( ! \in_array( $post->post_type, $post_types, true ) ) {
return;
}
2020-05-14 21:37:59 +02:00
$activitypub_post = new \Activitypub\Model\Post( $post );
2019-02-17 21:10:53 +01:00
if ( 'publish' === $new_status && 'publish' !== $old_status ) {
2020-05-14 21:37:59 +02:00
\wp_schedule_single_event( \time(), 'activitypub_send_post_activity', array( $activitypub_post ) );
2022-04-15 03:04:43 +02:00
} elseif ( 'publish' === $new_status ) { //this triggers when restored post from trash, which may not be desired
2020-05-14 21:37:59 +02:00
\wp_schedule_single_event( \time(), 'activitypub_send_update_activity', array( $activitypub_post ) );
2019-09-30 07:59:19 +02:00
} elseif ( 'trash' === $new_status ) {
2020-05-14 21:37:59 +02:00
\wp_schedule_single_event( \time(), 'activitypub_send_delete_activity', array( $activitypub_post ) );
2019-02-17 21:10:53 +01:00
}
}
2019-02-20 21:05:29 +01:00
/**
2020-05-14 21:04:33 +02:00
* Replaces the default avatar.
2019-02-20 21:05:29 +01:00
*
2020-05-14 21:04:33 +02:00
* @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.
2019-02-20 21:05:29 +01:00
*
* @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
) {
2019-02-20 21:05:29 +01:00
return $args;
}
2021-02-18 07:12:32 +01:00
$allowed_comment_types = \apply_filters( 'get_avatar_comment_types', array( 'comment', 'activitypub' ) );
2019-09-27 10:12:59 +02:00
if ( ! empty( $id_or_email->comment_type ) && ! \in_array( $id_or_email->comment_type, (array) $allowed_comment_types, true ) ) {
2019-02-20 21:05:29 +01:00
$args['url'] = false;
/** This filter is documented in wp-includes/link-template.php */
2019-09-27 10:12:59 +02:00
return \apply_filters( 'get_avatar_data', $args, $id_or_email );
2019-02-20 21:05:29 +01:00
}
2020-05-14 21:04:33 +02:00
// Check if comment has an avatar.
2019-02-20 21:05:29 +01:00
$avatar = self::get_avatar_url( $id_or_email->comment_ID );
if ( $avatar ) {
2019-09-27 10:12:59 +02:00
if ( ! isset( $args['class'] ) || ! \is_array( $args['class'] ) ) {
2019-02-20 21:05:29 +01:00
$args['class'] = array( 'u-photo' );
} else {
$args['class'][] = 'u-photo';
2019-09-27 10:12:59 +02:00
$args['class'] = \array_unique( $args['class'] );
2019-02-20 21:05:29 +01:00
}
$args['url'] = $avatar;
$args['class'][] = 'avatar-activitypub';
}
return $args;
}
/**
2020-05-14 21:04:33 +02:00
* Function to retrieve Avatar URL if stored in meta.
2019-02-20 21:05:29 +01:00
*
* @param int|WP_Comment $comment
*
* @return string $url
*/
public static function get_avatar_url( $comment ) {
2019-09-27 10:12:59 +02:00
if ( \is_numeric( $comment ) ) {
$comment = \get_comment( $comment );
2019-02-20 21:05:29 +01:00
}
2019-09-27 10:12:59 +02:00
return \get_comment_meta( $comment->comment_ID, 'avatar_url', true );
2019-02-20 21:05:29 +01:00
}
/**
* Store permalink in meta, to send delete Activity
*
* @param string $post_id The Post ID
*
* @return void
*/
public static function trash_post( $post_id ) {
2022-12-27 16:01:59 +01:00
\add_post_meta( $post_id, 'activitypub_canonical_url', \get_permalink( $post_id ), true );
}
/**
* Delete permalink from meta
*
* @param string $post_id The Post ID
*
* @return void
*/
public static function untrash_post( $post_id ) {
\delete_post_meta( $post_id, 'activitypub_canonical_url' );
}
2018-08-18 12:35:39 +02:00
}