wordpress-activitypub/includes/class-activitypub.php

332 lines
8.1 KiB
PHP
Raw Permalink Normal View History

2018-08-18 12:35:39 +02:00
<?php
namespace Activitypub;
use Activitypub\Signature;
2023-07-03 17:59:42 +02:00
use Activitypub\Collection\Users;
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() {
2023-04-20 15:22:11 +02:00
\add_filter( 'template_include', array( self::class, 'render_json_template' ), 99 );
\add_filter( 'query_vars', array( self::class, 'add_query_vars' ) );
\add_filter( 'pre_get_avatar_data', array( self::class, 'pre_get_avatar_data' ), 11, 2 );
\add_filter( 'get_comment_link', array( self::class, 'remote_comment_link' ), 11, 3 );
2019-02-24 12:27:26 +01:00
// Add support for ActivityPub to custom post types
$transformer_mapping = \get_option( 'activitypub_transformer_mapping', array( 'post' => 'activitypub/default', 'page' => 'activitypub/default' ) ) ? \get_option( 'activitypub_transformer_mapping', array( 'post' => 'activitypub/default', 'page' => 'activitypub/default' ) ) : array();
foreach ( array_keys( $transformer_mapping ) as $post_type ) {
\add_post_type_support( $post_type, 'activitypub' );
}
2019-02-24 12:27:26 +01:00
2023-04-20 15:22:11 +02:00
\add_action( 'wp_trash_post', array( self::class, 'trash_post' ), 1 );
\add_action( 'untrash_post', array( self::class, 'untrash_post' ), 1 );
2023-05-04 15:17:05 +02:00
\add_action( 'init', array( self::class, 'add_rewrite_rules' ), 11 );
2023-05-30 15:19:05 +02:00
\add_action( 'after_setup_theme', array( self::class, 'theme_compat' ), 99 );
2023-08-02 10:44:56 +02:00
\add_action( 'in_plugin_update_message-' . ACTIVITYPUB_PLUGIN_BASENAME, array( self::class, 'plugin_update_message' ) );
2023-05-04 15:17:05 +02:00
}
/**
* Activation Hook
*
* @return void
*/
public static function activate() {
self::flush_rewrite_rules();
Scheduler::register_schedules();
2023-05-04 15:17:05 +02:00
}
/**
* Deactivation Hook
*
* @return void
*/
public static function deactivate() {
self::flush_rewrite_rules();
Scheduler::deregister_schedules();
2023-05-04 15:17:05 +02:00
}
/**
* Uninstall Hook
*
* @return void
*/
public static function uninstall() {
2023-05-31 10:47:49 +02:00
Scheduler::deregister_schedules();
}
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 ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
2018-08-18 12:35:39 +02:00
return $template;
}
if ( ! is_activitypub_request() ) {
return $template;
}
2023-04-21 17:20:48 +02:00
$json_template = false;
// check if user can publish posts
if ( \is_author() && is_wp_error( Users::get_by_id( \get_the_author_meta( 'ID' ) ) ) ) {
return $template;
}
2019-09-27 10:12:59 +02:00
if ( \is_author() ) {
2023-01-13 09:19:02 +01:00
$json_template = ACTIVITYPUB_PLUGIN_DIR . '/templates/author-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
if ( ACTIVITYPUB_AUTHORIZED_FETCH ) {
$verification = Signature::verify_http_signature( $_SERVER );
if ( \is_wp_error( $verification ) ) {
// fallback as template_loader can't return http headers
return $template;
}
2018-08-18 12:35:39 +02:00
}
2023-06-28 10:14:13 +02:00
return $json_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';
2018-09-24 20:47:15 +02:00
2018-08-18 12:35:39 +02:00
return $vars;
}
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;
}
2019-09-27 10:12:59 +02:00
$allowed_comment_types = \apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
2023-05-05 09:57:47 +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
}
/**
* Link remote comments to source url.
*
* @param string $comment_link
* @param object|WP_Comment $comment
*
* @return string $url
*/
public static function remote_comment_link( $comment_link, $comment ) {
$remote_comment_link = get_comment_meta( $comment->comment_ID, 'source_url', true );
if ( $remote_comment_link ) {
$comment_link = esc_url( $remote_comment_link );
}
return $comment_link;
}
/**
2023-08-02 10:44:56 +02:00
* Store permalink in meta, to send delete Activity.
*
2023-08-02 10:44:56 +02:00
* @param string $post_id The Post ID.
*
* @return void
*/
public static function trash_post( $post_id ) {
2023-05-05 09:57:47 +02: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' );
}
2023-05-04 15:17:05 +02:00
/**
* Add rewrite rules
*/
public static function add_rewrite_rules() {
// If another system needs to take precedence over the ActivityPub rewrite rules,
// they can define their own and will manually call the appropriate functions as required.
if ( ACTIVITYPUB_DISABLE_REWRITES ) {
return;
}
2023-05-04 15:17:05 +02:00
if ( ! \class_exists( 'Webfinger' ) ) {
2023-05-05 09:57:47 +02:00
\add_rewrite_rule(
'^.well-known/webfinger',
2023-05-16 08:14:04 +02:00
'index.php?rest_route=/' . ACTIVITYPUB_REST_NAMESPACE . '/webfinger',
2023-05-05 09:57:47 +02:00
'top'
);
2023-05-04 15:17:05 +02:00
}
if ( ! \class_exists( 'Nodeinfo_Endpoint' ) && true === (bool) \get_option( 'blog_public', 1 ) ) {
2023-05-05 09:57:47 +02:00
\add_rewrite_rule(
'^.well-known/nodeinfo',
2023-05-16 08:14:04 +02:00
'index.php?rest_route=/' . ACTIVITYPUB_REST_NAMESPACE . '/nodeinfo/discovery',
2023-05-05 09:57:47 +02:00
'top'
);
\add_rewrite_rule(
'^.well-known/x-nodeinfo2',
2023-05-16 08:14:04 +02:00
'index.php?rest_route=/' . ACTIVITYPUB_REST_NAMESPACE . '/nodeinfo2',
2023-05-05 09:57:47 +02:00
'top'
);
2023-05-04 15:17:05 +02:00
}
2023-08-09 13:58:42 +02:00
\add_rewrite_rule(
'^@([\w\-\.]+)',
'index.php?rest_route=/' . ACTIVITYPUB_REST_NAMESPACE . '/users/$matches[1]',
'top'
);
2023-05-04 15:17:05 +02:00
\add_rewrite_endpoint( 'activitypub', EP_AUTHORS | EP_PERMALINK | EP_PAGES );
}
/**
* Flush rewrite rules;
*/
public static function flush_rewrite_rules() {
self::add_rewrite_rules();
\flush_rewrite_rules();
}
2023-05-30 15:19:05 +02:00
/**
* Theme compatibility stuff
*
* @return void
*/
2023-05-30 15:19:05 +02:00
public static function theme_compat() {
$site_icon = get_theme_support( 'custom-logo' );
if ( ! $site_icon ) {
// custom logo support
add_theme_support(
'custom-logo',
array(
'height' => 80,
'width' => 80,
)
);
}
$custom_header = get_theme_support( 'custom-header' );
if ( ! $custom_header ) {
// This theme supports a custom header
$custom_header_args = array(
'width' => 1250,
'height' => 600,
'header-text' => true,
);
add_theme_support( 'custom-header', $custom_header_args );
}
}
2023-08-02 10:44:56 +02:00
/**
* Display plugin upgrade notice to users
*
* @param array $data The plugin data
*
* @return void
*/
public static function plugin_update_message( $data ) {
if ( ! isset( $data['upgrade_notice'] ) ) {
return;
}
printf(
'<div class="update-message">%s</div>',
wp_kses(
wpautop( $data['upgrade_notice '] ),
array(
'p' => array(),
'a' => array( 'href', 'title' ),
'strong' => array(),
'em' => array(),
)
)
);
}
2018-08-18 12:35:39 +02:00
}