mirror of
https://github.com/Automattic/wordpress-activitypub
synced 2024-10-18 11:43:31 +00:00
00a57c39a4
* PHPCS: Enable Commenting sniff * Apply suggestions from code review Co-authored-by: Matthias Pfefferle <pfefferle@users.noreply.github.com> * Fix param alignment. --------- Co-authored-by: Matthias Pfefferle <pfefferle@users.noreply.github.com>
374 lines
10 KiB
PHP
374 lines
10 KiB
PHP
<?php
|
||
/**
|
||
* Health_Check class.
|
||
*
|
||
* @package Activitypub
|
||
*/
|
||
|
||
namespace Activitypub;
|
||
|
||
use WP_Error;
|
||
use Activitypub\Collection\Users;
|
||
|
||
/**
|
||
* ActivityPub Health_Check Class.
|
||
*
|
||
* @author Matthias Pfefferle
|
||
*/
|
||
class Health_Check {
|
||
|
||
/**
|
||
* Initialize health checks.
|
||
*/
|
||
public static function init() {
|
||
\add_filter( 'site_status_tests', array( self::class, 'add_tests' ) );
|
||
\add_filter( 'debug_information', array( self::class, 'debug_information' ) );
|
||
}
|
||
|
||
/**
|
||
* Add tests to the Site Health Check.
|
||
*
|
||
* @param array $tests The test array.
|
||
*
|
||
* @return array The filtered test array.
|
||
*/
|
||
public static function add_tests( $tests ) {
|
||
if ( ! is_user_disabled( get_current_user_id() ) ) {
|
||
$tests['direct']['activitypub_test_author_url'] = array(
|
||
'label' => \__( 'Author URL test', 'activitypub' ),
|
||
'test' => array( self::class, 'test_author_url' ),
|
||
);
|
||
}
|
||
|
||
$tests['direct']['activitypub_test_webfinger'] = array(
|
||
'label' => __( 'WebFinger Test', 'activitypub' ),
|
||
'test' => array( self::class, 'test_webfinger' ),
|
||
);
|
||
|
||
return $tests;
|
||
}
|
||
|
||
/**
|
||
* Author URL tests.
|
||
*
|
||
* @return array
|
||
*/
|
||
public static function test_author_url() {
|
||
$result = array(
|
||
'label' => \__( 'Author URL accessible', 'activitypub' ),
|
||
'status' => 'good',
|
||
'badge' => array(
|
||
'label' => \__( 'ActivityPub', 'activitypub' ),
|
||
'color' => 'green',
|
||
),
|
||
'description' => \sprintf(
|
||
'<p>%s</p>',
|
||
\__( 'Your author URL is accessible and supports the required "Accept" header.', 'activitypub' )
|
||
),
|
||
'actions' => '',
|
||
'test' => 'test_author_url',
|
||
);
|
||
|
||
$check = self::is_author_url_accessible();
|
||
|
||
if ( true === $check ) {
|
||
return $result;
|
||
}
|
||
|
||
$result['status'] = 'critical';
|
||
$result['label'] = \__( 'Author URL is not accessible', 'activitypub' );
|
||
$result['badge']['color'] = 'red';
|
||
$result['description'] = \sprintf(
|
||
'<p>%s</p>',
|
||
$check->get_error_message()
|
||
);
|
||
|
||
return $result;
|
||
}
|
||
|
||
/**
|
||
* System Cron tests.
|
||
*
|
||
* @return array
|
||
*/
|
||
public static function test_system_cron() {
|
||
$result = array(
|
||
'label' => \__( 'System Task Scheduler configured', 'activitypub' ),
|
||
'status' => 'good',
|
||
'badge' => array(
|
||
'label' => \__( 'ActivityPub', 'activitypub' ),
|
||
'color' => 'green',
|
||
),
|
||
'description' => \sprintf(
|
||
'<p>%s</p>',
|
||
\esc_html__( 'You seem to use the System Task Scheduler to process WP_Cron tasks.', 'activitypub' )
|
||
),
|
||
'actions' => '',
|
||
'test' => 'test_system_cron',
|
||
);
|
||
|
||
if ( defined( 'DISABLE_WP_CRON' ) && DISABLE_WP_CRON ) {
|
||
return $result;
|
||
}
|
||
|
||
$result['status'] = 'recommended';
|
||
$result['label'] = \__( 'System Task Scheduler not configured', 'activitypub' );
|
||
$result['badge']['color'] = 'orange';
|
||
$result['description'] = \sprintf(
|
||
'<p>%s</p>',
|
||
\__( 'Enhance your WordPress site’s performance and mitigate potential heavy loads caused by plugins like ActivityPub by setting up a system cron job to run WP Cron. This ensures scheduled tasks are executed consistently and reduces the reliance on website traffic for trigger events.', 'activitypub' )
|
||
);
|
||
$result['actions'] .= sprintf(
|
||
'<p><a href="%s" target="_blank" rel="noopener">%s<span class="screen-reader-text"> %s</span><span aria-hidden="true" class="dashicons dashicons-external"></span></a></p>',
|
||
esc_url( __( 'https://developer.wordpress.org/plugins/cron/hooking-wp-cron-into-the-system-task-scheduler/', 'activitypub' ) ),
|
||
__( 'Learn how to hook the WP-Cron into the System Task Scheduler.', 'activitypub' ),
|
||
/* translators: Hidden accessibility text. */
|
||
__( '(opens in a new tab)', 'activitypub' )
|
||
);
|
||
|
||
return $result;
|
||
}
|
||
|
||
/**
|
||
* WebFinger tests.
|
||
*
|
||
* @return array
|
||
*/
|
||
public static function test_webfinger() {
|
||
$result = array(
|
||
'label' => \__( 'WebFinger endpoint', 'activitypub' ),
|
||
'status' => 'good',
|
||
'badge' => array(
|
||
'label' => \__( 'ActivityPub', 'activitypub' ),
|
||
'color' => 'green',
|
||
),
|
||
'description' => \sprintf(
|
||
'<p>%s</p>',
|
||
\__( 'Your WebFinger endpoint is accessible and returns the correct information.', 'activitypub' )
|
||
),
|
||
'actions' => '',
|
||
'test' => 'test_webfinger',
|
||
);
|
||
|
||
$check = self::is_webfinger_endpoint_accessible();
|
||
|
||
if ( true === $check ) {
|
||
return $result;
|
||
}
|
||
|
||
$result['status'] = 'critical';
|
||
$result['label'] = \__( 'WebFinger endpoint is not accessible', 'activitypub' );
|
||
$result['badge']['color'] = 'red';
|
||
$result['description'] = \sprintf(
|
||
'<p>%s</p>',
|
||
$check->get_error_message()
|
||
);
|
||
|
||
return $result;
|
||
}
|
||
|
||
/**
|
||
* Check if `author_posts_url` is accessible and that request returns correct JSON.
|
||
*
|
||
* @return bool|WP_Error True if the author URL is accessible, WP_Error otherwise.
|
||
*/
|
||
public static function is_author_url_accessible() {
|
||
$user = \wp_get_current_user();
|
||
$author_url = \get_author_posts_url( $user->ID );
|
||
$reference_author_url = self::get_author_posts_url( $user->ID, $user->user_nicename );
|
||
|
||
// Check for "author" in URL.
|
||
if ( $author_url !== $reference_author_url ) {
|
||
return new WP_Error(
|
||
'author_url_not_accessible',
|
||
\sprintf(
|
||
// translators: %s: Author URL.
|
||
\__(
|
||
'Your author URL <code>%s</code> was replaced, this is often done by plugins.',
|
||
'activitypub'
|
||
),
|
||
$author_url
|
||
)
|
||
);
|
||
}
|
||
|
||
// Try to access author URL.
|
||
$response = \wp_remote_get(
|
||
$author_url,
|
||
array(
|
||
'headers' => array( 'Accept' => 'application/activity+json' ),
|
||
'redirection' => 0,
|
||
)
|
||
);
|
||
|
||
if ( \is_wp_error( $response ) ) {
|
||
return new WP_Error(
|
||
'author_url_not_accessible',
|
||
\sprintf(
|
||
// translators: %s: Author URL.
|
||
\__(
|
||
'Your author URL <code>%s</code> is not accessible. Please check your WordPress setup or permalink structure. If the setup seems fine, maybe check if a plugin might restrict the access.',
|
||
'activitypub'
|
||
),
|
||
$author_url
|
||
)
|
||
);
|
||
}
|
||
|
||
$response_code = \wp_remote_retrieve_response_code( $response );
|
||
|
||
// Check for redirects.
|
||
if ( \in_array( $response_code, array( 301, 302, 307, 308 ), true ) ) {
|
||
return new WP_Error(
|
||
'author_url_not_accessible',
|
||
\sprintf(
|
||
// translators: %s: Author URL.
|
||
\__(
|
||
'Your author URL <code>%s</code> is redirecting to another page, this is often done by SEO plugins like "Yoast SEO".',
|
||
'activitypub'
|
||
),
|
||
$author_url
|
||
)
|
||
);
|
||
}
|
||
|
||
// Check if response is JSON.
|
||
$body = \wp_remote_retrieve_body( $response );
|
||
|
||
if ( ! \is_string( $body ) || ! \is_array( \json_decode( $body, true ) ) ) {
|
||
return new WP_Error(
|
||
'author_url_not_accessible',
|
||
\sprintf(
|
||
// translators: %s: Author URL.
|
||
\__(
|
||
'Your author URL <code>%s</code> does not return valid JSON for <code>application/activity+json</code>. Please check if your hosting supports alternate <code>Accept</code> headers.',
|
||
'activitypub'
|
||
),
|
||
$author_url
|
||
)
|
||
);
|
||
}
|
||
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Check if WebFinger endpoint is accessible and profile request returns correct JSON
|
||
*
|
||
* @return boolean|WP_Error
|
||
*/
|
||
public static function is_webfinger_endpoint_accessible() {
|
||
$user = Users::get_by_id( Users::APPLICATION_USER_ID );
|
||
$resource = $user->get_webfinger();
|
||
|
||
$url = Webfinger::resolve( $resource );
|
||
if ( \is_wp_error( $url ) ) {
|
||
$allowed = array( 'code' => array() );
|
||
|
||
$not_accessible = wp_kses(
|
||
// translators: %s: Author URL.
|
||
\__(
|
||
'Your WebFinger endpoint <code>%s</code> is not accessible. Please check your WordPress setup or permalink structure.',
|
||
'activitypub'
|
||
),
|
||
$allowed
|
||
);
|
||
$invalid_response = wp_kses(
|
||
// translators: %s: Author URL.
|
||
\__(
|
||
'Your WebFinger endpoint <code>%s</code> does not return valid JSON for <code>application/jrd+json</code>.',
|
||
'activitypub'
|
||
),
|
||
$allowed
|
||
);
|
||
|
||
$health_messages = array(
|
||
'webfinger_url_not_accessible' => \sprintf(
|
||
$not_accessible,
|
||
$url->get_error_data()['data']
|
||
),
|
||
'webfinger_url_invalid_response' => \sprintf(
|
||
// translators: %s: Author URL.
|
||
$invalid_response,
|
||
$url->get_error_data()['data']
|
||
),
|
||
);
|
||
$message = null;
|
||
if ( isset( $health_messages[ $url->get_error_code() ] ) ) {
|
||
$message = $health_messages[ $url->get_error_code() ];
|
||
}
|
||
|
||
return new WP_Error(
|
||
$url->get_error_code(),
|
||
$message,
|
||
$url->get_error_data()
|
||
);
|
||
}
|
||
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Retrieve the URL to the author page for the user with the ID provided.
|
||
*
|
||
* @global \WP_Rewrite $wp_rewrite WordPress rewrite component.
|
||
*
|
||
* @param int $author_id Author ID.
|
||
* @param string $author_nicename Optional. The author's nicename (slug). Default empty.
|
||
*
|
||
* @return string The URL to the author's page.
|
||
*/
|
||
public static function get_author_posts_url( $author_id, $author_nicename = '' ) {
|
||
global $wp_rewrite;
|
||
|
||
$auth_id = (int) $author_id;
|
||
$link = $wp_rewrite->get_author_permastruct();
|
||
|
||
if ( empty( $link ) ) {
|
||
$file = home_url( '/' );
|
||
$link = $file . '?author=' . $auth_id;
|
||
} else {
|
||
if ( '' === $author_nicename ) {
|
||
$user = get_userdata( $author_id );
|
||
if ( ! empty( $user->user_nicename ) ) {
|
||
$author_nicename = $user->user_nicename;
|
||
}
|
||
}
|
||
$link = str_replace( '%author%', $author_nicename, $link );
|
||
$link = home_url( user_trailingslashit( $link ) );
|
||
}
|
||
|
||
return $link;
|
||
}
|
||
|
||
/**
|
||
* Static function for generating site debug data when required.
|
||
*
|
||
* @param array $info The debug information to be added to the core information page.
|
||
* @return array The filtered information
|
||
*/
|
||
public static function debug_information( $info ) {
|
||
$info['activitypub'] = array(
|
||
'label' => __( 'ActivityPub', 'activitypub' ),
|
||
'fields' => array(
|
||
'webfinger' => array(
|
||
'label' => __( 'WebFinger Resource', 'activitypub' ),
|
||
'value' => Webfinger::get_user_resource( wp_get_current_user()->ID ),
|
||
'private' => true,
|
||
),
|
||
'author_url' => array(
|
||
'label' => __( 'Author URL', 'activitypub' ),
|
||
'value' => get_author_posts_url( wp_get_current_user()->ID ),
|
||
'private' => true,
|
||
),
|
||
'plugin_version' => array(
|
||
'label' => __( 'Plugin Version', 'activitypub' ),
|
||
'value' => get_plugin_version(),
|
||
'private' => true,
|
||
),
|
||
),
|
||
);
|
||
|
||
return $info;
|
||
}
|
||
}
|