array( 'name' => _x( 'Followers', 'post_type plural name', 'activitypub' ), 'singular_name' => _x( 'Follower', 'post_type single name', 'activitypub' ), ), 'public' => false, 'hierarchical' => false, 'rewrite' => false, 'query_var' => false, 'delete_with_user' => false, 'can_export' => true, 'supports' => array(), ) ); register_post_meta( self::POST_TYPE, 'activitypub_inbox', array( 'type' => 'string', 'single' => true, 'sanitize_callback' => array( self::class, 'sanitize_url' ), ) ); register_post_meta( self::POST_TYPE, 'activitypub_errors', array( 'type' => 'string', 'single' => false, 'sanitize_callback' => function( $value ) { if ( ! is_string( $value ) ) { throw new Exception( 'Error message is no valid string' ); } return esc_sql( $value ); }, ) ); register_post_meta( self::POST_TYPE, 'activitypub_user_id', array( 'type' => 'string', 'single' => false, 'sanitize_callback' => function( $value ) { return esc_sql( $value ); }, ) ); register_post_meta( self::POST_TYPE, 'activitypub_actor_json', array( 'type' => 'string', 'single' => true, 'sanitize_callback' => function( $value ) { return sanitize_text_field( $value ); }, ) ); do_action( 'activitypub_after_register_post_type' ); } public static function sanitize_url( $value ) { if ( filter_var( $value, FILTER_VALIDATE_URL ) === false ) { return null; } return esc_url_raw( $value ); } /** * Handle the "Follow" Request * * @param array $object The JSON "Follow" Activity * @param int $user_id The ID of the ID of the WordPress User * * @return void */ public static function handle_follow_request( $object, $user_id ) { // save follower $follower = self::add_follower( $user_id, $object['actor'] ); do_action( 'activitypub_followers_post_follow', $object['actor'], $object, $user_id, $follower ); } /** * Handle "Unfollow" requests * * @param array $object The JSON "Undo" Activity * @param int $user_id The ID of the ID of the WordPress User */ public static function handle_undo_request( $object, $user_id ) { if ( isset( $object['object'] ) && isset( $object['object']['type'] ) && 'Follow' === $object['object']['type'] ) { self::remove_follower( $user_id, $object['actor'] ); } } /** * Add new Follower * * @param int $user_id The ID of the WordPress User * @param string $actor The Actor URL * * @return array|WP_Error The Follower (WP_Post array) or an WP_Error */ public static function add_follower( $user_id, $actor ) { $meta = get_remote_metadata_by_actor( $actor ); if ( is_tombstone( $meta ) ) { return $meta; } if ( empty( $meta ) || ! is_array( $meta ) || is_wp_error( $meta ) ) { return new WP_Error( 'activitypub_invalid_follower', __( 'Invalid Follower', 'activitypub' ), array( 'status' => 400 ) ); } $error = null; $follower = new Follower(); $follower->from_array( $meta ); $id = $follower->upsert(); if ( is_wp_error( $id ) ) { return $id; } $meta = get_post_meta( $id, 'activitypub_user_id' ); if ( $error ) { self::add_error( $id, $error ); } // phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict if ( is_array( $meta ) && ! in_array( $user_id, $meta ) ) { add_post_meta( $id, 'activitypub_user_id', $user_id ); wp_cache_delete( sprintf( self::CACHE_KEY_INBOXES, $user_id ), 'activitypub' ); } return $follower; } /** * Remove a Follower * * @param int $user_id The ID of the WordPress User * @param string $actor The Actor URL * * @return bool|WP_Error True on success, false or WP_Error on failure. */ public static function remove_follower( $user_id, $actor ) { wp_cache_delete( sprintf( self::CACHE_KEY_INBOXES, $user_id ), 'activitypub' ); $follower = self::get_follower( $user_id, $actor ); if ( ! $follower ) { return false; } return delete_post_meta( $follower->get__id(), 'activitypub_user_id', $user_id ); } /** * Get a Follower * * @param int $user_id The ID of the WordPress User * @param string $actor The Actor URL * * @return \Activitypub\Model\Follower The Follower object */ public static function get_follower( $user_id, $actor ) { global $wpdb; $post_id = $wpdb->get_var( $wpdb->prepare( "SELECT DISTINCT p.ID FROM $wpdb->posts p INNER JOIN $wpdb->postmeta pm ON p.ID = pm.post_id WHERE p.post_type = %s AND pm.meta_key = 'activitypub_user_id' AND pm.meta_value = %d AND p.guid = %s", array( esc_sql( self::POST_TYPE ), esc_sql( $user_id ), esc_sql( $actor ), ) ) ); if ( $post_id ) { $post = get_post( $post_id ); return Follower::init_from_cpt( $post ); } return null; } /** * Send Accept response * * @param string $actor The Actor URL * @param array $object The Activity object * @param int $user_id The ID of the WordPress User * @param Activitypub\Model\Follower $follower The Follower object * * @return void */ public static function send_follow_response( $actor, $object, $user_id, $follower ) { if ( is_wp_error( $follower ) ) { // it is not even possible to send a "Reject" because // we can not get the Remote-Inbox return; } // only send minimal data $object = array_intersect_key( $object, array_flip( array( 'id', 'type', 'actor', 'object', ) ) ); $user = Users::get_by_id( $user_id ); // get inbox $inbox = $follower->get_shared_inbox(); // send "Accept" activity $activity = new Activity(); $activity->set_type( 'Accept' ); $activity->set_object( $object ); $activity->set_actor( $user->get_id() ); $activity->set_to( $actor ); $activity->set_id( $user->get_id() . '#follow-' . \preg_replace( '~^https?://~', '', $actor ) . '-' . \time() ); $activity = $activity->to_json(); Http::post( $inbox, $activity, $user_id ); } /** * Get the Followers of a given user * * @param int $user_id The ID of the WordPress User. * @param int $number Maximum number of results to return. * @param int $page Page number. * @param array $args The WP_Query arguments. * @return array List of `Follower` objects. */ public static function get_followers( $user_id, $number = -1, $page = null, $args = array() ) { $data = self::get_followers_with_count( $user_id, $number, $page, $args ); return $data['followers']; } /** * Get the Followers of a given user, along with a total count for pagination purposes. * * @param int $user_id The ID of the WordPress User. * @param int $number Maximum number of results to return. * @param int $page Page number. * @param array $args The WP_Query arguments. * * @return array * followers List of `Follower` objects. * total Total number of followers. */ public static function get_followers_with_count( $user_id, $number = -1, $page = null, $args = array() ) { $defaults = array( 'post_type' => self::POST_TYPE, 'posts_per_page' => $number, 'paged' => $page, 'orderby' => 'ID', 'order' => 'DESC', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query 'meta_query' => array( array( 'key' => 'activitypub_user_id', 'value' => $user_id, ), ), ); $args = wp_parse_args( $args, $defaults ); $query = new WP_Query( $args ); $total = $query->found_posts; $followers = array_map( function( $post ) { return Follower::init_from_cpt( $post ); }, $query->get_posts() ); return compact( 'followers', 'total' ); } /** * Get all Followers * * @param array $args The WP_Query arguments. * * @return array The Term list of Followers. */ public static function get_all_followers() { $args = array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query 'meta_query' => array( 'relation' => 'AND', array( 'key' => 'activitypub_inbox', 'compare' => 'EXISTS', ), array( 'key' => 'activitypub_actor_json', 'compare' => 'EXISTS', ), ), ); return self::get_followers( null, null, null, $args ); } /** * Count the total number of followers * * @param int $user_id The ID of the WordPress User * * @return int The number of Followers */ public static function count_followers( $user_id ) { $query = new WP_Query( array( 'post_type' => self::POST_TYPE, 'fields' => 'ids', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query 'meta_query' => array( 'relation' => 'AND', array( 'key' => 'activitypub_user_id', 'value' => $user_id, ), array( 'key' => 'activitypub_inbox', 'compare' => 'EXISTS', ), array( 'key' => 'activitypub_actor_json', 'compare' => 'EXISTS', ), ), ) ); return $query->found_posts; } /** * Returns all Inboxes fo a Users Followers * * @param int $user_id The ID of the WordPress User * * @return array The list of Inboxes */ public static function get_inboxes( $user_id ) { $cache_key = sprintf( self::CACHE_KEY_INBOXES, $user_id ); $inboxes = wp_cache_get( $cache_key, 'activitypub' ); if ( $inboxes ) { return $inboxes; } // get all Followers of a ID of the WordPress User $posts = new WP_Query( array( 'post_type' => self::POST_TYPE, 'fields' => 'ids', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query 'meta_query' => array( 'relation' => 'AND', array( 'key' => 'activitypub_inbox', 'compare' => 'EXISTS', ), array( 'key' => 'activitypub_user_id', 'value' => $user_id, ), array( 'key' => 'activitypub_inbox', 'value' => '', 'compare' => '!=', ), ), ) ); $posts = $posts->get_posts(); if ( ! $posts ) { return array(); } global $wpdb; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery $results = $wpdb->get_col( $wpdb->prepare( "SELECT DISTINCT meta_value FROM {$wpdb->postmeta} WHERE post_id IN (" . implode( ', ', array_fill( 0, count( $posts ), '%d' ) ) . ") AND meta_key = 'activitypub_inbox' AND meta_value IS NOT NULL", $posts ) ); $inboxes = array_filter( $results ); wp_cache_set( $cache_key, $inboxes, 'activitypub' ); return $inboxes; } /** * Get all Followers that have not been updated for a given time * * @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( $number = 50, $older_than = 86400 ) { $args = array( 'post_type' => self::POST_TYPE, 'posts_per_page' => $number, 'orderby' => 'modified', 'order' => 'ASC', 'post_status' => 'any', // 'any' includes 'trash 'date_query' => array( array( 'column' => 'post_modified_gmt', 'before' => gmdate( 'Y-m-d', \time() - $older_than ), ), ), ); $posts = new WP_Query( $args ); $items = array(); foreach ( $posts->get_posts() as $follower ) { $items[] = Follower::init_from_cpt( $follower ); // phpcs:ignore } return $items; } /** * 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( $number = 20 ) { $args = array( 'post_type' => self::POST_TYPE, 'posts_per_page' => $number, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query 'meta_query' => array( 'relation' => 'OR', array( 'key' => 'activitypub_errors', 'compare' => 'EXISTS', ), array( 'key' => 'activitypub_inbox', 'compare' => 'NOT EXISTS', ), array( 'key' => 'activitypub_actor_json', 'compare' => 'NOT EXISTS', ), array( 'key' => 'activitypub_inbox', 'value' => '', 'compare' => '=', ), array( 'key' => 'activitypub_actor_json', 'value' => '', 'compare' => '=', ), ), ); $posts = new WP_Query( $args ); $items = array(); foreach ( $posts->get_posts() as $follower ) { $items[] = Follower::init_from_cpt( $follower ); // phpcs:ignore } return $items; } /** * This function is used to store errors that occur when * sending an ActivityPub message to a Follower. * * The error will be stored in the * post meta. * * @param int $post_id The ID of the WordPress Custom-Post-Type. * @param mixed $error The error message. Can be a string or a WP_Error. * * @return int|false The meta ID on success, false on failure. */ public static function add_error( $post_id, $error ) { if ( is_string( $error ) ) { $error_message = $error; } elseif ( is_wp_error( $error ) ) { $error_message = $error->get_error_message(); } else { $error_message = __( 'Unknown Error or misconfigured Error-Message', 'activitypub' ); } return add_post_meta( $post_id, 'activitypub_errors', $error_message ); } }