From cec4ed2e3f25913f36bb9043ef63a9fefe6c376a Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Thu, 4 May 2023 15:17:05 +0200 Subject: [PATCH 01/24] init follower update scheduler --- activitypub.php | 127 ++++++++++++++++----------------- includes/class-activitypub.php | 58 +++++++++++++++ 2 files changed, 120 insertions(+), 65 deletions(-) diff --git a/activitypub.php b/activitypub.php index d61af85..1e0d44b 100644 --- a/activitypub.php +++ b/activitypub.php @@ -29,67 +29,66 @@ function init() { \define( 'ACTIVITYPUB_PLUGIN_BASENAME', plugin_basename( __FILE__ ) ); \define( 'ACTIVITYPUB_PLUGIN_FILE', plugin_dir_path( __FILE__ ) . '/' . basename( __FILE__ ) ); - require_once \dirname( __FILE__ ) . '/includes/table/followers-list.php'; - require_once \dirname( __FILE__ ) . '/includes/class-signature.php'; - require_once \dirname( __FILE__ ) . '/includes/class-webfinger.php'; - require_once \dirname( __FILE__ ) . '/includes/peer/class-followers.php'; - require_once \dirname( __FILE__ ) . '/includes/functions.php'; + \define( 'ACTIVITYPUB_OBJECT', 'ACTIVITYPUB_OBJECT' ); - require_once \dirname( __FILE__ ) . '/includes/model/class-activity.php'; - require_once \dirname( __FILE__ ) . '/includes/model/class-post.php'; - - require_once \dirname( __FILE__ ) . '/includes/class-activity-dispatcher.php'; + Migration::init(); Activity_Dispatcher::init(); - - require_once \dirname( __FILE__ ) . '/includes/class-activitypub.php'; Activitypub::init(); + Collection\Followers::init(); // Configure the REST API route - require_once \dirname( __FILE__ ) . '/includes/rest/class-outbox.php'; Rest\Outbox::init(); - - require_once \dirname( __FILE__ ) . '/includes/rest/class-inbox.php'; Rest\Inbox::init(); - - require_once \dirname( __FILE__ ) . '/includes/rest/class-followers.php'; Rest\Followers::init(); - - require_once \dirname( __FILE__ ) . '/includes/rest/class-following.php'; Rest\Following::init(); - - require_once \dirname( __FILE__ ) . '/includes/rest/class-webfinger.php'; Rest\Webfinger::init(); - // load NodeInfo endpoints only if blog is public - if ( true === (bool) \get_option( 'blog_public', 1 ) ) { - require_once \dirname( __FILE__ ) . '/includes/rest/class-nodeinfo.php'; - Rest\NodeInfo::init(); - } - - require_once \dirname( __FILE__ ) . '/includes/class-admin.php'; Admin::init(); - - require_once \dirname( __FILE__ ) . '/includes/class-hashtag.php'; Hashtag::init(); - - require_once \dirname( __FILE__ ) . '/includes/class-shortcodes.php'; Shortcodes::init(); - - require_once \dirname( __FILE__ ) . '/includes/class-mention.php'; Mention::init(); - - require_once \dirname( __FILE__ ) . '/includes/class-debug.php'; Debug::init(); - - require_once \dirname( __FILE__ ) . '/includes/class-health-check.php'; Health_Check::init(); - - if ( \WP_DEBUG ) { - require_once \dirname( __FILE__ ) . '/includes/debug.php'; - } } \add_action( 'plugins_loaded', '\Activitypub\init' ); +spl_autoload_register( + function ( $class ) { + $base_dir = trailingslashit( __DIR__ ) . 'includes' . DIRECTORY_SEPARATOR; + $base = 'activitypub'; + + $class = strtolower( $class ); + + if ( strncmp( $class, $base, strlen( $base ) ) === 0 ) { + $class = str_replace( 'activitypub\\', '', $class ); + + if ( strpos( $class, '\\' ) ) { + list( $sub_dir, $class ) = explode( '\\', $class ); + $base_dir = $base_dir . $sub_dir . DIRECTORY_SEPARATOR; + } + + $filename = 'class-' . str_replace( '_', '-', $class ); + $file = $base_dir . $filename . '.php'; + + if ( file_exists( $file ) ) { + require_once $file; + } + } + } +); + +require_once \dirname( __FILE__ ) . '/includes/functions.php'; + +// load NodeInfo endpoints only if blog is public +if ( true === (bool) \get_option( 'blog_public', 1 ) ) { + require_once \dirname( __FILE__ ) . '/includes/rest/class-nodeinfo.php'; + Rest\NodeInfo::init(); +} + +if ( \WP_DEBUG ) { + require_once \dirname( __FILE__ ) . '/includes/debug.php'; +} + /** * Add plugin settings link */ @@ -102,34 +101,32 @@ function plugin_settings_link( $actions ) { return \array_merge( $settings_link, $actions ); } -\add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), '\Activitypub\plugin_settings_link' ); +\add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), __NAMESPACE__ . '\plugin_settings_link' ); -/** - * Add rewrite rules - */ -function add_rewrite_rules() { - if ( ! \class_exists( 'Webfinger' ) ) { - \add_rewrite_rule( '^.well-known/webfinger', 'index.php?rest_route=/activitypub/1.0/webfinger', 'top' ); - } +\register_activation_hook( + __FILE__, + array( + __NAMESPACE__ . '\Activitypub', + 'activate', + ) +); - if ( ! \class_exists( 'Nodeinfo' ) || ! (bool) \get_option( 'blog_public', 1 ) ) { - \add_rewrite_rule( '^.well-known/nodeinfo', 'index.php?rest_route=/activitypub/1.0/nodeinfo/discovery', 'top' ); - \add_rewrite_rule( '^.well-known/x-nodeinfo2', 'index.php?rest_route=/activitypub/1.0/nodeinfo2', 'top' ); - } +\register_deactivation_hook( + __FILE__, + array( + __NAMESPACE__ . '\Activitypub', + 'deactivate', + ) +); - \add_rewrite_endpoint( 'activitypub', EP_AUTHORS | EP_PERMALINK | EP_PAGES ); -} -\add_action( 'init', '\Activitypub\add_rewrite_rules', 1 ); +register_uninstall_hook( + __FILE__, + array( + __NAMESPACE__ . '\Activitypub', + 'uninstall', + ) +); -/** - * Flush rewrite rules; - */ -function flush_rewrite_rules() { - \Activitypub\add_rewrite_rules(); - \flush_rewrite_rules(); -} -\register_activation_hook( __FILE__, '\Activitypub\flush_rewrite_rules' ); -\register_deactivation_hook( __FILE__, '\flush_rewrite_rules' ); /** * Only load code that needs BuddyPress to run once BP is loaded and initialized. diff --git a/includes/class-activitypub.php b/includes/class-activitypub.php index 16a1f22..fd5aa1e 100644 --- a/includes/class-activitypub.php +++ b/includes/class-activitypub.php @@ -25,6 +25,40 @@ class Activitypub { \add_action( 'transition_post_status', array( self::class, 'schedule_post_activity' ), 33, 3 ); \add_action( 'wp_trash_post', array( self::class, 'trash_post' ), 1 ); \add_action( 'untrash_post', array( self::class, 'untrash_post' ), 1 ); + + \add_action( 'init', array( self::class, 'add_rewrite_rules' ) ); + } + + /** + * Activation Hook + * + * @return void + */ + public static function activate() { + self::flush_rewrite_rules(); + + if ( ! \wp_next_scheduled( 'activitypub_update_followers' ) ) { + \wp_schedule_event( time(), 'hourly', 'activitypub_update_followers' ); + } + } + + /** + * Deactivation Hook + * + * @return void + */ + public static function deactivate() { + self::flush_rewrite_rules(); + + wp_unschedule_hook( 'activitypub_update_followers' ); + } + + /** + * Uninstall Hook + * + * @return void + */ + public static function uninstall() { } /** @@ -204,4 +238,28 @@ class Activitypub { public static function untrash_post( $post_id ) { \delete_post_meta( $post_id, 'activitypub_canonical_url' ); } + + /** + * Add rewrite rules + */ + public static function add_rewrite_rules() { + if ( ! \class_exists( 'Webfinger' ) ) { + \add_rewrite_rule( '^.well-known/webfinger', 'index.php?rest_route=/activitypub/1.0/webfinger', 'top' ); + } + + if ( ! \class_exists( 'Nodeinfo' ) || (bool) \get_option( 'blog_public', 1 ) ) { + \add_rewrite_rule( '^.well-known/nodeinfo', 'index.php?rest_route=/activitypub/1.0/nodeinfo/discovery', 'top' ); + \add_rewrite_rule( '^.well-known/x-nodeinfo2', 'index.php?rest_route=/activitypub/1.0/nodeinfo2', 'top' ); + } + + \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(); + } } From 0fd11d25faf053807f3eab309e78b848ebfde02c Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Thu, 4 May 2023 15:18:58 +0200 Subject: [PATCH 02/24] will be auto-loaded --- activitypub.php | 1 - 1 file changed, 1 deletion(-) diff --git a/activitypub.php b/activitypub.php index 0db8e51..e06e6f6 100644 --- a/activitypub.php +++ b/activitypub.php @@ -81,7 +81,6 @@ require_once \dirname( __FILE__ ) . '/includes/functions.php'; // load NodeInfo endpoints only if blog is public if ( true === (bool) \get_option( 'blog_public', 1 ) ) { - require_once \dirname( __FILE__ ) . '/includes/rest/class-nodeinfo.php'; Rest\NodeInfo::init(); } From 77112c441ffd6d107653b2fdf77d04bb084f81c5 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Fri, 5 May 2023 09:57:47 +0200 Subject: [PATCH 03/24] formatting --- activitypub.php | 3 ++ includes/class-activitypub.php | 57 +++++++++++++++++++++++++++++----- 2 files changed, 52 insertions(+), 8 deletions(-) diff --git a/activitypub.php b/activitypub.php index e06e6f6..0db3c32 100644 --- a/activitypub.php +++ b/activitypub.php @@ -52,6 +52,9 @@ function init() { } \add_action( 'plugins_loaded', '\Activitypub\init' ); +/** + * Class Autoloader + */ spl_autoload_register( function ( $class ) { $base_dir = trailingslashit( __DIR__ ) . 'includes' . DIRECTORY_SEPARATOR; diff --git a/includes/class-activitypub.php b/includes/class-activitypub.php index fd5aa1e..9739b6c 100644 --- a/includes/class-activitypub.php +++ b/includes/class-activitypub.php @@ -40,6 +40,10 @@ class Activitypub { 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' ); + } } /** @@ -51,6 +55,7 @@ class Activitypub { self::flush_rewrite_rules(); wp_unschedule_hook( 'activitypub_update_followers' ); + wp_unschedule_hook( 'activitypub_cleanup_followers' ); } /** @@ -154,11 +159,23 @@ class Activitypub { $activitypub_post = new \Activitypub\Model\Post( $post ); if ( 'publish' === $new_status && 'publish' !== $old_status ) { - \wp_schedule_single_event( \time(), 'activitypub_send_create_activity', array( $activitypub_post ) ); + \wp_schedule_single_event( + \time(), + 'activitypub_send_create_activity', + array( $activitypub_post ) + ); } elseif ( 'publish' === $new_status ) { - \wp_schedule_single_event( \time(), 'activitypub_send_update_activity', array( $activitypub_post ) ); + \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 ) ); + \wp_schedule_single_event( + \time(), + 'activitypub_send_delete_activity', + array( $activitypub_post ) + ); } } @@ -180,7 +197,14 @@ class Activitypub { } $allowed_comment_types = \apply_filters( 'get_avatar_comment_types', array( 'comment' ) ); - if ( ! empty( $id_or_email->comment_type ) && ! \in_array( $id_or_email->comment_type, (array) $allowed_comment_types, true ) ) { + 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 ); @@ -225,7 +249,12 @@ class Activitypub { * @return void */ public static function trash_post( $post_id ) { - \add_post_meta( $post_id, 'activitypub_canonical_url', \get_permalink( $post_id ), true ); + \add_post_meta( + $post_id, + 'activitypub_canonical_url', + \get_permalink( $post_id ), + true + ); } /** @@ -244,12 +273,24 @@ class Activitypub { */ public static function add_rewrite_rules() { if ( ! \class_exists( 'Webfinger' ) ) { - \add_rewrite_rule( '^.well-known/webfinger', 'index.php?rest_route=/activitypub/1.0/webfinger', 'top' ); + \add_rewrite_rule( + '^.well-known/webfinger', + 'index.php?rest_route=/activitypub/1.0/webfinger', + 'top' + ); } if ( ! \class_exists( 'Nodeinfo' ) || (bool) \get_option( 'blog_public', 1 ) ) { - \add_rewrite_rule( '^.well-known/nodeinfo', 'index.php?rest_route=/activitypub/1.0/nodeinfo/discovery', 'top' ); - \add_rewrite_rule( '^.well-known/x-nodeinfo2', 'index.php?rest_route=/activitypub/1.0/nodeinfo2', 'top' ); + \add_rewrite_rule( + '^.well-known/nodeinfo', + 'index.php?rest_route=/activitypub/1.0/nodeinfo/discovery', + 'top' + ); + \add_rewrite_rule( + '^.well-known/x-nodeinfo2', + 'index.php?rest_route=/activitypub/1.0/nodeinfo2', + 'top' + ); } \add_rewrite_endpoint( 'activitypub', EP_AUTHORS | EP_PERMALINK | EP_PAGES ); From 6d96daa635bd505df7843e69153a05eaaa40c4c5 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Mon, 8 May 2023 21:05:20 +0200 Subject: [PATCH 04/24] fix NodeInfo check --- includes/class-activitypub.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/class-activitypub.php b/includes/class-activitypub.php index 9739b6c..417aa29 100644 --- a/includes/class-activitypub.php +++ b/includes/class-activitypub.php @@ -280,7 +280,7 @@ class Activitypub { ); } - if ( ! \class_exists( 'Nodeinfo' ) || (bool) \get_option( 'blog_public', 1 ) ) { + if ( ! \class_exists( 'Nodeinfo' ) && true === (bool) \get_option( 'blog_public', 1 ) ) { \add_rewrite_rule( '^.well-known/nodeinfo', 'index.php?rest_route=/activitypub/1.0/nodeinfo/discovery', From f64a765129dadb137b541d5babab7cf36a542159 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Tue, 9 May 2023 10:08:51 +0200 Subject: [PATCH 05/24] phpdoc fixes --- includes/collection/class-followers.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/includes/collection/class-followers.php b/includes/collection/class-followers.php index c6c6223..1868bba 100644 --- a/includes/collection/class-followers.php +++ b/includes/collection/class-followers.php @@ -186,7 +186,7 @@ class Followers { } /** - * Handles "Unfollow" requests + * Handle "Unfollow" requests * * @param array $object The JSON "Undo" Activity * @param int $user_id The ID of the ID of the WordPress User @@ -202,7 +202,7 @@ class Followers { } /** - * Add a new Follower + * Add new Follower * * @param int $user_id The ID of the WordPress User * @param string $actor The Actor URL From 17b66cb23d88b2ad0cbaf75606bf062f33a5d5e8 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Wed, 10 May 2023 14:18:56 +0200 Subject: [PATCH 06/24] implement `cleanup_followers` and `update_followers` --- activitypub.php | 1 + includes/class-activitypub.php | 54 +------- includes/class-migration.php | 10 +- includes/class-scheduler.php | 126 ++++++++++++++++++ includes/class-shortcodes.php | 8 +- includes/collection/class-followers.php | 78 +++++++++++ includes/model/class-follower.php | 8 ++ tests/test-class-db-activitypub-followers.php | 54 ++++++++ 8 files changed, 281 insertions(+), 58 deletions(-) create mode 100644 includes/class-scheduler.php diff --git a/activitypub.php b/activitypub.php index 0db3c32..4fbe2fe 100644 --- a/activitypub.php +++ b/activitypub.php @@ -49,6 +49,7 @@ function init() { Mention::init(); Debug::init(); Health_Check::init(); + Scheduler::init(); } \add_action( 'plugins_loaded', '\Activitypub\init' ); diff --git a/includes/class-activitypub.php b/includes/class-activitypub.php index 417aa29..37bedf4 100644 --- a/includes/class-activitypub.php +++ b/includes/class-activitypub.php @@ -22,7 +22,6 @@ class Activitypub { \add_post_type_support( $post_type, 'activitypub' ); } - \add_action( 'transition_post_status', array( self::class, 'schedule_post_activity' ), 33, 3 ); \add_action( 'wp_trash_post', array( self::class, 'trash_post' ), 1 ); \add_action( 'untrash_post', array( self::class, 'untrash_post' ), 1 ); @@ -37,13 +36,7 @@ class Activitypub { public static function activate() { self::flush_rewrite_rules(); - 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' ); - } + Scheduler::register_schedules(); } /** @@ -54,8 +47,7 @@ class Activitypub { public static function deactivate() { self::flush_rewrite_rules(); - wp_unschedule_hook( 'activitypub_update_followers' ); - wp_unschedule_hook( 'activitypub_cleanup_followers' ); + Scheduler::deregister_schedules(); } /** @@ -137,48 +129,6 @@ class Activitypub { return $vars; } - /** - * 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_create_activity', - array( $activitypub_post ) - ); - } elseif ( 'publish' === $new_status ) { - \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 ) - ); - } - } - /** * Replaces the default avatar. * diff --git a/includes/class-migration.php b/includes/class-migration.php index 1e8c44b..e6e6fba 100644 --- a/includes/class-migration.php +++ b/includes/class-migration.php @@ -3,7 +3,15 @@ namespace Activitypub; use Acctivitypub\Model\Follower; +/** + * ActivityPub Migration Class + * + * @author Matthias Pfefferle + */ class Migration { + /** + * Initialize the class, registering WordPress hooks + */ public static function init() { \add_action( 'activitypub_schedule_migration', array( self::class, 'maybe_migrate' ) ); } @@ -59,7 +67,7 @@ class Migration { $followers = get_user_meta( $user_id, 'activitypub_followers', true ); if ( $followers ) { - foreach ( $followers as $follower ) { + foreach ( $followers as $actor ) { $meta = get_remote_metadata_by_actor( $actor ); $follower = new Follower( $actor ); diff --git a/includes/class-scheduler.php b/includes/class-scheduler.php new file mode 100644 index 0000000..4291365 --- /dev/null +++ b/includes/class-scheduler.php @@ -0,0 +1,126 @@ +post_type, $post_types, true ) ) { + return; + } + + $activitypub_post = new Post( $post ); + + if ( 'publish' === $new_status && 'publish' !== $old_status ) { + \wp_schedule_single_event( + \time(), + 'activitypub_send_create_activity', + array( $activitypub_post ) + ); + } elseif ( 'publish' === $new_status ) { + \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 ) + ); + } + } + + /** + * Update followers + * + * @return void + */ + public static function update_followers() { + $followers = Followers::get_outdated_followers( ACTIVITYPUB_OBJECT ); + + foreach ( $followers as $follower ) { + $meta = get_remote_metadata_by_actor( $follower->get_actor() ); + + if ( empty( $meta ) || ! is_array( $meta ) || is_wp_error( $meta ) ) { + $follower->set_error( $meta ); + } else { + $follower->from_meta( $meta ); + } + + $follower->update(); + } + } + + /** + * Cleanup followers + * + * @return void + */ + public static function cleanup_followers() { + $followers = Followers::get_faulty_followers( ACTIVITYPUB_OBJECT ); + + foreach ( $followers as $follower ) { + $meta = get_remote_metadata_by_actor( $follower->get_actor() ); + + if ( empty( $meta ) || ! is_array( $meta ) || is_wp_error( $meta ) ) { + if ( 5 >= $follower->count_errors() ) { + $follower->delete(); + } else { + $follower->set_error( $meta ); + $follower->update(); + } + } else { + $follower->reset_errors(); + } + } + } +} diff --git a/includes/class-shortcodes.php b/includes/class-shortcodes.php index 7289808..f56d483 100644 --- a/includes/class-shortcodes.php +++ b/includes/class-shortcodes.php @@ -3,14 +3,12 @@ namespace Activitypub; class Shortcodes { /** - * Class constructor, registering WordPress then shortcodes - * - * @param WP_Post $post A WordPress Post Object + * Initialize the class, registering WordPress hooks */ public static function init() { - foreach ( get_class_methods( 'Activitypub\Shortcodes' ) as $shortcode ) { + foreach ( get_class_methods( self::class ) as $shortcode ) { if ( 'init' !== $shortcode ) { - add_shortcode( 'ap_' . $shortcode, array( 'Activitypub\Shortcodes', $shortcode ) ); + add_shortcode( 'ap_' . $shortcode, array( self::class, $shortcode ) ); } } } diff --git a/includes/collection/class-followers.php b/includes/collection/class-followers.php index 1868bba..0fa4a6a 100644 --- a/includes/collection/class-followers.php +++ b/includes/collection/class-followers.php @@ -404,4 +404,82 @@ class Followers { return array_filter( $results ); } + + /** + * Undocumented function + * + * @return void + */ + public static function get_outdated_followers( $output = ARRAY_N, $number = 50, $older_than = 604800 ) { + $args = array( + 'taxonomy' => self::TAXONOMY, + 'number' => $number, + 'meta_key' => 'updated_at', + 'orderby' => 'meta_value_num', + 'order' => 'DESC', + 'meta_query' => array( + array( + 'key' => 'updated_at', + 'value' => strtotime( 'now' ) - $older_than, + 'type' => 'numeric', + 'compare' => '<=', + ), + ), + ); + + $terms = new WP_Term_Query( $args ); + + $items = array(); + + // change output format + switch ( $output ) { + case ACTIVITYPUB_OBJECT: + foreach ( $terms->get_terms() as $follower ) { + $items[] = new Follower( $follower->name ); // phpcs:ignore + } + return $items; + case OBJECT: + return $terms->get_terms(); + case ARRAY_N: + default: + foreach ( $terms->get_terms() as $follower ) { + $items[] = $follower->name; // phpcs:ignore + } + return $items; + } + } + + public static function get_faulty_followers( $output = ARRAY_N, $number = 10 ) { + $args = array( + 'taxonomy' => self::TAXONOMY, + 'number' => $number, + 'meta_query' => array( + array( + 'key' => 'errors', + 'compare' => 'EXISTS', + ), + ), + ); + + $terms = new WP_Term_Query( $args ); + + $items = array(); + + // change output format + switch ( $output ) { + case ACTIVITYPUB_OBJECT: + foreach ( $terms->get_terms() as $follower ) { + $items[] = new Follower( $follower->name ); // phpcs:ignore + } + return $items; + case OBJECT: + return $terms->get_terms(); + case ARRAY_N: + default: + foreach ( $terms->get_terms() as $follower ) { + $items[] = $follower->name; // phpcs:ignore + } + return $items; + } + } } diff --git a/includes/model/class-follower.php b/includes/model/class-follower.php index 3a15690..2b152f1 100644 --- a/includes/model/class-follower.php +++ b/includes/model/class-follower.php @@ -210,6 +210,10 @@ class Follower { return $this->errors; } + public function reset_errors() { + delete_term_meta( $this->id, 'errors' ); + } + public function count_errors() { $errors = $this->get_errors(); @@ -292,6 +296,10 @@ class Follower { } } + public function delete() { + wp_delete_term( $this->id, Followers::TAXONOMY ); + } + protected function update_term_meta() { $attributes = array( 'inbox', 'shared_inbox', 'avatar', 'updated_at', 'name', 'username' ); diff --git a/tests/test-class-db-activitypub-followers.php b/tests/test-class-db-activitypub-followers.php index 640c4d1..cf8b53f 100644 --- a/tests/test-class-db-activitypub-followers.php +++ b/tests/test-class-db-activitypub-followers.php @@ -90,6 +90,60 @@ class Test_Db_Activitypub_Followers extends WP_UnitTestCase { $this->assertNull( $follower ); } + public function test_get_outdated_followers() { + $followers = array( 'https://example.com/author/jon', 'https://example.org/author/doe', 'http://sally.example.org' ); + + $pre_http_request = new MockAction(); + add_filter( 'pre_http_request', array( $pre_http_request, 'filter' ), 10, 3 ); + + foreach ( $followers as $follower ) { + \Activitypub\Collection\Followers::add_follower( 1, $follower ); + } + + $follower = new \Activitypub\Model\Follower( 'https://example.com/author/jon' ); + + update_term_meta( $follower->get_id(), 'updated_at', strtotime( 'now' ) - 804800 ); + + $followers = \Activitypub\Collection\Followers::get_outdated_followers(); + $this->assertEquals( 1, count( $followers ) ); + $this->assertEquals( 'https://example.com/author/jon', $followers[0] ); + } + + public function test_get_faulty_followers() { + $followers = array( 'https://example.com/author/jon', 'https://example.org/author/doe', 'http://sally.example.org' ); + + $pre_http_request = new MockAction(); + add_filter( 'pre_http_request', array( $pre_http_request, 'filter' ), 10, 3 ); + + foreach ( $followers as $follower ) { + \Activitypub\Collection\Followers::add_follower( 1, $follower ); + } + + $follower = new \Activitypub\Model\Follower( 'http://sally.example.org' ); + + for ( $i = 1; $i <= 15; $i++ ) { + add_term_meta( $follower->get_id(), 'errors', 'error ' . $i ); + } + + $follower = new \Activitypub\Model\Follower( 'http://sally.example.org' ); + $count = $follower->count_errors(); + + $followers = \Activitypub\Collection\Followers::get_faulty_followers(); + + $this->assertEquals( 1, count( $followers ) ); + $this->assertEquals( 'http://sally.example.org', $followers[0] ); + + $follower->reset_errors(); + + $follower = new \Activitypub\Model\Follower( 'http://sally.example.org' ); + $count = $follower->count_errors(); + + $followers = \Activitypub\Collection\Followers::get_faulty_followers(); + + $this->assertEquals( 0, count( $followers ) ); + } + + public static function http_request_host_is_external( $in, $host ) { if ( in_array( $host, array( 'example.com', 'example.org' ), true ) ) { return true; From 2570928b00d9c6ff8d05b427f45a1a76684a51e9 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Wed, 10 May 2023 14:55:10 +0200 Subject: [PATCH 07/24] PHPDoc --- includes/class-scheduler.php | 10 ++++++++++ includes/collection/class-followers.php | 16 ++++++++++++++-- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/includes/class-scheduler.php b/includes/class-scheduler.php index 4291365..0373c3f 100644 --- a/includes/class-scheduler.php +++ b/includes/class-scheduler.php @@ -21,6 +21,11 @@ class Scheduler { \add_action( 'activitypub_cleanup_followers', array( self::class, 'cleanup_followers' ) ); } + /** + * Schedule all ActivityPub schedules. + * + * @return void + */ public static function register_schedules() { if ( ! \wp_next_scheduled( 'activitypub_update_followers' ) ) { \wp_schedule_event( time(), 'hourly', 'activitypub_update_followers' ); @@ -31,6 +36,11 @@ class Scheduler { } } + /** + * Unscedule all ActivityPub schedules. + * + * @return void + */ public static function deregister_schedules() { wp_unschedule_hook( 'activitypub_update_followers' ); wp_unschedule_hook( 'activitypub_cleanup_followers' ); diff --git a/includes/collection/class-followers.php b/includes/collection/class-followers.php index 0fa4a6a..1d54fa2 100644 --- a/includes/collection/class-followers.php +++ b/includes/collection/class-followers.php @@ -406,9 +406,13 @@ class Followers { } /** - * Undocumented function + * Get all Followers that have not been updated for a given time * - * @return void + * @param enum $output The output format, supported ARRAY_N, OBJECT and ACTIVITYPUB_OBJECT. + * @param int $number Limits the result. + * @param int $older_than The time in seconds. + * + * @return mixed The Term list of Followers, the format depends on $output. */ public static function get_outdated_followers( $output = ARRAY_N, $number = 50, $older_than = 604800 ) { $args = array( @@ -449,6 +453,14 @@ class Followers { } } + /** + * Get all Followers that had errors + * + * @param enum $output The output format, supported ARRAY_N, OBJECT and ACTIVITYPUB_OBJECT + * @param integer $number The number of Followers to return. + * + * @return mixed The Term list of Followers, the format depends on $output. + */ public static function get_faulty_followers( $output = ARRAY_N, $number = 10 ) { $args = array( 'taxonomy' => self::TAXONOMY, From df02d2202e0492efee9acbc028dfe0135db00cd0 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Wed, 10 May 2023 15:02:01 +0200 Subject: [PATCH 08/24] PHPDoc --- includes/model/class-follower.php | 76 +++++++++++++++++++++++++++++-- 1 file changed, 73 insertions(+), 3 deletions(-) diff --git a/includes/model/class-follower.php b/includes/model/class-follower.php index 2b152f1..10200c2 100644 --- a/includes/model/class-follower.php +++ b/includes/model/class-follower.php @@ -139,8 +139,8 @@ class Follower { /** * Magic function to implement getter and setter * - * @param string $method - * @param string $params + * @param string $method The method name. + * @param string $params The method params. * * @return void */ @@ -159,6 +159,13 @@ class Follower { } } + /** + * Prefill the Object with the meta data. + * + * @param array $meta The meta data. + * + * @return void + */ public function from_meta( $meta ) { $this->meta = $meta; @@ -181,6 +188,13 @@ class Follower { $this->updated_at = \strtotime( 'now' ); } + /** + * Get the data by the given attribute + * + * @param string $attribute The attribute name. + * + * @return mixed The attribute value. + */ public function get( $attribute ) { if ( $this->$attribute ) { return $this->$attribute; @@ -201,6 +215,11 @@ class Follower { return null; } + /** + * Get the errors. + * + * @return mixed + */ public function get_errors() { if ( $this->errors ) { return $this->errors; @@ -210,10 +229,20 @@ class Follower { return $this->errors; } + /** + * Reset (delete) all errors. + * + * @return void + */ public function reset_errors() { delete_term_meta( $this->id, 'errors' ); } + /** + * Count the errors. + * + * @return int The number of errors. + */ public function count_errors() { $errors = $this->get_errors(); @@ -224,6 +253,11 @@ class Follower { return 0; } + /** + * Return the latest error message. + * + * @return string The error message. + */ public function get_latest_error_message() { $errors = $this->get_errors(); @@ -234,6 +268,13 @@ class Follower { return ''; } + /** + * Get the meta data by the given attribute. + * + * @param string $attribute The attribute name. + * + * @return mixed $attribute The attribute value. + */ public function get_meta_by( $attribute ) { $meta = $this->get_meta(); @@ -252,6 +293,11 @@ class Follower { return null; } + /** + * Get the meta data. + * + * @return array $meta The meta data. + */ public function get_meta() { if ( $this->meta ) { return $this->meta; @@ -260,6 +306,11 @@ class Follower { return null; } + /** + * Update the current Follower-Object. + * + * @return void + */ public function update() { $term = wp_update_term( $this->id, @@ -273,6 +324,11 @@ class Follower { $this->update_term_meta(); } + /** + * Save the current Follower-Object. + * + * @return void + */ public function save() { $term = wp_insert_term( $this->actor, @@ -288,6 +344,11 @@ class Follower { $this->update_term_meta(); } + /** + * Upsert the current Follower-Object. + * + * @return void + */ public function upsert() { if ( $this->id ) { $this->update(); @@ -296,10 +357,20 @@ class Follower { } } + /** + * Delete the current Follower-Object. + * + * @return void + */ public function delete() { wp_delete_term( $this->id, Followers::TAXONOMY ); } + /** + * Update the term meta. + * + * @return void + */ protected function update_term_meta() { $attributes = array( 'inbox', 'shared_inbox', 'avatar', 'updated_at', 'name', 'username' ); @@ -320,6 +391,5 @@ class Follower { add_term_meta( $this->id, 'errors', $error ); } - } } From 463bff834b3c845ff6ab10acdad51c9d37f29cfe Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Wed, 10 May 2023 17:21:59 +0200 Subject: [PATCH 09/24] delete if response code is 410 or 404 --- includes/class-scheduler.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/includes/class-scheduler.php b/includes/class-scheduler.php index 0373c3f..0a7bba7 100644 --- a/includes/class-scheduler.php +++ b/includes/class-scheduler.php @@ -121,7 +121,9 @@ class Scheduler { foreach ( $followers as $follower ) { $meta = get_remote_metadata_by_actor( $follower->get_actor() ); - if ( empty( $meta ) || ! is_array( $meta ) || is_wp_error( $meta ) ) { + if ( is_tombstone( $meta ) ) { + $follower->delete(); + } elseif ( empty( $meta ) || ! is_array( $meta ) || is_wp_error( $meta ) ) { if ( 5 >= $follower->count_errors() ) { $follower->delete(); } else { From 9da559be6aee7ae2fca88122b15dc05a899f0ad1 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Wed, 10 May 2023 18:45:32 +0200 Subject: [PATCH 10/24] Update includes/collection/class-followers.php Co-authored-by: Alex Kirk --- includes/collection/class-followers.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/collection/class-followers.php b/includes/collection/class-followers.php index 1d54fa2..0948bfb 100644 --- a/includes/collection/class-followers.php +++ b/includes/collection/class-followers.php @@ -424,7 +424,7 @@ class Followers { 'meta_query' => array( array( 'key' => 'updated_at', - 'value' => strtotime( 'now' ) - $older_than, + 'value' => time() - $older_than, 'type' => 'numeric', 'compare' => '<=', ), From 3c027449257186cbe3306cf92584349b283fa410 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Wed, 10 May 2023 18:45:48 +0200 Subject: [PATCH 11/24] Update activitypub.php Co-authored-by: Alex Kirk --- activitypub.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/activitypub.php b/activitypub.php index 4fbe2fe..598f03a 100644 --- a/activitypub.php +++ b/activitypub.php @@ -66,7 +66,7 @@ spl_autoload_register( if ( strncmp( $class, $base, strlen( $base ) ) === 0 ) { $class = str_replace( 'activitypub\\', '', $class ); - if ( strpos( $class, '\\' ) ) { + if ( false !== strpos( $class, '\\' ) ) { list( $sub_dir, $class ) = explode( '\\', $class ); $base_dir = $base_dir . $sub_dir . DIRECTORY_SEPARATOR; } From 6fce2c30d2416159e98fe08f6b05b52ee1ed93a2 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Wed, 10 May 2023 18:47:46 +0200 Subject: [PATCH 12/24] Update includes/class-scheduler.php Co-authored-by: Alex Kirk --- includes/class-scheduler.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/class-scheduler.php b/includes/class-scheduler.php index 0a7bba7..4bfb8b8 100644 --- a/includes/class-scheduler.php +++ b/includes/class-scheduler.php @@ -124,7 +124,7 @@ class Scheduler { if ( is_tombstone( $meta ) ) { $follower->delete(); } elseif ( empty( $meta ) || ! is_array( $meta ) || is_wp_error( $meta ) ) { - if ( 5 >= $follower->count_errors() ) { + if ( 5 <= $follower->count_errors() ) { $follower->delete(); } else { $follower->set_error( $meta ); From 75c1c6a402c605cac157cd95582e43004a898350 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Wed, 10 May 2023 18:50:20 +0200 Subject: [PATCH 13/24] Update activitypub.php Co-authored-by: Alex Kirk --- activitypub.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/activitypub.php b/activitypub.php index 598f03a..4d9b2e6 100644 --- a/activitypub.php +++ b/activitypub.php @@ -71,7 +71,7 @@ spl_autoload_register( $base_dir = $base_dir . $sub_dir . DIRECTORY_SEPARATOR; } - $filename = 'class-' . str_replace( '_', '-', $class ); + $filename = 'class-' . strtr( $class, '_', '-' ); $file = $base_dir . $filename . '.php'; if ( file_exists( $file ) ) { From 26a1dc9be5165b40369fba9acc36afd2ee1a4db1 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Wed, 10 May 2023 18:52:13 +0200 Subject: [PATCH 14/24] use time() instead of strtotime( 'now' ) --- includes/collection/class-followers.php | 2 +- includes/model/class-activity.php | 2 +- includes/model/class-follower.php | 4 ++-- tests/test-class-db-activitypub-followers.php | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/includes/collection/class-followers.php b/includes/collection/class-followers.php index 0948bfb..413af3b 100644 --- a/includes/collection/class-followers.php +++ b/includes/collection/class-followers.php @@ -143,7 +143,7 @@ class Followers { 'single' => true, 'sanitize_callback' => function( $value ) { if ( ! is_numeric( $value ) && (int) $value !== $value ) { - $value = strtotime( 'now' ); + $value = \time(); } return $value; diff --git a/includes/model/class-activity.php b/includes/model/class-activity.php index 34f6146..6a8d45a 100644 --- a/includes/model/class-activity.php +++ b/includes/model/class-activity.php @@ -44,7 +44,7 @@ class Activity { } $this->type = \ucfirst( $type ); - $this->published = \gmdate( 'Y-m-d\TH:i:s\Z', \strtotime( 'now' ) ); + $this->published = \gmdate( 'Y-m-d\TH:i:s\Z', \time() ); } public function __call( $method, $params ) { diff --git a/includes/model/class-follower.php b/includes/model/class-follower.php index 10200c2..0668e4d 100644 --- a/includes/model/class-follower.php +++ b/includes/model/class-follower.php @@ -185,7 +185,7 @@ class Follower { $this->shared_inbox = $meta['inbox']; } - $this->updated_at = \strtotime( 'now' ); + $this->updated_at = \time(); } /** @@ -320,7 +320,7 @@ class Follower { ) ); - $this->updated_at = \strtotime( 'now' ); + $this->updated_at = \time(); $this->update_term_meta(); } diff --git a/tests/test-class-db-activitypub-followers.php b/tests/test-class-db-activitypub-followers.php index cf8b53f..2467363 100644 --- a/tests/test-class-db-activitypub-followers.php +++ b/tests/test-class-db-activitypub-followers.php @@ -102,7 +102,7 @@ class Test_Db_Activitypub_Followers extends WP_UnitTestCase { $follower = new \Activitypub\Model\Follower( 'https://example.com/author/jon' ); - update_term_meta( $follower->get_id(), 'updated_at', strtotime( 'now' ) - 804800 ); + update_term_meta( $follower->get_id(), 'updated_at', \time() - 804800 ); $followers = \Activitypub\Collection\Followers::get_outdated_followers(); $this->assertEquals( 1, count( $followers ) ); From baa8027e3fe5e691b6197ab45fc6c07b10f48838 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Wed, 10 May 2023 18:53:09 +0200 Subject: [PATCH 15/24] check if file is_readable thanks @akirk --- activitypub.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/activitypub.php b/activitypub.php index 4d9b2e6..117b5cb 100644 --- a/activitypub.php +++ b/activitypub.php @@ -74,7 +74,7 @@ spl_autoload_register( $filename = 'class-' . strtr( $class, '_', '-' ); $file = $base_dir . $filename . '.php'; - if ( file_exists( $file ) ) { + if ( file_exists( $file ) && is_readable( $file ) ) { require_once $file; } } From 7b545b4639e3af5d49c4c432b98de2f8459460e1 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Thu, 11 May 2023 09:09:13 +0200 Subject: [PATCH 16/24] remove DIRECTORY_SEPARATOR because its not used anywhere else --- activitypub.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/activitypub.php b/activitypub.php index 117b5cb..0528965 100644 --- a/activitypub.php +++ b/activitypub.php @@ -58,7 +58,7 @@ function init() { */ spl_autoload_register( function ( $class ) { - $base_dir = trailingslashit( __DIR__ ) . 'includes' . DIRECTORY_SEPARATOR; + $base_dir = \dirname( __FILE__ ) . '/includes/'; $base = 'activitypub'; $class = strtolower( $class ); @@ -68,7 +68,7 @@ spl_autoload_register( if ( false !== strpos( $class, '\\' ) ) { list( $sub_dir, $class ) = explode( '\\', $class ); - $base_dir = $base_dir . $sub_dir . DIRECTORY_SEPARATOR; + $base_dir = $base_dir . $sub_dir . '/'; } $filename = 'class-' . strtr( $class, '_', '-' ); From 47b1b10955fec4118c3149553480fb1e4dc45110 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Thu, 11 May 2023 09:45:01 +0200 Subject: [PATCH 17/24] Fix migration script --- includes/class-migration.php | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/includes/class-migration.php b/includes/class-migration.php index e6e6fba..7e7cd9a 100644 --- a/includes/class-migration.php +++ b/includes/class-migration.php @@ -1,7 +1,8 @@ upsert(); - $result = wp_set_object_terms( $user_id, $follower->get_actor(), self::TAXONOMY, true ); + $result = wp_set_object_terms( $user_id, $follower->get_actor(), Followers::TAXONOMY, true ); } } } From b8039141809982567028a85a79914a77cee70ba8 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Thu, 11 May 2023 09:46:26 +0200 Subject: [PATCH 18/24] removed output formatting --- activitypub.php | 2 - includes/class-scheduler.php | 4 +- includes/collection/class-followers.php | 66 +++++-------------- includes/model/class-follower.php | 9 +++ includes/rest/class-followers.php | 8 ++- includes/table/class-followers.php | 2 +- tests/test-class-db-activitypub-followers.php | 7 ++ 7 files changed, 41 insertions(+), 57 deletions(-) diff --git a/activitypub.php b/activitypub.php index 0528965..47e4167 100644 --- a/activitypub.php +++ b/activitypub.php @@ -29,8 +29,6 @@ function init() { \define( 'ACTIVITYPUB_PLUGIN_BASENAME', plugin_basename( __FILE__ ) ); \define( 'ACTIVITYPUB_PLUGIN_FILE', plugin_dir_path( __FILE__ ) . '/' . basename( __FILE__ ) ); - \define( 'ACTIVITYPUB_OBJECT', 'ACTIVITYPUB_OBJECT' ); - Migration::init(); Activity_Dispatcher::init(); Activitypub::init(); diff --git a/includes/class-scheduler.php b/includes/class-scheduler.php index 4bfb8b8..a79044e 100644 --- a/includes/class-scheduler.php +++ b/includes/class-scheduler.php @@ -95,7 +95,7 @@ class Scheduler { * @return void */ public static function update_followers() { - $followers = Followers::get_outdated_followers( ACTIVITYPUB_OBJECT ); + $followers = Followers::get_outdated_followers(); foreach ( $followers as $follower ) { $meta = get_remote_metadata_by_actor( $follower->get_actor() ); @@ -116,7 +116,7 @@ class Scheduler { * @return void */ public static function cleanup_followers() { - $followers = Followers::get_faulty_followers( ACTIVITYPUB_OBJECT ); + $followers = Followers::get_faulty_followers(); foreach ( $followers as $follower ) { $meta = get_remote_metadata_by_actor( $follower->get_actor() ); diff --git a/includes/collection/class-followers.php b/includes/collection/class-followers.php index 413af3b..8a271f6 100644 --- a/includes/collection/class-followers.php +++ b/includes/collection/class-followers.php @@ -316,7 +316,7 @@ class Followers { * * @return array The Term list of Followers, the format depends on $output */ - public static function get_followers( $user_id, $output = ARRAY_N, $number = null, $offset = null, $args = array() ) { + public static function get_followers( $user_id, $number = null, $offset = null, $args = array() ) { $defaults = array( 'taxonomy' => self::TAXONOMY, 'hide_empty' => false, @@ -329,25 +329,13 @@ class Followers { $args = wp_parse_args( $args, $defaults ); $terms = new WP_Term_Query( $args ); - $items = array(); - // change output format - switch ( $output ) { - case ACTIVITYPUB_OBJECT: - foreach ( $terms->get_terms() as $follower ) { - $items[] = new Follower( $follower->name ); // phpcs:ignore - } - return $items; - case OBJECT: - return $terms->get_terms(); - case ARRAY_N: - default: - foreach ( $terms->get_terms() as $follower ) { - $items[] = $follower->name; // phpcs:ignore - } - return $items; + foreach ( $terms->get_terms() as $follower ) { + $items[] = new Follower( $follower->name ); // phpcs:ignore } + + return $items; } /** @@ -414,7 +402,7 @@ class Followers { * * @return mixed The Term list of Followers, the format depends on $output. */ - public static function get_outdated_followers( $output = ARRAY_N, $number = 50, $older_than = 604800 ) { + public static function get_outdated_followers( $number = 50, $older_than = 604800 ) { $args = array( 'taxonomy' => self::TAXONOMY, 'number' => $number, @@ -432,25 +420,13 @@ class Followers { ); $terms = new WP_Term_Query( $args ); - $items = array(); - // change output format - switch ( $output ) { - case ACTIVITYPUB_OBJECT: - foreach ( $terms->get_terms() as $follower ) { - $items[] = new Follower( $follower->name ); // phpcs:ignore - } - return $items; - case OBJECT: - return $terms->get_terms(); - case ARRAY_N: - default: - foreach ( $terms->get_terms() as $follower ) { - $items[] = $follower->name; // phpcs:ignore - } - return $items; + foreach ( $terms->get_terms() as $follower ) { + $items[] = new Follower( $follower->name ); // phpcs:ignore } + + return $items; } /** @@ -461,7 +437,7 @@ class Followers { * * @return mixed The Term list of Followers, the format depends on $output. */ - public static function get_faulty_followers( $output = ARRAY_N, $number = 10 ) { + public static function get_faulty_followers( $number = 10 ) { $args = array( 'taxonomy' => self::TAXONOMY, 'number' => $number, @@ -474,24 +450,12 @@ class Followers { ); $terms = new WP_Term_Query( $args ); - $items = array(); - // change output format - switch ( $output ) { - case ACTIVITYPUB_OBJECT: - foreach ( $terms->get_terms() as $follower ) { - $items[] = new Follower( $follower->name ); // phpcs:ignore - } - return $items; - case OBJECT: - return $terms->get_terms(); - case ARRAY_N: - default: - foreach ( $terms->get_terms() as $follower ) { - $items[] = $follower->name; // phpcs:ignore - } - return $items; + foreach ( $terms->get_terms() as $follower ) { + $items[] = new Follower( $follower->name ); // phpcs:ignore } + + return $items; } } diff --git a/includes/model/class-follower.php b/includes/model/class-follower.php index 0668e4d..6c03fd8 100644 --- a/includes/model/class-follower.php +++ b/includes/model/class-follower.php @@ -159,6 +159,15 @@ class Follower { } } + /** + * Magic function to return the Actor-URL when the Object is used as a string + * + * @return string + */ + public function __toString() { + return $this->get_actor(); + } + /** * Prefill the Object with the meta data. * diff --git a/includes/rest/class-followers.php b/includes/rest/class-followers.php index 9a8b9b6..7dd49a8 100644 --- a/includes/rest/class-followers.php +++ b/includes/rest/class-followers.php @@ -81,7 +81,13 @@ class Followers { $json->partOf = \get_rest_url( null, "/activitypub/1.0/users/$user_id/followers" ); // phpcs:ignore $json->first = $json->partOf; // phpcs:ignore $json->totalItems = FollowerCollection::count_followers( $user_id ); // phpcs:ignore - $json->orderedItems = FollowerCollection::get_followers( $user_id, ARRAY_N ); // phpcs:ignore + // phpcs:ignore + $json->orderedItems = array_map( + function( $item ) { + return $item->get_actor(); + }, + FollowerCollection::get_followers( $user_id ) + ); $response = new WP_REST_Response( $json, 200 ); $response->header( 'Content-Type', 'application/activity+json' ); diff --git a/includes/table/class-followers.php b/includes/table/class-followers.php index c9b5948..03fb70f 100644 --- a/includes/table/class-followers.php +++ b/includes/table/class-followers.php @@ -35,7 +35,7 @@ class Followers extends WP_List_Table { $page_num = $this->get_pagenum(); $per_page = 20; - $follower = FollowerCollection::get_followers( \get_current_user_id(), ACTIVITYPUB_OBJECT, $per_page, ( $page_num - 1 ) * $per_page ); + $follower = FollowerCollection::get_followers( \get_current_user_id(), $per_page, ( $page_num - 1 ) * $per_page ); $counter = FollowerCollection::count_followers( \get_current_user_id() ); $this->items = array(); diff --git a/tests/test-class-db-activitypub-followers.php b/tests/test-class-db-activitypub-followers.php index 2467363..a04145a 100644 --- a/tests/test-class-db-activitypub-followers.php +++ b/tests/test-class-db-activitypub-followers.php @@ -58,6 +58,13 @@ class Test_Db_Activitypub_Followers extends WP_UnitTestCase { $this->assertEquals( 3, \count( $db_followers ) ); + $db_followers = array_map( + function( $item ) { + return $item->get_actor(); + }, + $db_followers + ); + $this->assertSame( array( 'https://example.com/author/jon', 'https://example.org/author/doe', 'http://sally.example.org' ), $db_followers ); } From b85b0167c0e9acf44d42f8c3b109cfb1246f7b0b Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Thu, 11 May 2023 10:53:19 +0200 Subject: [PATCH 19/24] Update activitypub.php Co-authored-by: Alex Kirk --- activitypub.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/activitypub.php b/activitypub.php index 47e4167..cb67fa8 100644 --- a/activitypub.php +++ b/activitypub.php @@ -82,7 +82,7 @@ spl_autoload_register( require_once \dirname( __FILE__ ) . '/includes/functions.php'; // load NodeInfo endpoints only if blog is public -if ( true === (bool) \get_option( 'blog_public', 1 ) ) { +if ( \get_option( 'blog_public', 1 ) ) { Rest\NodeInfo::init(); } From cfa8974ffaf862b9479f61d0c2c4348011835cd4 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Thu, 11 May 2023 14:38:57 +0200 Subject: [PATCH 20/24] support more more depth in the namespaces --- activitypub.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/activitypub.php b/activitypub.php index cb67fa8..3e2d98f 100644 --- a/activitypub.php +++ b/activitypub.php @@ -65,7 +65,9 @@ spl_autoload_register( $class = str_replace( 'activitypub\\', '', $class ); if ( false !== strpos( $class, '\\' ) ) { - list( $sub_dir, $class ) = explode( '\\', $class ); + $parts = explode( '\\', $class ); + $class = array_pop( $parts ); + $sub_dir = implode( '/', $parts ); $base_dir = $base_dir . $sub_dir . '/'; } From 663c6315c96ec462ac272214f1b2c277d23ad542 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Thu, 11 May 2023 14:40:47 +0200 Subject: [PATCH 21/24] make debug file optional --- activitypub.php | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/activitypub.php b/activitypub.php index 3e2d98f..1f42652 100644 --- a/activitypub.php +++ b/activitypub.php @@ -88,8 +88,9 @@ if ( \get_option( 'blog_public', 1 ) ) { Rest\NodeInfo::init(); } -if ( \WP_DEBUG ) { - require_once \dirname( __FILE__ ) . '/includes/debug.php'; +$debug_file = \dirname( __FILE__ ) . '/includes/debug.php'; +if ( \WP_DEBUG && file_exists( $debug_file ) && is_readable( $debug_file ) ) { + require_once $debug_file; } /** From 068576342454e910d5fc4690545c37e89a0c4b50 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Thu, 11 May 2023 14:55:11 +0200 Subject: [PATCH 22/24] return error if class does not exist or is not readable --- activitypub.php | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/activitypub.php b/activitypub.php index 1f42652..c0a95fe 100644 --- a/activitypub.php +++ b/activitypub.php @@ -55,11 +55,11 @@ function init() { * Class Autoloader */ spl_autoload_register( - function ( $class ) { + function ( $full_class ) { $base_dir = \dirname( __FILE__ ) . '/includes/'; $base = 'activitypub'; - $class = strtolower( $class ); + $class = strtolower( $full_class ); if ( strncmp( $class, $base, strlen( $base ) ) === 0 ) { $class = str_replace( 'activitypub\\', '', $class ); @@ -76,6 +76,9 @@ spl_autoload_register( if ( file_exists( $file ) && is_readable( $file ) ) { require_once $file; + } else { + // translators: %s is the class name + \wp_die( sprintf( esc_html__( 'Required class not found or not readable: %s', 'activitypub' ), esc_html( $full_class ) ) ); } } } From 94e5539d75ef610f41c9a23195e0ba9c674513ee Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Fri, 12 May 2023 10:23:58 +0200 Subject: [PATCH 23/24] reset errors if new is set --- includes/model/class-follower.php | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/includes/model/class-follower.php b/includes/model/class-follower.php index 6c03fd8..a663270 100644 --- a/includes/model/class-follower.php +++ b/includes/model/class-follower.php @@ -224,6 +224,18 @@ class Follower { return null; } + /** + * Set new Error + * + * @param mixed $error The latest HTTP-Error. + * + * @return void + */ + public function set_error( $error ) { + $this->errors = array(); + $this->error = $error; + } + /** * Get the errors. * From 8b9026ab5ec3b427cfb9c23925c4506aba6d6b09 Mon Sep 17 00:00:00 2001 From: Matthias Pfefferle Date: Mon, 15 May 2023 10:55:07 +0200 Subject: [PATCH 24/24] fix get_post_content_template function --- includes/model/class-post.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/model/class-post.php b/includes/model/class-post.php index ccb161c..e54c295 100644 --- a/includes/model/class-post.php +++ b/includes/model/class-post.php @@ -537,6 +537,6 @@ class Post { return "[ap_content]\n\n[ap_hashtags]\n\n[ap_permalink type=\"html\"]"; } - return $content; + return \get_option( 'activitypub_custom_post_content', ACTIVITYPUB_CUSTOM_POST_CONTENT ); } }