2023-10-22 22:20:53 +00:00
|
|
|
<?php
|
2024-10-09 12:44:17 +00:00
|
|
|
/**
|
|
|
|
* Scheduler class file.
|
|
|
|
*
|
|
|
|
* @package Activitypub
|
|
|
|
*/
|
2023-10-22 22:20:53 +00:00
|
|
|
|
|
|
|
namespace Activitypub;
|
|
|
|
|
|
|
|
use Activitypub\Collection\Followers;
|
|
|
|
|
|
|
|
/**
|
2024-10-09 12:44:17 +00:00
|
|
|
* Scheduler class.
|
2023-10-22 22:20:53 +00:00
|
|
|
*
|
|
|
|
* @author Matthias Pfefferle
|
|
|
|
*/
|
|
|
|
class Scheduler {
|
2024-02-08 12:31:25 +00:00
|
|
|
|
2023-10-22 22:20:53 +00:00
|
|
|
/**
|
2024-10-09 12:44:17 +00:00
|
|
|
* Initialize the class, registering WordPress hooks.
|
2023-10-22 22:20:53 +00:00
|
|
|
*/
|
|
|
|
public static function init() {
|
2024-10-09 12:44:17 +00:00
|
|
|
// Post transitions.
|
2023-10-22 22:20:53 +00:00
|
|
|
\add_action( 'transition_post_status', array( self::class, 'schedule_post_activity' ), 33, 3 );
|
2024-02-08 12:31:25 +00:00
|
|
|
\add_action(
|
|
|
|
'edit_attachment',
|
|
|
|
function ( $post_id ) {
|
|
|
|
self::schedule_post_activity( 'publish', 'publish', $post_id );
|
|
|
|
}
|
|
|
|
);
|
|
|
|
\add_action(
|
|
|
|
'add_attachment',
|
|
|
|
function ( $post_id ) {
|
|
|
|
self::schedule_post_activity( 'publish', '', $post_id );
|
|
|
|
}
|
|
|
|
);
|
|
|
|
\add_action(
|
|
|
|
'delete_attachment',
|
|
|
|
function ( $post_id ) {
|
|
|
|
self::schedule_post_activity( 'trash', '', $post_id );
|
|
|
|
}
|
|
|
|
);
|
2023-10-22 22:20:53 +00:00
|
|
|
|
2024-03-28 09:39:50 +00:00
|
|
|
if ( ! ACTIVITYPUB_DISABLE_OUTGOING_INTERACTIONS ) {
|
2024-10-09 12:44:17 +00:00
|
|
|
// Comment transitions.
|
2024-03-28 09:39:50 +00:00
|
|
|
\add_action( 'transition_comment_status', array( self::class, 'schedule_comment_activity' ), 20, 3 );
|
|
|
|
\add_action(
|
|
|
|
'edit_comment',
|
|
|
|
function ( $comment_id ) {
|
|
|
|
self::schedule_comment_activity( 'approved', 'approved', $comment_id );
|
|
|
|
}
|
|
|
|
);
|
|
|
|
\add_action(
|
|
|
|
'wp_insert_comment',
|
|
|
|
function ( $comment_id ) {
|
|
|
|
self::schedule_comment_activity( 'approved', '', $comment_id );
|
|
|
|
}
|
|
|
|
);
|
|
|
|
}
|
2024-02-08 12:31:25 +00:00
|
|
|
|
2024-10-09 12:44:17 +00:00
|
|
|
// Follower Cleanups.
|
2023-10-22 22:20:53 +00:00
|
|
|
\add_action( 'activitypub_update_followers', array( self::class, 'update_followers' ) );
|
|
|
|
\add_action( 'activitypub_cleanup_followers', array( self::class, 'cleanup_followers' ) );
|
|
|
|
|
2024-10-09 12:44:17 +00:00
|
|
|
// Profile updates for blog options.
|
2024-02-08 12:31:25 +00:00
|
|
|
if ( ! is_user_type_disabled( 'blog' ) ) {
|
|
|
|
\add_action( 'update_option_site_icon', array( self::class, 'blog_user_update' ) );
|
|
|
|
\add_action( 'update_option_blogdescription', array( self::class, 'blog_user_update' ) );
|
|
|
|
\add_action( 'update_option_blogname', array( self::class, 'blog_user_update' ) );
|
|
|
|
\add_filter( 'pre_set_theme_mod_custom_logo', array( self::class, 'blog_user_update' ) );
|
|
|
|
\add_filter( 'pre_set_theme_mod_header_image', array( self::class, 'blog_user_update' ) );
|
|
|
|
}
|
|
|
|
|
2024-10-09 12:44:17 +00:00
|
|
|
// Profile updates for user options.
|
2024-02-08 12:31:25 +00:00
|
|
|
if ( ! is_user_type_disabled( 'user' ) ) {
|
|
|
|
\add_action( 'wp_update_user', array( self::class, 'user_update' ) );
|
|
|
|
\add_action( 'updated_user_meta', array( self::class, 'user_meta_update' ), 10, 3 );
|
|
|
|
// @todo figure out a feasible way of updating the header image since it's not unique to any user.
|
|
|
|
}
|
2023-10-22 22:20:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Schedule all ActivityPub schedules.
|
|
|
|
*/
|
|
|
|
public static function register_schedules() {
|
|
|
|
if ( ! \wp_next_scheduled( 'activitypub_update_followers' ) ) {
|
|
|
|
\wp_schedule_event( time(), 'hourly', 'activitypub_update_followers' );
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( ! \wp_next_scheduled( 'activitypub_cleanup_followers' ) ) {
|
|
|
|
\wp_schedule_event( time(), 'daily', 'activitypub_cleanup_followers' );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2024-10-09 12:44:17 +00:00
|
|
|
* Un-schedule all ActivityPub schedules.
|
2023-10-22 22:20:53 +00:00
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public static function deregister_schedules() {
|
|
|
|
wp_unschedule_hook( 'activitypub_update_followers' );
|
|
|
|
wp_unschedule_hook( 'activitypub_cleanup_followers' );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Schedule Activities.
|
|
|
|
*
|
2024-10-09 12:44:17 +00:00
|
|
|
* @param string $new_status New post status.
|
|
|
|
* @param string $old_status Old post status.
|
|
|
|
* @param \WP_Post $post Post object.
|
2023-10-22 22:20:53 +00:00
|
|
|
*/
|
|
|
|
public static function schedule_post_activity( $new_status, $old_status, $post ) {
|
2024-02-08 12:31:25 +00:00
|
|
|
$post = get_post( $post );
|
|
|
|
|
2024-10-09 12:44:17 +00:00
|
|
|
if ( ! $post ) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2024-07-19 19:46:05 +00:00
|
|
|
if ( 'ap_extrafield' === $post->post_type ) {
|
|
|
|
self::schedule_profile_update( $post->post_author );
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2024-10-09 12:44:17 +00:00
|
|
|
if ( 'ap_extrafield_blog' === $post->post_type ) {
|
|
|
|
self::schedule_profile_update( 0 );
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2023-10-22 22:20:53 +00:00
|
|
|
// 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;
|
|
|
|
}
|
|
|
|
|
|
|
|
$type = false;
|
|
|
|
|
2024-07-19 19:46:05 +00:00
|
|
|
if (
|
|
|
|
'publish' === $new_status &&
|
|
|
|
'publish' !== $old_status
|
|
|
|
) {
|
2023-10-22 22:20:53 +00:00
|
|
|
$type = 'Create';
|
2024-07-19 19:46:05 +00:00
|
|
|
} elseif (
|
|
|
|
'publish' === $new_status ||
|
2024-10-09 12:44:17 +00:00
|
|
|
// We want to send updates for posts that are published and then moved to draft.
|
2024-07-19 19:46:05 +00:00
|
|
|
( 'draft' === $new_status &&
|
2024-10-09 12:44:17 +00:00
|
|
|
'publish' === $old_status )
|
2024-07-19 19:46:05 +00:00
|
|
|
) {
|
2023-10-22 22:20:53 +00:00
|
|
|
$type = 'Update';
|
|
|
|
} elseif ( 'trash' === $new_status ) {
|
|
|
|
$type = 'Delete';
|
|
|
|
}
|
|
|
|
|
2024-03-28 09:39:50 +00:00
|
|
|
if ( empty( $type ) ) {
|
2023-10-22 22:20:53 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2024-03-28 09:39:50 +00:00
|
|
|
$hook = 'activitypub_send_post';
|
|
|
|
$args = array( $post->ID, $type );
|
2023-10-22 22:20:53 +00:00
|
|
|
|
2024-03-28 09:39:50 +00:00
|
|
|
if ( false === wp_next_scheduled( $hook, $args ) ) {
|
|
|
|
set_wp_object_state( $post, 'federate' );
|
|
|
|
\wp_schedule_single_event( \time(), $hook, $args );
|
|
|
|
}
|
2023-10-22 22:20:53 +00:00
|
|
|
}
|
|
|
|
|
2024-02-08 12:31:25 +00:00
|
|
|
/**
|
2024-10-09 12:44:17 +00:00
|
|
|
* Schedule Comment Activities.
|
2024-02-08 12:31:25 +00:00
|
|
|
*
|
2024-10-09 12:44:17 +00:00
|
|
|
* @see transition_comment_status()
|
2024-02-08 12:31:25 +00:00
|
|
|
*
|
2024-10-09 12:44:17 +00:00
|
|
|
* @param string $new_status New comment status.
|
|
|
|
* @param string $old_status Old comment status.
|
|
|
|
* @param \WP_Comment $comment Comment object.
|
2024-02-08 12:31:25 +00:00
|
|
|
*/
|
|
|
|
public static function schedule_comment_activity( $new_status, $old_status, $comment ) {
|
|
|
|
$comment = get_comment( $comment );
|
|
|
|
|
2024-10-09 12:44:17 +00:00
|
|
|
// Federate only comments that are written by a registered user.
|
|
|
|
if ( ! $comment || ! $comment->user_id ) {
|
2024-02-08 12:31:25 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2024-03-28 09:39:50 +00:00
|
|
|
$type = false;
|
|
|
|
|
2024-02-08 12:31:25 +00:00
|
|
|
if (
|
|
|
|
'approved' === $new_status &&
|
|
|
|
'approved' !== $old_status
|
|
|
|
) {
|
|
|
|
$type = 'Create';
|
|
|
|
} elseif ( 'approved' === $new_status ) {
|
|
|
|
$type = 'Update';
|
|
|
|
\update_comment_meta( $comment->comment_ID, 'activitypub_comment_modified', time(), true );
|
|
|
|
} elseif (
|
|
|
|
'trash' === $new_status ||
|
|
|
|
'spam' === $new_status
|
|
|
|
) {
|
|
|
|
$type = 'Delete';
|
|
|
|
}
|
|
|
|
|
2024-03-28 09:39:50 +00:00
|
|
|
if ( empty( $type ) ) {
|
2024-02-08 12:31:25 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2024-10-09 12:44:17 +00:00
|
|
|
// Check if comment should be federated or not.
|
2024-03-28 09:39:50 +00:00
|
|
|
if ( ! should_comment_be_federated( $comment ) ) {
|
|
|
|
return;
|
|
|
|
}
|
2024-02-08 12:31:25 +00:00
|
|
|
|
2024-03-28 09:39:50 +00:00
|
|
|
$hook = 'activitypub_send_comment';
|
|
|
|
$args = array( $comment->comment_ID, $type );
|
|
|
|
|
|
|
|
if ( false === wp_next_scheduled( $hook, $args ) ) {
|
|
|
|
set_wp_object_state( $comment, 'federate' );
|
|
|
|
\wp_schedule_single_event( \time(), $hook, $args );
|
|
|
|
}
|
2024-02-08 12:31:25 +00:00
|
|
|
}
|
|
|
|
|
2023-10-22 22:20:53 +00:00
|
|
|
/**
|
2024-10-09 12:44:17 +00:00
|
|
|
* Update followers.
|
2023-10-22 22:20:53 +00:00
|
|
|
*/
|
|
|
|
public static function update_followers() {
|
|
|
|
$number = 5;
|
|
|
|
|
|
|
|
if ( defined( 'DISABLE_WP_CRON' ) && DISABLE_WP_CRON ) {
|
|
|
|
$number = 50;
|
|
|
|
}
|
|
|
|
|
2024-10-09 12:44:17 +00:00
|
|
|
/**
|
|
|
|
* Filter the number of followers to update.
|
|
|
|
*
|
|
|
|
* @param int $number The number of followers to update.
|
|
|
|
*/
|
2024-03-28 09:39:50 +00:00
|
|
|
$number = apply_filters( 'activitypub_update_followers_number', $number );
|
2023-10-22 22:20:53 +00:00
|
|
|
$followers = Followers::get_outdated_followers( $number );
|
|
|
|
|
|
|
|
foreach ( $followers as $follower ) {
|
2023-12-08 23:23:11 +00:00
|
|
|
$meta = get_remote_metadata_by_actor( $follower->get_id(), false );
|
2023-10-22 22:20:53 +00:00
|
|
|
|
|
|
|
if ( empty( $meta ) || ! is_array( $meta ) || is_wp_error( $meta ) ) {
|
|
|
|
Followers::add_error( $follower->get__id(), $meta );
|
|
|
|
} else {
|
|
|
|
$follower->from_array( $meta );
|
|
|
|
$follower->update();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2024-10-09 12:44:17 +00:00
|
|
|
* Cleanup followers.
|
2023-10-22 22:20:53 +00:00
|
|
|
*/
|
|
|
|
public static function cleanup_followers() {
|
|
|
|
$number = 5;
|
|
|
|
|
|
|
|
if ( defined( 'DISABLE_WP_CRON' ) && DISABLE_WP_CRON ) {
|
|
|
|
$number = 50;
|
|
|
|
}
|
|
|
|
|
2024-10-09 12:44:17 +00:00
|
|
|
/**
|
|
|
|
* Filter the number of followers to clean up.
|
|
|
|
*
|
|
|
|
* @param int $number The number of followers to clean up.
|
|
|
|
*/
|
2024-03-28 09:39:50 +00:00
|
|
|
$number = apply_filters( 'activitypub_update_followers_number', $number );
|
2023-10-22 22:20:53 +00:00
|
|
|
$followers = Followers::get_faulty_followers( $number );
|
|
|
|
|
|
|
|
foreach ( $followers as $follower ) {
|
|
|
|
$meta = get_remote_metadata_by_actor( $follower->get_url(), false );
|
|
|
|
|
|
|
|
if ( is_tombstone( $meta ) ) {
|
|
|
|
$follower->delete();
|
|
|
|
} elseif ( empty( $meta ) || ! is_array( $meta ) || is_wp_error( $meta ) ) {
|
|
|
|
if ( $follower->count_errors() >= 5 ) {
|
|
|
|
$follower->delete();
|
2024-05-09 15:26:55 +00:00
|
|
|
\wp_schedule_single_event(
|
|
|
|
\time(),
|
|
|
|
'activitypub_delete_actor_interactions',
|
|
|
|
array( $follower->get_id() )
|
|
|
|
);
|
2023-10-22 22:20:53 +00:00
|
|
|
} else {
|
|
|
|
Followers::add_error( $follower->get__id(), $meta );
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
$follower->reset_errors();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2024-02-08 12:31:25 +00:00
|
|
|
/**
|
|
|
|
* Send a profile update when relevant user meta is updated.
|
|
|
|
*
|
2024-10-09 12:44:17 +00:00
|
|
|
* @param int $meta_id Meta ID being updated.
|
|
|
|
* @param int $user_id User ID being updated.
|
2024-02-08 12:31:25 +00:00
|
|
|
* @param string $meta_key Meta key being updated.
|
|
|
|
*/
|
|
|
|
public static function user_meta_update( $meta_id, $user_id, $meta_key ) {
|
2024-10-09 12:44:17 +00:00
|
|
|
// Don't bother if the user can't publish.
|
2024-04-19 10:49:31 +00:00
|
|
|
if ( ! \user_can( $user_id, 'activitypub' ) ) {
|
2024-02-08 12:31:25 +00:00
|
|
|
return;
|
|
|
|
}
|
2024-10-09 12:44:17 +00:00
|
|
|
|
|
|
|
// The user meta fields that affect a profile.
|
2024-02-08 12:31:25 +00:00
|
|
|
$fields = array(
|
2024-10-09 12:44:17 +00:00
|
|
|
'activitypub_description',
|
|
|
|
'activitypub_header_image',
|
2024-02-08 12:31:25 +00:00
|
|
|
'description',
|
|
|
|
'user_url',
|
|
|
|
'display_name',
|
|
|
|
);
|
|
|
|
if ( in_array( $meta_key, $fields, true ) ) {
|
|
|
|
self::schedule_profile_update( $user_id );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Send a profile update when a user is updated.
|
|
|
|
*
|
2024-10-09 12:44:17 +00:00
|
|
|
* @param int $user_id User ID being updated.
|
2024-02-08 12:31:25 +00:00
|
|
|
*/
|
|
|
|
public static function user_update( $user_id ) {
|
2024-10-09 12:44:17 +00:00
|
|
|
// Don't bother if the user can't publish.
|
2024-04-19 10:49:31 +00:00
|
|
|
if ( ! \user_can( $user_id, 'activitypub' ) ) {
|
2024-02-08 12:31:25 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
self::schedule_profile_update( $user_id );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Theme mods only have a dynamic filter so we fudge it like this.
|
2024-07-19 19:46:05 +00:00
|
|
|
*
|
2024-10-09 12:44:17 +00:00
|
|
|
* @param mixed $value Optional. The value to be updated. Default null.
|
2024-07-19 19:46:05 +00:00
|
|
|
*
|
2024-02-08 12:31:25 +00:00
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public static function blog_user_update( $value = null ) {
|
|
|
|
self::schedule_profile_update( 0 );
|
|
|
|
return $value;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Send a profile update to all followers. Gets hooked into all relevant options/meta etc.
|
2024-07-19 19:46:05 +00:00
|
|
|
*
|
2024-02-08 12:31:25 +00:00
|
|
|
* @param int $user_id The user ID to update (Could be 0 for Blog-User).
|
|
|
|
*/
|
|
|
|
public static function schedule_profile_update( $user_id ) {
|
|
|
|
\wp_schedule_single_event(
|
|
|
|
\time(),
|
|
|
|
'activitypub_send_update_profile_activity',
|
|
|
|
array( $user_id )
|
|
|
|
);
|
|
|
|
}
|
2023-10-22 22:20:53 +00:00
|
|
|
}
|