From 06250909896e7bd3a6ab35aca90b5cfe63602ec4 Mon Sep 17 00:00:00 2001 From: Matt Wiebe Date: Mon, 7 Oct 2024 06:25:32 -0500 Subject: [PATCH 1/2] Fix link regex (#922) * Fix link regex * add some tests --------- Co-authored-by: Matthias Pfefferle --- activitypub.php | 2 +- includes/class-link.php | 2 +- tests/test-class-activitypub-link.php | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/activitypub.php b/activitypub.php index 2cb7ad57..157edebe 100644 --- a/activitypub.php +++ b/activitypub.php @@ -34,7 +34,7 @@ require_once __DIR__ . '/includes/functions.php'; \defined( 'ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS' ) || \define( 'ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS', 3 ); \defined( 'ACTIVITYPUB_HASHTAGS_REGEXP' ) || \define( 'ACTIVITYPUB_HASHTAGS_REGEXP', '(?:(?<=\s)|(?<=

)|(?<=
)|^)#([A-Za-z0-9_]+)(?:(?=\s|[[:punct:]]|$))' ); \defined( 'ACTIVITYPUB_USERNAME_REGEXP' ) || \define( 'ACTIVITYPUB_USERNAME_REGEXP', '(?:([A-Za-z0-9\._-]+)@((?:[A-Za-z0-9_-]+\.)+[A-Za-z]+))' ); -\defined( 'ACTIVITYPUB_URL_REGEXP' ) || \define( 'ACTIVITYPUB_URL_REGEXP', '(www.|http:|https:)+[^\s]+[\w\/]' ); +\defined( 'ACTIVITYPUB_URL_REGEXP' ) || \define( 'ACTIVITYPUB_URL_REGEXP', '(https?:|www\.)\S+[\w\/]' ); \defined( 'ACTIVITYPUB_CUSTOM_POST_CONTENT' ) || \define( 'ACTIVITYPUB_CUSTOM_POST_CONTENT', "

[ap_title]

\n\n[ap_content]\n\n[ap_hashtags]\n\n[ap_shortlink]" ); \defined( 'ACTIVITYPUB_AUTHORIZED_FETCH' ) || \define( 'ACTIVITYPUB_AUTHORIZED_FETCH', false ); \defined( 'ACTIVITYPUB_DISABLE_REWRITES' ) || \define( 'ACTIVITYPUB_DISABLE_REWRITES', false ); diff --git a/includes/class-link.php b/includes/class-link.php index 2e48d1be..52a81400 100644 --- a/includes/class-link.php +++ b/includes/class-link.php @@ -62,7 +62,7 @@ class Link { $result[0] = 'https://' . $result[0]; } $parsed_url = \wp_parse_url( html_entity_decode( $result[0] ) ); - if ( ! $parsed_url ) { + if ( ! $parsed_url || empty( $parsed_url['host'] ) ) { return $result[0]; } diff --git a/tests/test-class-activitypub-link.php b/tests/test-class-activitypub-link.php index e966ce89..bfe124db 100644 --- a/tests/test-class-activitypub-link.php +++ b/tests/test-class-activitypub-link.php @@ -37,6 +37,8 @@ ENDPRE; array( 'hello https://www.test.de test', 'hello test.de test' ), array( 'hello www.test.de test', 'hello test.de test' ), array( 'hello https://test:test@test.de test', 'hello test.de test' ), + array( 'wwwfoocom', 'wwwfoocom' ), + array( 'www.foo.com', 'foo.com' ), array( $code, $code ), array( $style, $style ), array( $textarea, $textarea ), From 00a57c39a4e844949bc4f64a45714d1f21d9645d Mon Sep 17 00:00:00 2001 From: Konstantin Obenland Date: Mon, 7 Oct 2024 06:25:51 -0500 Subject: [PATCH 2/2] PHPCS: Enable Commenting sniff (#925) * PHPCS: Enable Commenting sniff * Apply suggestions from code review Co-authored-by: Matthias Pfefferle * Fix param alignment. --------- Co-authored-by: Matthias Pfefferle --- activitypub.php | 26 +- includes/activity/class-activity.php | 10 +- includes/activity/class-actor.php | 2 + includes/activity/class-base-object.php | 50 +++- .../activity/extended-object/class-event.php | 38 ++- .../activity/extended-object/class-place.php | 5 + includes/class-activity-dispatcher.php | 124 ++++---- includes/class-activitypub.php | 123 ++++---- includes/class-admin.php | 127 ++++---- includes/class-blocks.php | 63 +++- includes/class-cli.php | 51 ++-- includes/class-comment.php | 106 ++++--- includes/class-debug.php | 46 ++- includes/class-handler.php | 13 +- includes/class-hashtag.php | 56 ++-- includes/class-health-check.php | 62 ++-- includes/class-http.php | 62 +++- includes/class-link.php | 43 +-- includes/class-mention.php | 50 ++-- includes/class-migration.php | 88 +++--- includes/class-notification.php | 5 + includes/class-scheduler.php | 85 +++--- includes/class-shortcodes.php | 58 ++-- includes/class-signature.php | 73 +++-- includes/class-webfinger.php | 54 ++-- includes/collection/class-extra-fields.php | 40 ++- includes/collection/class-followers.php | 87 +++--- includes/collection/class-interactions.php | 59 ++-- includes/collection/class-replies.php | 15 +- includes/collection/class-users.php | 53 ++-- includes/compat.php | 27 +- includes/debug.php | 17 +- includes/functions.php | 283 +++++++++++------- includes/handler/class-announce.php | 28 +- includes/handler/class-create.php | 54 ++-- includes/handler/class-delete.php | 61 ++-- includes/handler/class-follow.php | 43 +-- includes/handler/class-like.php | 18 +- includes/handler/class-undo.php | 22 +- includes/handler/class-update.php | 51 ++-- includes/help.php | 11 +- includes/model/class-application.php | 65 +++- includes/model/class-blog.php | 111 +++++-- includes/model/class-follower.php | 59 ++-- includes/model/class-user.php | 118 ++++++-- includes/rest/class-actors.php | 32 +- includes/rest/class-collection.php | 36 ++- includes/rest/class-comment.php | 16 +- includes/rest/class-followers.php | 54 ++-- includes/rest/class-following.php | 42 ++- includes/rest/class-inbox.php | 125 +++++--- includes/rest/class-interaction.php | 27 +- includes/rest/class-nodeinfo.php | 28 +- includes/rest/class-outbox.php | 55 ++-- includes/rest/class-server.php | 41 +-- includes/rest/class-webfinger.php | 35 ++- includes/table/class-followers.php | 96 +++++- includes/transformer/class-attachment.php | 11 +- includes/transformer/class-base.php | 40 +-- includes/transformer/class-comment.php | 66 ++-- includes/transformer/class-factory.php | 14 +- includes/transformer/class-post.php | 118 +++++--- integration/class-buddypress.php | 28 +- integration/class-enable-mastodon-apps.php | 122 ++++++-- integration/class-jetpack.php | 27 +- integration/class-nodeinfo.php | 32 +- integration/class-opengraph.php | 24 +- .../class-seriously-simple-podcasting.php | 6 + integration/class-stream-connector.php | 26 +- integration/class-webfinger.php | 27 +- integration/load.php | 5 + phpcs.xml | 4 +- templates/admin-header.php | 7 +- 73 files changed, 2359 insertions(+), 1427 deletions(-) diff --git a/activitypub.php b/activitypub.php index 157edebe..69ecbaaf 100644 --- a/activitypub.php +++ b/activitypub.php @@ -11,15 +11,14 @@ * Requires PHP: 7.0 * Text Domain: activitypub * Domain Path: /languages + * + * @package Activitypub */ namespace Activitypub; use WP_CLI; -use function Activitypub\is_blog_public; -use function Activitypub\site_supports_blocks; - require_once __DIR__ . '/includes/compat.php'; require_once __DIR__ . '/includes/functions.php'; @@ -39,7 +38,7 @@ require_once __DIR__ . '/includes/functions.php'; \defined( 'ACTIVITYPUB_AUTHORIZED_FETCH' ) || \define( 'ACTIVITYPUB_AUTHORIZED_FETCH', false ); \defined( 'ACTIVITYPUB_DISABLE_REWRITES' ) || \define( 'ACTIVITYPUB_DISABLE_REWRITES', false ); \defined( 'ACTIVITYPUB_DISABLE_INCOMING_INTERACTIONS' ) || \define( 'ACTIVITYPUB_DISABLE_INCOMING_INTERACTIONS', false ); -// Disable reactions like `Like` and `Announce` by default +// Disable reactions like `Like` and `Announce` by default. \defined( 'ACTIVITYPUB_DISABLE_REACTIONS' ) || \define( 'ACTIVITYPUB_DISABLE_REACTIONS', true ); \defined( 'ACTIVITYPUB_DISABLE_OUTGOING_INTERACTIONS' ) || \define( 'ACTIVITYPUB_DISABLE_OUTGOING_INTERACTIONS', false ); \defined( 'ACTIVITYPUB_SHARED_INBOX_FEATURE' ) || \define( 'ACTIVITYPUB_SHARED_INBOX_FEATURE', false ); @@ -66,7 +65,7 @@ function rest_init() { Rest\Collection::init(); Rest\Interaction::init(); - // load NodeInfo endpoints only if blog is public + // Load NodeInfo endpoints only if blog is public. if ( is_blog_public() ) { Rest\NodeInfo::init(); } @@ -103,7 +102,7 @@ function plugin_init() { /** - * Class Autoloader + * Class Autoloader. */ \spl_autoload_register( function ( $full_class ) { @@ -131,7 +130,7 @@ function plugin_init() { if ( file_exists( $file ) && is_readable( $file ) ) { require_once $file; } else { - // translators: %s is the class name + // translators: %s is the class name. $message = sprintf( esc_html__( 'Required class not found or not readable: %s', 'activitypub' ), esc_html( $full_class ) ); Debug::write_log( $message ); \wp_die( $message ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped @@ -141,7 +140,9 @@ function plugin_init() { ); /** - * Add plugin settings link + * Add plugin settings link. + * + * @param array $actions The current actions. */ function plugin_settings_link( $actions ) { $settings_link = array(); @@ -179,13 +180,14 @@ function plugin_settings_link( $actions ) { ) ); -// Load integrations +// Load integrations. require_once __DIR__ . '/integration/load.php'; /** - * `get_plugin_data` wrapper + * `get_plugin_data` wrapper. * - * @return array The plugin metadata array + * @param array $default_headers Optional. The default plugin headers. Default empty array. + * @return array The plugin metadata array. */ function get_plugin_meta( $default_headers = array() ) { if ( ! $default_headers ) { @@ -221,7 +223,7 @@ function get_plugin_version() { return $meta['Version']; } -// Check for CLI env, to add the CLI commands +// Check for CLI env, to add the CLI commands. if ( defined( 'WP_CLI' ) && WP_CLI ) { WP_CLI::add_command( 'activitypub', diff --git a/includes/activity/class-activity.php b/includes/activity/class-activity.php index f8db1945..b8418315 100644 --- a/includes/activity/class-activity.php +++ b/includes/activity/class-activity.php @@ -3,11 +3,13 @@ * Inspired by the PHP ActivityPub Library by @Landrok * * @link https://github.com/landrok/activitypub + * + * @package Activitypub */ namespace Activitypub\Activity; -use Activitypub\Activity\Base_Object; +use Activitypub\Link; /** * \Activitypub\Activity\Activity implements the common @@ -150,12 +152,12 @@ class Activity extends Base_Object { * @return void */ public function set_object( $data ) { - // convert array to object + // Convert array to object. if ( is_array( $data ) ) { $data = self::init_from_array( $data ); } - // set object + // Set object. $this->set( 'object', $data ); if ( ! is_object( $data ) ) { @@ -202,7 +204,7 @@ class Activity extends Base_Object { if ( $this->object instanceof Base_Object ) { $class = get_class( $this->object ); if ( $class && $class::JSON_LD_CONTEXT ) { - // Without php 5.6 support this could be just: 'return $this->object::JSON_LD_CONTEXT;' + // Without php 5.6 support this could be just: 'return $this->object::JSON_LD_CONTEXT;'. return $class::JSON_LD_CONTEXT; } } diff --git a/includes/activity/class-actor.php b/includes/activity/class-actor.php index 6ce832bc..ddbef8ea 100644 --- a/includes/activity/class-actor.php +++ b/includes/activity/class-actor.php @@ -3,6 +3,8 @@ * Inspired by the PHP ActivityPub Library by @Landrok * * @link https://github.com/landrok/activitypub + * + * @package Activitypub */ namespace Activitypub\Activity; diff --git a/includes/activity/class-base-object.php b/includes/activity/class-base-object.php index ce179936..ab765174 100644 --- a/includes/activity/class-base-object.php +++ b/includes/activity/class-base-object.php @@ -3,6 +3,8 @@ * Inspired by the PHP ActivityPub Library by @Landrok * * @link https://github.com/landrok/activitypub + * + * @package Activitypub */ namespace Activitypub\Activity; @@ -431,7 +433,7 @@ class Base_Object { * * @see https://www.w3.org/TR/activitypub/#source-property * - * @var ObjectType + * @var array */ protected $source; @@ -460,12 +462,10 @@ class Base_Object { protected $sensitive = false; /** - * Magic function to implement getter and setter + * Magic function to implement getter and setter. * * @param string $method The method name. * @param string $params The method params. - * - * @return void */ public function __call( $method, $params ) { $var = \strtolower( \substr( $method, 4 ) ); @@ -577,9 +577,9 @@ class Base_Object { /** * Convert JSON input to an array. * - * @return string The JSON string. + * @param string $json The JSON string. * - * @return \Activitypub\Activity\Base_Object An Object built from the JSON string. + * @return Base_Object An Object built from the JSON string. */ public static function init_from_json( $json ) { $array = \json_decode( $json, true ); @@ -653,12 +653,12 @@ class Base_Object { $vars = get_object_vars( $this ); foreach ( $vars as $key => $value ) { - // ignotre all _prefixed keys. + // Ignore all _prefixed keys. if ( '_' === substr( $key, 0, 1 ) ) { continue; } - // if value is empty, try to get it from a getter. + // If value is empty, try to get it from a getter. if ( ! $value ) { $value = call_user_func( array( $this, 'get_' . $key ) ); } @@ -667,7 +667,7 @@ class Base_Object { $value = $value->to_array( false ); } - // if value is still empty, ignore it for the array and continue. + // If value is still empty, ignore it for the array and continue. if ( isset( $value ) ) { $array[ snake_to_camel_case( $key ) ] = $value; } @@ -681,10 +681,28 @@ class Base_Object { $class = new ReflectionClass( $this ); $class = strtolower( $class->getShortName() ); + /** + * Filter the array of the ActivityPub object. + * + * @param array $array The array of the ActivityPub object. + * @param string $class The class of the ActivityPub object. + * @param int $id The ID of the ActivityPub object. + * @param Base_Object $object The ActivityPub object. + * + * @return array The filtered array of the ActivityPub object. + */ $array = \apply_filters( 'activitypub_activity_object_array', $array, $class, $this->id, $this ); - $array = \apply_filters( "activitypub_activity_{$class}_object_array", $array, $this->id, $this ); - return $array; + /** + * Filter the array of the ActivityPub object by class. + * + * @param array $array The array of the ActivityPub object. + * @param int $id The ID of the ActivityPub object. + * @param Base_Object $object The ActivityPub object. + * + * @return array The filtered array of the ActivityPub object. + */ + return \apply_filters( "activitypub_activity_{$class}_object_array", $array, $this->id, $this ); } /** @@ -698,11 +716,11 @@ class Base_Object { $array = $this->to_array( $include_json_ld_context ); $options = \JSON_HEX_TAG | \JSON_HEX_AMP | \JSON_HEX_QUOT; - /* - * Options to be passed to json_encode() - * - * @param int $options The current options flags - */ + /** + * Options to be passed to json_encode() + * + * @param int $options The current options flags. + */ $options = \apply_filters( 'activitypub_json_encode_options', $options ); return \wp_json_encode( $array, $options ); diff --git a/includes/activity/extended-object/class-event.php b/includes/activity/extended-object/class-event.php index 4523405e..9ddb46ff 100644 --- a/includes/activity/extended-object/class-event.php +++ b/includes/activity/extended-object/class-event.php @@ -19,8 +19,8 @@ use Activitypub\Activity\Base_Object; class Event extends Base_Object { // Human friendly minimal context for full Mobilizon compatible ActivityPub events. const JSON_LD_CONTEXT = array( - 'https://schema.org/', // The base context is schema.org, cause it is used a lot. - 'https://www.w3.org/ns/activitystreams', // The ActivityStreams context overrides everyting also defined in schema.org. + 'https://schema.org/', // The base context is schema.org, because it is used a lot. + 'https://www.w3.org/ns/activitystreams', // The ActivityStreams context overrides everything also defined in schema.org. array( // The keys here override/extend the context even more. 'pt' => 'https://joinpeertube.org/ns#', 'mz' => 'https://joinmobilizon.org/ns#', @@ -59,7 +59,7 @@ class Event extends Base_Object { /** * Mobilizon compatible values for joinModeTypes. */ - const JOIN_MODE_TYPES = array( 'free', 'restricted', 'external' ); // and 'invite', but not used by mobilizon atm + const JOIN_MODE_TYPES = array( 'free', 'restricted', 'external' ); // and 'invite', but not used by mobilizon atm. /** * Allowed values for ical VEVENT STATUS. @@ -109,8 +109,7 @@ class Event extends Base_Object { ); /** - * Event is an implementation of one of the - * Activity Streams + * Event is an implementation of one of the Activity Streams. * * @var string */ @@ -124,7 +123,7 @@ class Event extends Base_Object { protected $name; /** - * The events contacts + * The events contacts. * * @context { * '@id' => 'mz:contacts', @@ -200,7 +199,7 @@ class Event extends Base_Object { * The event's status. * * @context https://www.w3.org/2002/12/cal/ical#status - * @var enum + * @var string */ protected $status; @@ -263,6 +262,7 @@ class Event extends Base_Object { * The passed timezone is only set when it is a valid one, otherwise the site's timezone is used. * * @param string $timezone The timezone string to be set, e.g. 'Europe/Berlin'. + * @return Event */ public function set_timezone( $timezone ) { if ( in_array( $timezone, timezone_identifiers_list(), true ) ) { @@ -275,9 +275,11 @@ class Event extends Base_Object { } /** - * Custom setter for repliesModerationOption which also directy sets commentsEnabled accordingly. + * Custom setter for repliesModerationOption which also directly sets commentsEnabled accordingly. * - * @param string $type + * @param string $type The type of the replies moderation option. + * + * @return Event */ public function set_replies_moderation_option( $type ) { if ( in_array( $type, self::REPLIES_MODERATION_OPTION_TYPES, true ) ) { @@ -297,7 +299,9 @@ class Event extends Base_Object { /** * Custom setter for commentsEnabled which also directly sets repliesModerationOption accordingly. * - * @param bool $comments_enabled + * @param bool $comments_enabled Whether comments are enabled. + * + * @return Event */ public function set_comments_enabled( $comments_enabled ) { if ( is_bool( $comments_enabled ) ) { @@ -317,7 +321,9 @@ class Event extends Base_Object { /** * Custom setter for the ical status that checks whether the status is an ical event status. * - * @param string $status + * @param string $status The status of the event. + * + * @return Event */ public function set_status( $status ) { if ( in_array( $status, self::ICAL_EVENT_STATUS_TYPES, true ) ) { @@ -338,8 +344,10 @@ class Event extends Base_Object { * * Falls back to Mobilizons default category. * - * @param string $category - * @param bool $mobilizon_compatibilty Whether the category must be compatibly with Mobilizon. + * @param string $category The category of the event. + * @param bool $mobilizon_compatibilty Optional. Whether the category must be compatibly with Mobilizon. Default true. + * + * @return Event */ public function set_category( $category, $mobilizon_compatibilty = true ) { if ( $mobilizon_compatibilty ) { @@ -356,7 +364,9 @@ class Event extends Base_Object { * * Automatically sets the joinMode to true if called. * - * @param string $url + * @param string $url The URL for external participation. + * + * @return Event */ public function set_external_participation_url( $url ) { if ( preg_match( '/^https?:\/\/.*/i', $url ) ) { diff --git a/includes/activity/extended-object/class-place.php b/includes/activity/extended-object/class-place.php index 4efe6656..8b66cdcd 100644 --- a/includes/activity/extended-object/class-place.php +++ b/includes/activity/extended-object/class-place.php @@ -86,6 +86,11 @@ class Place extends Base_Object { */ protected $address; + /** + * Set the address of the place. + * + * @param array|string $address The address of the place. + */ public function set_address( $address ) { if ( is_string( $address ) || is_array( $address ) ) { $this->address = $address; diff --git a/includes/class-activity-dispatcher.php b/includes/class-activity-dispatcher.php index a458f9fb..17281a33 100644 --- a/includes/class-activity-dispatcher.php +++ b/includes/class-activity-dispatcher.php @@ -1,24 +1,21 @@ set_type( 'Update' ); $activity->set_actor( $user->get_url() ); $activity->set_object( $user->get_url() ); $activity->set_to( 'https://www.w3.org/ns/activitystreams#Public' ); - // send the update + // Send the update. self::send_activity_to_followers( $activity, $user_id, $user ); } /** * Send an Activity to all followers and mentioned users. * - * @param Activity $activity The ActivityPub Activity. - * @param int $user_id The user ID. - * @param WP_User|WP_Post|WP_Comment $wp_object The WordPress object. - * - * @return void + * @param Activity $activity The ActivityPub Activity. + * @param int $user_id The user ID. + * @param \WP_User|WP_Post|WP_Comment $wp_object The WordPress object. */ private static function send_activity_to_followers( $activity, $user_id, $wp_object ) { - // check if the Activity should be send to the followers + /** + * Filter to prevent sending an Activity to followers. + * + * @param bool $send_activity_to_followers Whether to send the Activity to followers. + * @param Activity $activity The ActivityPub Activity. + * @param int $user_id The user ID. + * @param \WP_User|WP_Post|WP_Comment $wp_object The WordPress object. + */ if ( ! apply_filters( 'activitypub_send_activity_to_followers', true, $activity, $user_id, $wp_object ) ) { return; } + /** + * Filter to modify the Activity before sending it to followers. + * + * @param Activity $activity The ActivityPub Activity. + * @param int $user_id The user ID. + * @param \WP_User|WP_Post|WP_Comment $wp_object The WordPress object. + */ $inboxes = apply_filters( 'activitypub_send_to_inboxes', array(), $user_id, $activity ); $inboxes = array_unique( $inboxes ); @@ -189,8 +191,6 @@ class Activity_Dispatcher { * * @param int $id The WordPress Post ID. * @param string $type The Activity-Type. - * - * @return void */ public static function send_post( $id, $type ) { $post = get_post( $id ); @@ -199,14 +199,20 @@ class Activity_Dispatcher { return; } + /** + * Action to send an Activity for a Post. + * + * @param WP_Post $post The WordPress Post. + * @param string $type The Activity-Type. + */ do_action( 'activitypub_send_activity', $post, $type ); - do_action( - sprintf( - 'activitypub_send_%s_activity', - \strtolower( $type ) - ), - $post - ); + + /** + * Action to send a specific Activity for a Post. + * + * @param WP_Post $post The WordPress Post. + */ + do_action( sprintf( 'activitypub_send_%s_activity', \strtolower( $type ) ), $post ); } /** @@ -214,8 +220,6 @@ class Activity_Dispatcher { * * @param int $id The WordPress Comment ID. * @param string $type The Activity-Type. - * - * @return void */ public static function send_comment( $id, $type ) { $comment = get_comment( $id ); @@ -224,21 +228,27 @@ class Activity_Dispatcher { return; } + /** + * Action to send an Activity for a Comment. + * + * @param WP_Comment $comment The WordPress Comment. + * @param string $type The Activity-Type. + */ do_action( 'activitypub_send_activity', $comment, $type ); - do_action( - sprintf( - 'activitypub_send_%s_activity', - \strtolower( $type ) - ), - $comment - ); + + /** + * Action to send a specific Activity for a Comment. + * + * @param WP_Comment $comment The WordPress Comment. + */ + do_action( sprintf( 'activitypub_send_%s_activity', \strtolower( $type ) ), $comment ); } /** - * Default filter to add Inboxes of Followers + * Default filter to add Inboxes of Followers. * - * @param array $inboxes The list of Inboxes - * @param int $user_id The WordPress User-ID + * @param array $inboxes The list of Inboxes. + * @param int $user_id The WordPress User-ID. * * @return array The filtered Inboxes */ @@ -251,11 +261,11 @@ class Activity_Dispatcher { /** * Default filter to add Inboxes of Mentioned Actors * - * @param array $inboxes The list of Inboxes - * @param int $user_id The WordPress User-ID - * @param array $activity The ActivityPub Activity + * @param array $inboxes The list of Inboxes. + * @param int $user_id The WordPress User-ID. + * @param array $activity The ActivityPub Activity. * - * @return array The filtered Inboxes + * @return array The filtered Inboxes. */ public static function add_inboxes_by_mentioned_actors( $inboxes, $user_id, $activity ) { $cc = $activity->get_cc(); @@ -271,9 +281,9 @@ class Activity_Dispatcher { /** * Default filter to add Inboxes of Posts that are set as `in-reply-to` * - * @param array $inboxes The list of Inboxes - * @param int $user_id The WordPress User-ID - * @param array $activity The ActivityPub Activity + * @param array $inboxes The list of Inboxes. + * @param int $user_id The WordPress User-ID. + * @param array $activity The ActivityPub Activity. * * @return array The filtered Inboxes */ diff --git a/includes/class-activitypub.php b/includes/class-activitypub.php index 78e3284c..c85a5fb1 100644 --- a/includes/class-activitypub.php +++ b/includes/class-activitypub.php @@ -1,22 +1,18 @@ ; rel="alternate"; type="application/activity+json"' ); @@ -199,21 +184,21 @@ class Activitypub { $comment_id = get_query_var( 'c', null ); - // check if it seems to be a comment + // Check if it seems to be a comment. if ( ! $comment_id ) { return; } $comment = get_comment( $comment_id ); - // load a 404 page if `c` is set but not valid + // Load a 404 page if `c` is set but not valid. if ( ! $comment ) { global $wp_query; $wp_query->set_404(); return; } - // stop if it's not an ActivityPub comment + // Stop if it's not an ActivityPub comment. if ( is_activitypub_request() && ! is_local_comment( $comment ) ) { return; } @@ -224,6 +209,10 @@ class Activitypub { /** * Add the 'activitypub' query variable so WordPress won't mangle it. + * + * @param array $vars The query variables. + * + * @return array The query variables. */ public static function add_query_vars( $vars ) { $vars[] = 'activitypub'; @@ -286,9 +275,9 @@ class Activitypub { /** * Function to retrieve Avatar URL if stored in meta. * - * @param int|WP_Comment $comment + * @param int|\WP_Comment $comment The comment ID or object. * - * @return string $url + * @return string The Avatar URL. */ public static function get_avatar_url( $comment ) { if ( \is_numeric( $comment ) ) { @@ -301,8 +290,6 @@ class Activitypub { * Store permalink in meta, to send delete Activity. * * @param string $post_id The Post ID. - * - * @return void */ public static function trash_post( $post_id ) { \add_post_meta( @@ -314,22 +301,22 @@ class Activitypub { } /** - * Delete permalink from meta + * Delete permalink from meta. * - * @param string $post_id The Post ID - * - * @return void + * @param string $post_id The Post ID. */ public static function untrash_post( $post_id ) { \delete_post_meta( $post_id, 'activitypub_canonical_url' ); } /** - * Add rewrite rules + * 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 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; } @@ -365,7 +352,7 @@ class Activitypub { } /** - * Flush rewrite rules; + * Flush rewrite rules. */ public static function flush_rewrite_rules() { self::add_rewrite_rules(); @@ -373,9 +360,7 @@ class Activitypub { } /** - * Adds metabox on wp-admin/tools.php - * - * @return void + * Adds metabox on wp-admin/tools.php. */ public static function tool_box() { if ( \current_user_can( 'edit_posts' ) ) { @@ -384,12 +369,10 @@ class Activitypub { } /** - * Theme compatibility stuff - * - * @return void + * Theme compatibility stuff. */ public static function theme_compat() { - // We assume that you want to use Post-Formats when enabling the setting + // We assume that you want to use Post-Formats when enabling the setting. if ( 'wordpress-post-format' === \get_option( 'activitypub_object_type', ACTIVITYPUB_DEFAULT_OBJECT_TYPE ) ) { if ( ! get_theme_support( 'post-formats' ) ) { // Add support for the Aside, Gallery Post Formats... @@ -408,11 +391,9 @@ class Activitypub { } /** - * Display plugin upgrade notice to users + * Display plugin upgrade notice to users. * - * @param array $data The plugin data - * - * @return void + * @param array $data The plugin data. */ public static function plugin_update_message( $data ) { if ( ! isset( $data['upgrade_notice'] ) ) { @@ -434,9 +415,7 @@ class Activitypub { } /** - * Register the "Followers" Taxonomy - * - * @return void + * Register the "Followers" Taxonomy. */ private static function register_post_types() { \register_post_type( @@ -542,9 +521,7 @@ class Activitypub { /** * Add the 'activitypub' capability to users who can publish posts. * - * @param int $user_id User ID. - * - * @param array $userdata The raw array of data passed to wp_insert_user(). + * @param int $user_id User ID. */ public static function user_register( $user_id ) { if ( \user_can( $user_id, 'publish_posts' ) ) { diff --git a/includes/class-admin.php b/includes/class-admin.php index 353b75fb..2d1d86cd 100644 --- a/includes/class-admin.php +++ b/includes/class-admin.php @@ -1,25 +1,25 @@ @@ -140,7 +136,7 @@ class Admin { } /** - * Load settings page + * Load settings page. */ public static function settings_page() { // phpcs:ignore WordPress.Security.NonceVerification.Recommended @@ -179,7 +175,7 @@ class Admin { * Load user settings page */ public static function followers_list_page() { - // user has to be able to publish posts + // User has to be able to publish posts. if ( ! is_user_disabled( get_current_user_id() ) ) { \load_template( ACTIVITYPUB_PLUGIN_DIR . 'templates/user-followers-list.php' ); } @@ -290,7 +286,7 @@ class Admin { ) ); - // Blog-User Settings + // Blog-User Settings. \register_setting( 'activitypub_blog', 'activitypub_blog_description', @@ -310,7 +306,7 @@ class Admin { 'show_in_rest' => true, 'default' => Blog::get_default_username(), 'sanitize_callback' => function ( $value ) { - // hack to allow dots in the username + // Hack to allow dots in the username. $parts = explode( '.', $value ); $sanitized = array(); @@ -320,7 +316,7 @@ class Admin { $sanitized = implode( '.', $sanitized ); - // check for login or nicename. + // Check for login or nicename. $user = new WP_User_Query( array( 'search' => $sanitized, @@ -357,14 +353,25 @@ class Admin { ); } + /** + * Adds the ActivityPub settings to the Help tab. + */ public static function add_settings_help_tab() { require_once ACTIVITYPUB_PLUGIN_DIR . 'includes/help.php'; } + /** + * Adds the follower list to the Help tab. + */ public static function add_followers_list_help_tab() { - // todo + // todo. } + /** + * Add the profile. + * + * @param \WP_User $user The user object. + */ public static function add_profile( $user ) { $description = \get_user_option( 'activitypub_description', $user->ID ); @@ -381,25 +388,25 @@ class Admin { } /** - * Save the user settings + * Save the user settings. * - * Habdles the saving of the ActivityPub settings. + * Handles the saving of the ActivityPub settings. * * @param int $user_id The user ID. - * - * @return void */ public static function save_user_settings( $user_id ) { if ( ! isset( $_REQUEST['_apnonce'] ) ) { - return false; + return; } + $nonce = sanitize_text_field( wp_unslash( $_REQUEST['_apnonce'] ) ); if ( ! wp_verify_nonce( $nonce, 'activitypub-user-settings' ) || ! current_user_can( 'edit_user', $user_id ) ) { - return false; + return; } + $description = ! empty( $_POST['activitypub_description'] ) ? sanitize_textarea_field( wp_unslash( $_POST['activitypub_description'] ) ) : false; if ( $description ) { \update_user_option( $user_id, 'activitypub_description', $description ); @@ -415,6 +422,11 @@ class Admin { } } + /** + * Enqueue the admin scripts and styles. + * + * @param string $hook_suffix The current page. + */ public static function enqueue_scripts( $hook_suffix ) { wp_register_script( 'activitypub-header-image', @@ -463,11 +475,9 @@ class Admin { } /** - * Hook into the edit_comment functionality + * Hook into the edit_comment functionality. * - * * Disable the edit_comment capability for federated comments. - * - * @return void + * Disables the edit_comment capability for federated comments. */ public static function edit_comment() { // Disable the edit_comment capability for federated comments. @@ -489,6 +499,11 @@ class Admin { ); } + /** + * Hook into the edit_post functionality. + * + * Disables the edit_post capability for federated posts. + */ public static function edit_post() { // Disable the edit_post capability for federated posts. \add_filter( @@ -516,9 +531,7 @@ class Admin { } /** - * Add ActivityPub specific actions/filters to the post list view - * - * @return void + * Add ActivityPub specific actions/filters to the post list view. */ public static function list_posts() { // Show only the user's extra fields. @@ -546,6 +559,14 @@ class Admin { ); } + /** + * Comment row actions. + * + * @param array $actions The existing actions. + * @param int|\WP_Comment $comment The comment object or ID. + * + * @return array The modified actions. + */ public static function comment_row_actions( $actions, $comment ) { if ( was_comment_received( $comment ) ) { unset( $actions['edit'] ); @@ -556,7 +577,7 @@ class Admin { } /** - * Add a column "activitypub" + * Add a column "activitypub". * * This column shows if the user has the capability to use ActivityPub. * @@ -570,9 +591,11 @@ class Admin { } /** - * Add "comment-type" and "protocol" as column in WP-Admin + * Add "comment-type" and "protocol" as column in WP-Admin. * - * @param array $columns the list of column names + * @param array $columns The list of column names. + * + * @return array The extended list of column names. */ public static function manage_comment_columns( $columns ) { $columns['comment_type'] = esc_attr__( 'Comment-Type', 'activitypub' ); @@ -582,10 +605,12 @@ class Admin { } /** - * Add "post_content" as column for Extra-Fields in WP-Admin + * Add "post_content" as column for Extra-Fields in WP-Admin. * - * @param array $columns Tthe list of column names. + * @param array $columns The list of column names. * @param string $post_type The post type. + * + * @return array The extended list of column names. */ public static function manage_post_columns( $columns, $post_type ) { if ( Extra_Fields::is_extra_fields_post_type( $post_type ) ) { @@ -598,10 +623,10 @@ class Admin { } /** - * Add "comment-type" and "protocol" as column in WP-Admin + * Add "comment-type" and "protocol" as column in WP-Admin. * - * @param array $column The column to implement - * @param int $comment_id The comment id + * @param array $column The column to implement. + * @param int $comment_id The comment id. */ public static function manage_comments_custom_column( $column, $comment_id ) { if ( 'comment_type' === $column && ! defined( 'WEBMENTION_PLUGIN_DIR' ) ) { @@ -639,7 +664,7 @@ class Admin { } /** - * Add a column "extra_field_content" to the post list view + * Add a column "extra_field_content" to the post list view. * * @param string $column_name The column name. * @param int $post_id The post ID. @@ -647,8 +672,6 @@ class Admin { * @return void */ public static function manage_posts_custom_column( $column_name, $post_id ) { - $post = get_post( $post_id ); - if ( 'extra_field_content' === $column_name ) { $post = get_post( $post_id ); if ( Extra_Fields::is_extra_fields_post_type( $post->post_type ) ) { @@ -658,7 +681,7 @@ class Admin { } /** - * Add options to the Bulk dropdown on the users page + * Add options to the Bulk dropdown on the users page. * * @param array $actions The existing bulk options. * @@ -672,7 +695,7 @@ class Admin { } /** - * Handle bulk activitypub requests + * Handle bulk activitypub requests. * * * `add_activitypub_cap` - Add the activitypub capability to the selected users. * * `remove_activitypub_cap` - Remove the activitypub capability from the selected users. @@ -707,7 +730,7 @@ class Admin { } /** - * Add ActivityPub infos to the dashboard glance items + * Add ActivityPub infos to the dashboard glance items. * * @param array $items The existing glance items. * @@ -718,7 +741,7 @@ class Admin { if ( ! is_user_disabled( get_current_user_id() ) ) { $follower_count = sprintf( - // translators: %s: number of followers + // translators: %s: number of followers. _n( '%s Follower', '%s Followers', @@ -737,7 +760,7 @@ class Admin { if ( ! is_user_type_disabled( 'blog' ) && current_user_can( 'manage_options' ) ) { $follower_count = sprintf( - // translators: %s: number of followers + // translators: %s: number of followers. _n( '%s Follower (Blog)', '%s Followers (Blog)', @@ -754,7 +777,7 @@ class Admin { ); } - \remove_filter( 'number_format_i18n', '\Activitypub\custom_large_numbers', 10, 3 ); + \remove_filter( 'number_format_i18n', '\Activitypub\custom_large_numbers' ); return $items; } diff --git a/includes/class-blocks.php b/includes/class-blocks.php index cf7261bc..c42d2fc6 100644 --- a/includes/class-blocks.php +++ b/includes/class-blocks.php @@ -1,24 +1,37 @@ post_type, $ap_post_types, true ) ) { @@ -51,7 +67,7 @@ class Blocks { * Enqueue the reply handle script if the in_reply_to GET param is set. */ public static function handle_in_reply_to_get_param() { - // only load the script if the in_reply_to GET param is set, action happens there, not here. + // Only load the script if the in_reply_to GET param is set, action happens there, not here. // phpcs:ignore WordPress.Security.NonceVerification.Recommended if ( ! isset( $_GET['in_reply_to'] ) ) { return; @@ -62,6 +78,9 @@ class Blocks { wp_enqueue_script( 'activitypub-reply-intent', $plugin_url, $asset_data['dependencies'], $asset_data['version'], true ); } + /** + * Add data to the block editor. + */ public static function add_data() { $context = is_admin() ? 'editor' : 'view'; $followers_handle = 'activitypub-followers-' . $context . '-script'; @@ -78,6 +97,9 @@ class Blocks { \wp_add_inline_script( $follow_me_handle, $js, 'before' ); } + /** + * Register the blocks. + */ public static function register_blocks() { \register_block_type_from_metadata( ACTIVITYPUB_PLUGIN_DIR . '/build/followers', @@ -110,7 +132,7 @@ class Blocks { return absint( $user_string ); } - // if the user string is 'site', return the Blog User ID. + // If the user string is 'site', return the Blog User ID. if ( 'site' === $user_string ) { return User_Collection::BLOG_USER_ID; } @@ -125,7 +147,7 @@ class Blocks { return User_Collection::BLOG_USER_ID; } - // If we're in a loop, use the post author + // If we're in a loop, use the post author. $author_id = get_the_author_meta( 'ID' ); if ( $author_id ) { return $author_id; @@ -197,11 +219,19 @@ class Blocks { return '
'; } + /** + * Render the follower block. + * + * @param array $attrs The block attributes. + * + * @return string The HTML to render. + */ public static function render_follower_block( $attrs ) { $followee_user_id = self::get_user_id( $attrs['selectedUser'] ); if ( is_null( $followee_user_id ) ) { return ''; } + $user = User_Collection::get_by_id( $followee_user_id ); if ( is_wp_error( $user ) ) { return ''; @@ -246,9 +276,15 @@ class Blocks { * * @param array $attrs The block attributes. * - * @return void + * @return string The HTML to render. */ public static function render_reply_block( $attrs ) { + /** + * Filter the reply block. + * + * @param string $html The HTML to render. + * @param array $attrs The block attributes. + */ return apply_filters( 'activitypub_reply_block', sprintf( @@ -262,6 +298,13 @@ class Blocks { ); } + /** + * Render a follower. + * + * @param \Activitypub\Model\Follower $follower The follower to render. + * + * @return string The HTML to render. + */ public static function render_follower( $follower ) { $external_svg = ''; $template = diff --git a/includes/class-cli.php b/includes/class-cli.php index b30cdb9f..64b4b8ab 100644 --- a/includes/class-cli.php +++ b/includes/class-cli.php @@ -1,58 +1,61 @@ * - * @param array|null $args The arguments. - * @param array|null $assoc_args The associative arguments. - * - * @return void + * @param array|null $args The arguments. */ - public function post( $args, $assoc_args ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable + public function post( $args ) { $post = get_post( $args[1] ); if ( ! $post ) { @@ -170,12 +170,9 @@ class Cli extends WP_CLI_Command { * * @synopsis * - * @param array|null $args The arguments. - * @param array|null $assoc_args The associative arguments. - * - * @return void + * @param array|null $args The arguments. */ - public function comment( $args, $assoc_args ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable + public function comment( $args ) { $comment = get_comment( $args[1] ); if ( ! $comment ) { diff --git a/includes/class-comment.php b/includes/class-comment.php index 2d869f33..525a3543 100644 --- a/includes/class-comment.php +++ b/includes/class-comment.php @@ -1,22 +1,24 @@ user_id; - // comments without user can't be federated + // Comments without user can't be federated. if ( ! $user_id ) { return false; } if ( is_single_user() && \user_can( $user_id, 'publish_posts' ) ) { - // On a single user site, comments by users with the `publish_posts` capability will be federated as the blog user + // On a single user site, comments by users with the `publish_posts` capability will be federated as the blog user. $user_id = Users::BLOG_USER_ID; } $is_user_disabled = is_user_disabled( $user_id ); - // user is disabled for federation + // User is disabled for federation. if ( $is_user_disabled ) { return false; } - // it is a comment to the post and can be federated + // It is a comment to the post and can be federated. if ( empty( $comment->comment_parent ) ) { return true; } - // check if parent comment is federated + // Check if parent comment is federated. $parent_comment = \get_comment( $comment->comment_parent ); return ! self::is_local( $parent_comment ); @@ -269,18 +272,18 @@ class Comment { /** * Verify if URL is a local comment, or if it is a previously received - * remote comment (For threading comments locally) + * remote comment (For threading comments locally). * * @param string $url The URL to check. * - * @return int comment_ID or null if not found + * @return string|null Comment ID or null if not found. */ public static function url_to_commentid( $url ) { if ( ! $url || ! filter_var( $url, \FILTER_VALIDATE_URL ) ) { return null; } - // check for local comment + // Check for local comment. if ( \wp_parse_url( \home_url(), \PHP_URL_HOST ) === \wp_parse_url( $url, \PHP_URL_HOST ) ) { $query = \wp_parse_url( $url, \PHP_URL_QUERY ); @@ -332,7 +335,7 @@ class Comment { * @return string[] An array of classes. */ public static function comment_class( $classes, $css_class, $comment_id ) { - // check if ActivityPub comment + // Check if ActivityPub comment. if ( 'activitypub' === get_comment_meta( $comment_id, 'protocol', true ) ) { $classes[] = 'activitypub-comment'; } @@ -383,8 +386,8 @@ class Comment { /** * Link remote comments to source url. * - * @param string $comment_link - * @param object|WP_Comment $comment + * @param string $comment_link The comment link. + * @param object|\WP_Comment $comment The comment object. * * @return string $url */ @@ -402,21 +405,21 @@ class Comment { /** * Generates an ActivityPub URI for a comment * - * @param WP_Comment|int $comment A comment object or comment ID + * @param \WP_Comment|int $comment A comment object or comment ID. * * @return string ActivityPub URI for comment */ public static function generate_id( $comment ) { $comment = \get_comment( $comment ); - // show external comment ID if it exists + // Show external comment ID if it exists. $public_comment_link = self::get_source_id( $comment->comment_ID ); if ( $public_comment_link ) { return $public_comment_link; } - // generate URI based on comment ID + // Generate URI based on comment ID. return \add_query_arg( 'c', $comment->comment_ID, \trailingslashit( \home_url() ) ); } @@ -455,22 +458,22 @@ class Comment { */ public static function enqueue_scripts() { if ( ! \is_singular() || \is_user_logged_in() ) { - // only on single pages, only for logged out users + // Only on single pages, only for logged-out users. return; } if ( ! \post_type_supports( \get_post_type(), 'activitypub' ) ) { - // post type does not support ActivityPub + // Post type does not support ActivityPub. return; } if ( ! \comments_open() || ! \get_comments_number() ) { - // no comments, no need to load the script + // No comments, no need to load the script. return; } if ( ! self::post_has_remote_comments( \get_the_ID() ) ) { - // no remote comments, no need to load the script + // No remote comments, no need to load the script. return; } @@ -514,9 +517,9 @@ class Comment { } /** - * Is this a registered comment type + * Is this a registered comment type. * - * @param string $slug The name of the type + * @param string $slug The name of the type. * @return boolean True if registered. */ public static function is_registered_comment_type( $slug ) { @@ -529,18 +532,18 @@ class Comment { /** * Return the registered custom comment types names. * - * @return array The registered custom comment type names + * @return array The registered custom comment type names. */ public static function get_comment_type_names() { return array_values( wp_list_pluck( self::get_comment_types(), 'type' ) ); } /** - * Get a comment type + * Get a comment type. * - * @param string $type The comment type + * @param string $type The comment type. * - * @return array The comment type + * @return array The comment type. */ public static function get_comment_type( $type ) { $type = strtolower( $type ); @@ -553,16 +556,21 @@ class Comment { $type_array = array(); } + /** + * Filter the comment type. + * + * @param array $type_array The comment type. + */ return apply_filters( "activitypub_comment_type_{$type}", $type_array ); } /** - * Get a comment type attribute + * Get a comment type attribute. * - * @param string $type The comment type - * @param string $attr The attribute to get + * @param string $type The comment type. + * @param string $attr The attribute to get. * - * @return mixed The value of the attribute + * @return mixed The value of the attribute. */ public static function get_comment_type_attr( $type, $attr ) { $type_array = self::get_comment_type( $type ); @@ -573,15 +581,17 @@ class Comment { $value = ''; } + /** + * Filter the comment type attribute. + * + * @param mixed $value The value of the attribute. + * @param string $type The comment type. + */ return apply_filters( "activitypub_comment_type_{$attr}", $value, $type ); } - - /** - * Register the comment types used by the ActivityPub plugin - * - * @return void + * Register the comment types used by the ActivityPub plugin. */ public static function register_comment_types() { register_comment_type( @@ -593,7 +603,7 @@ class Comment { 'icon' => '♻️', 'class' => 'p-repost', 'type' => 'repost', - // translators: %1$s username, %2$s opject format (post, audio, ...), %3$s URL, %4$s domain + // translators: %1$s username, %2$s object format (post, audio, ...), %3$s URL, %4$s domain. 'excerpt' => __( '… reposted this!', 'activitypub' ), ) ); @@ -607,16 +617,16 @@ class Comment { 'icon' => '👍', 'class' => 'p-like', 'type' => 'like', - // translators: %1$s username, %2$s opject format (post, audio, ...), %3$s URL, %4$s domain + // translators: %1$s username, %2$s object format (post, audio, ...), %3$s URL, %4$s domain. 'excerpt' => __( '… liked this!', 'activitypub' ), ) ); } /** - * Show avatars on Activities if set + * Show avatars on Activities if set. * - * @param array $types list of avatar enabled comment types + * @param array $types List of avatar enabled comment types. * * @return array show avatars on Activities */ @@ -634,7 +644,7 @@ class Comment { * * @see https://github.com/janboddez/indieblocks/blob/a2d59de358031056a649ee47a1332ce9e39d4ce2/includes/functions.php#L423-L432 * - * @param WP_Comment_Query $query Comment count. + * @param WP_Comment_Query $query Comment count. */ public static function comment_query( $query ) { if ( ! $query instanceof WP_Comment_Query ) { diff --git a/includes/class-debug.php b/includes/class-debug.php index bfd393eb..ebca0534 100644 --- a/includes/class-debug.php +++ b/includes/class-debug.php @@ -1,46 +1,66 @@ post_content, $match ) ) { @@ -64,25 +66,23 @@ class Hashtag { $tags = \implode( ', ', $tags ); \wp_add_post_tags( $post->ID, $tags ); - - return $id; } /** - * Filter to replace the #tags in the content with links + * Filter to replace the #tags in the content with links. * - * @param string $the_content the post-content + * @param string $the_content The post content. * - * @return string the filtered post-content + * @return string The filtered post content. */ public static function the_content( $the_content ) { return enrich_content_data( $the_content, '/' . ACTIVITYPUB_HASHTAGS_REGEXP . '/i', array( self::class, 'replace_with_links' ) ); } /** - * A callback for preg_replace to build the term links + * A callback for preg_replace to build the term links. * - * @param array $result the preg_match results + * @param array $result The preg_match results. * @return string the final string */ public static function replace_with_links( $result ) { @@ -94,7 +94,7 @@ class Hashtag { if ( $tag_object ) { $link = \get_term_link( $tag_object, 'post_tag' ); - return \sprintf( '', $link, $tag ); + return \sprintf( '', esc_url( $link ), $tag ); } return '#' . $tag; diff --git a/includes/class-health-check.php b/includes/class-health-check.php index 7e782f3d..65e6a9e4 100644 --- a/includes/class-health-check.php +++ b/includes/class-health-check.php @@ -1,31 +1,37 @@ %s %s

', - __( 'https://developer.wordpress.org/plugins/cron/hooking-wp-cron-into-the-system-task-scheduler/', 'activitypub' ), + 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' ) @@ -124,7 +130,7 @@ class Health_Check { } /** - * WebFinger tests + * WebFinger tests. * * @return array */ @@ -162,21 +168,21 @@ class Health_Check { } /** - * Check if `author_posts_url` is accessible and that request returns correct JSON + * Check if `author_posts_url` is accessible and that request returns correct JSON. * - * @return boolean|WP_Error + * @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 + // Check for "author" in URL. if ( $author_url !== $reference_author_url ) { return new WP_Error( 'author_url_not_accessible', \sprintf( - // translators: %s: Author URL + // translators: %s: Author URL. \__( 'Your author URL %s was replaced, this is often done by plugins.', 'activitypub' @@ -186,7 +192,7 @@ class Health_Check { ); } - // try to access author URL + // Try to access author URL. $response = \wp_remote_get( $author_url, array( @@ -199,7 +205,7 @@ class Health_Check { return new WP_Error( 'author_url_not_accessible', \sprintf( - // translators: %s: Author URL + // translators: %s: Author URL. \__( 'Your author URL %s 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' @@ -211,12 +217,12 @@ class Health_Check { $response_code = \wp_remote_retrieve_response_code( $response ); - // check for redirects + // 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 + // translators: %s: Author URL. \__( 'Your author URL %s is redirecting to another page, this is often done by SEO plugins like "Yoast SEO".', 'activitypub' @@ -226,14 +232,14 @@ class Health_Check { ); } - // check if response is JSON + // 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 + // translators: %s: Author URL. \__( 'Your author URL %s does not return valid JSON for application/activity+json. Please check if your hosting supports alternate Accept headers.', 'activitypub' @@ -260,7 +266,7 @@ class Health_Check { $allowed = array( 'code' => array() ); $not_accessible = wp_kses( - // translators: %s: Author URL + // translators: %s: Author URL. \__( 'Your WebFinger endpoint %s is not accessible. Please check your WordPress setup or permalink structure.', 'activitypub' @@ -268,7 +274,7 @@ class Health_Check { $allowed ); $invalid_response = wp_kses( - // translators: %s: Author URL + // translators: %s: Author URL. \__( 'Your WebFinger endpoint %s does not return valid JSON for application/jrd+json.', 'activitypub' @@ -282,7 +288,7 @@ class Health_Check { $url->get_error_data()['data'] ), 'webfinger_url_invalid_response' => \sprintf( - // translators: %s: Author URL + // translators: %s: Author URL. $invalid_response, $url->get_error_data()['data'] ), @@ -291,6 +297,7 @@ class Health_Check { if ( isset( $health_messages[ $url->get_error_code() ] ) ) { $message = $health_messages[ $url->get_error_code() ]; } + return new WP_Error( $url->get_error_code(), $message, @@ -304,7 +311,7 @@ class Health_Check { /** * Retrieve the URL to the author page for the user with the ID provided. * - * @global WP_Rewrite $wp_rewrite WordPress rewrite component. + * @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. @@ -313,6 +320,7 @@ class Health_Check { */ 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(); diff --git a/includes/class-http.php b/includes/class-http.php index 7cc5f9ae..133a3469 100644 --- a/includes/class-http.php +++ b/includes/class-http.php @@ -1,11 +1,15 @@ $code ) ); } + /** + * Action to save the response of the remote POST request. + * + * @param array|WP_Error $response The response of the remote POST request. + * @param string $url The URL endpoint. + * @param string $body The Post Body. + * @param int $user_id The WordPress User-ID. + */ \do_action( 'activitypub_safe_remote_post_response', $response, $url, $body, $user_id ); return $response; } /** - * Send a GET Request with the needed HTTP Headers + * Send a GET Request with the needed HTTP Headers. * - * @param string $url The URL endpoint - * @param bool|int $cached If the result should be cached, or its duration. Default: 1hr. + * @param string $url The URL endpoint. + * @param bool|int $cached Optional. Whether the result should be cached, or its duration. Default false. * - * @return array|WP_Error The GET Response or an WP_ERROR + * @return array|WP_Error The GET Response or a WP_Error. */ public static function get( $url, $cached = false ) { \do_action( 'activitypub_pre_http_get', $url ); @@ -80,6 +92,12 @@ class Http { $response = \get_transient( $transient_key ); if ( $response ) { + /** + * Action to save the response of the remote GET request. + * + * @param array|WP_Error $response The response of the remote GET request. + * @param string $url The URL endpoint. + */ \do_action( 'activitypub_safe_remote_get_response', $response, $url ); return $response; @@ -118,6 +136,12 @@ class Http { $response = new WP_Error( $code, __( 'Failed HTTP Request', 'activitypub' ), array( 'status' => $code ) ); } + /** + * Action to save the response of the remote GET request. + * + * @param array|WP_Error $response The response of the remote GET request. + * @param string $url The URL endpoint. + */ \do_action( 'activitypub_safe_remote_get_response', $response, $url ); if ( $cached ) { @@ -139,6 +163,11 @@ class Http { * @return bool True if the URL is a tombstone. */ public static function is_tombstone( $url ) { + /** + * Action before checking if the URL is a tombstone. + * + * @param string $url The URL to check. + */ \do_action( 'activitypub_pre_http_is_tombstone', $url ); $response = \wp_safe_remote_get( $url ); @@ -151,15 +180,22 @@ class Http { return false; } + /** + * Generate a cache key for the URL. + * + * @param string $url The URL to generate the cache key for. + * + * @return string The cache key. + */ public static function generate_cache_key( $url ) { return 'activitypub_http_' . \md5( $url ); } /** - * Requests the Data from the Object-URL or Object-Array + * Requests the Data from the Object-URL or Object-Array. * * @param array|string $url_or_object The Object or the Object URL. - * @param bool $cached If the result should be cached. + * @param bool $cached Optional. Whether the result should be cached. Default true. * * @return array|WP_Error The Object data as array or WP_Error on failure. */ @@ -204,7 +240,7 @@ class Http { $transient_key = self::generate_cache_key( $url ); - // only check the cache if needed. + // Only check the cache if needed. if ( $cached ) { $data = \get_transient( $transient_key ); diff --git a/includes/class-link.php b/includes/class-link.php index 52a81400..3c53f3bb 100644 --- a/includes/class-link.php +++ b/includes/class-link.php @@ -1,61 +1,66 @@ 'ID' ) ) as $user_id ) { $followers = get_user_meta( $user_id, 'activitypub_followers', true ); @@ -210,9 +208,7 @@ class Migration { } /** - * Clear the cache after updating to 1.3.0 - * - * @return void + * Clear the cache after updating to 1.3.0. */ private static function migrate_from_1_2_0() { $user_ids = \get_users( @@ -228,9 +224,7 @@ class Migration { } /** - * Unschedule Hooks after updating to 2.0.0 - * - * @return void + * Unschedule Hooks after updating to 2.0.0. */ private static function migrate_from_2_0_0() { wp_clear_scheduled_hook( 'activitypub_send_post_activity' ); @@ -249,19 +243,15 @@ class Migration { /** * Add the ActivityPub capability to all users that can publish posts - * Delete old meta to store followers - * - * @return void + * Delete old meta to store followers. */ private static function migrate_from_2_2_0() { - // add the ActivityPub capability to all users that can publish posts + // Add the ActivityPub capability to all users that can publish posts. self::add_activitypub_capability(); } /** - * Rename DB fields - * - * @return void + * Rename DB fields. */ private static function migrate_from_2_6_0() { wp_cache_flush(); @@ -273,30 +263,26 @@ class Migration { } /** - * Set the defaults needed for the plugin to work + * Set the defaults needed for the plugin to work. * - * * Add the ActivityPub capability to all users that can publish posts - * - * @return void + * Add the ActivityPub capability to all users that can publish posts. */ public static function add_default_settings() { self::add_activitypub_capability(); } /** - * Add the ActivityPub capability to all users that can publish posts - * - * @return void + * Add the ActivityPub capability to all users that can publish posts. */ private static function add_activitypub_capability() { - // get all WP_User objects that can publish posts + // Get all WP_User objects that can publish posts. $users = \get_users( array( 'capability__in' => array( 'publish_posts' ), ) ); - // add ActivityPub capability to all users that can publish posts + // Add ActivityPub capability to all users that can publish posts. foreach ( $users as $user ) { $user->add_cap( 'activitypub' ); } @@ -305,16 +291,16 @@ class Migration { /** * Rename meta keys. * - * @param string $old The old commentmeta key - * @param string $new The new commentmeta key + * @param string $old_key The old comment meta key. + * @param string $new_key The new comment meta key. */ - private static function update_usermeta_key( $old, $new ) { // phpcs:ignore + private static function update_usermeta_key( $old_key, $new_key ) { global $wpdb; - $wpdb->update( // phpcs:ignore + $wpdb->update( // phpcs:ignore WordPress.DB.DirectDatabaseQuery $wpdb->usermeta, - array( 'meta_key' => $new ), // phpcs:ignore - array( 'meta_key' => $old ), // phpcs:ignore + array( 'meta_key' => $new_key ), // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key + array( 'meta_key' => $old_key ), // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key array( '%s' ), array( '%s' ) ); @@ -323,16 +309,16 @@ class Migration { /** * Rename option keys. * - * @param string $old The old option key - * @param string $new The new option key + * @param string $old_key The old option key. + * @param string $new_key The new option key. */ - private static function update_options_key( $old, $new ) { // phpcs:ignore + private static function update_options_key( $old_key, $new_key ) { global $wpdb; - $wpdb->update( // phpcs:ignore + $wpdb->update( // phpcs:ignore WordPress.DB.DirectDatabaseQuery $wpdb->options, - array( 'option_name' => $new ), // phpcs:ignore - array( 'option_name' => $old ), // phpcs:ignore + array( 'option_name' => $new_key ), // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key + array( 'option_name' => $old_key ), // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key array( '%s' ), array( '%s' ) ); diff --git a/includes/class-notification.php b/includes/class-notification.php index 3aed0207..bab72774 100644 --- a/includes/class-notification.php +++ b/includes/class-notification.php @@ -1,4 +1,9 @@ user_id ) { return; } @@ -211,7 +207,7 @@ class Scheduler { return; } - // check if comment should be federated or not + // Check if comment should be federated or not. if ( ! should_comment_be_federated( $comment ) ) { return; } @@ -226,9 +222,7 @@ class Scheduler { } /** - * Update followers - * - * @return void + * Update followers. */ public static function update_followers() { $number = 5; @@ -237,6 +231,11 @@ class Scheduler { $number = 50; } + /** + * Filter the number of followers to update. + * + * @param int $number The number of followers to update. + */ $number = apply_filters( 'activitypub_update_followers_number', $number ); $followers = Followers::get_outdated_followers( $number ); @@ -253,9 +252,7 @@ class Scheduler { } /** - * Cleanup followers - * - * @return void + * Cleanup followers. */ public static function cleanup_followers() { $number = 5; @@ -264,6 +261,11 @@ class Scheduler { $number = 50; } + /** + * Filter the number of followers to clean up. + * + * @param int $number The number of followers to clean up. + */ $number = apply_filters( 'activitypub_update_followers_number', $number ); $followers = Followers::get_faulty_followers( $number ); @@ -292,18 +294,17 @@ class Scheduler { /** * Send a profile update when relevant user meta is updated. * - * @param int $meta_id Meta ID being updated. - * @param int $user_id User ID being updated. + * @param int $meta_id Meta ID being updated. + * @param int $user_id User ID being updated. * @param string $meta_key Meta key being updated. - * - * @return void */ public static function user_meta_update( $meta_id, $user_id, $meta_key ) { - // don't bother if the user can't publish + // Don't bother if the user can't publish. if ( ! \user_can( $user_id, 'activitypub' ) ) { return; } - // the user meta fields that affect a profile. + + // The user meta fields that affect a profile. $fields = array( 'activitypub_description', 'activitypub_header_image', @@ -319,12 +320,10 @@ class Scheduler { /** * Send a profile update when a user is updated. * - * @param int $user_id User ID being updated. - * - * @return void + * @param int $user_id User ID being updated. */ public static function user_update( $user_id ) { - // don't bother if the user can't publish + // Don't bother if the user can't publish. if ( ! \user_can( $user_id, 'activitypub' ) ) { return; } @@ -335,7 +334,7 @@ class Scheduler { /** * Theme mods only have a dynamic filter so we fudge it like this. * - * @param mixed $value + * @param mixed $value Optional. The value to be updated. Default null. * * @return mixed */ diff --git a/includes/class-shortcodes.php b/includes/class-shortcodes.php index 06bb796e..eb9c5135 100644 --- a/includes/class-shortcodes.php +++ b/includes/class-shortcodes.php @@ -1,12 +1,18 @@ post_type ) { - // get title of attachment with fallback to alt text. + // Get title of attachment with fallback to alt text. $content = wp_get_attachment_caption( $item->ID ); if ( empty( $content ) ) { $content = get_post_meta( $item->ID, '_wp_attachment_image_alt', true ); @@ -154,7 +156,7 @@ class Shortcodes { $content = wp_filter_content_tags( $content ); } - // replace script and style elements + // Replace script and style elements. $content = \preg_replace( '@<(script|style)[^>]*?>.*?@si', '', $content ); $content = strip_shortcodes( $content ); $content = \trim( \preg_replace( '/[\n\r\t]/', '', $content ) ); @@ -166,7 +168,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_permalink' Shortcode + * Generates output for the 'ap_permalink' Shortcode. * * @param array $atts The Shortcode attributes. * @param string $content The ActivityPub post-content. @@ -200,7 +202,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_shortlink' Shortcode + * Generates output for the 'ap_shortlink' Shortcode. * * @param array $atts The Shortcode attributes. * @param string $content The ActivityPub post-content. @@ -234,7 +236,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_image' Shortcode + * Generates output for the 'ap_image' Shortcode. * * @param array $atts The Shortcode attributes. * @param string $content The ActivityPub post-content. @@ -277,7 +279,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_hashcats' Shortcode + * Generates output for the 'ap_hashcats' Shortcode. * * @return string The post categories as hashtags. */ @@ -308,7 +310,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_author' Shortcode + * Generates output for the 'ap_author' Shortcode. * * @return string The author name. */ @@ -330,7 +332,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_authorurl' Shortcode + * Generates output for the 'ap_authorurl' Shortcode. * * @return string The author URL. */ @@ -352,7 +354,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_blogurl' Shortcode + * Generates output for the 'ap_blogurl' Shortcode. * * @return string The site URL. */ @@ -361,7 +363,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_blogname' Shortcode + * Generates output for the 'ap_blogname' Shortcode. * * @return string */ @@ -370,7 +372,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_blogdesc' Shortcode + * Generates output for the 'ap_blogdesc' Shortcode. * * @return string The site description. */ @@ -379,7 +381,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_date' Shortcode + * Generates output for the 'ap_date' Shortcode. * * @return string The post date. */ @@ -403,7 +405,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_time' Shortcode + * Generates output for the 'ap_time' Shortcode. * * @return string The post time. */ @@ -427,7 +429,7 @@ class Shortcodes { } /** - * Generates output for the 'ap_datetime' Shortcode + * Generates output for the 'ap_datetime' Shortcode. * * @return string The post date/time. */ @@ -457,7 +459,7 @@ class Shortcodes { * Checks if item (WP_Post) is "public", a supported post type * and not password protected. * - * @return null|WP_Post The WordPress item. + * @return null|\WP_Post The WordPress item. */ protected static function get_item() { $post = \get_post(); diff --git a/includes/class-signature.php b/includes/class-signature.php index 07831583..aa2a109b 100644 --- a/includes/class-signature.php +++ b/includes/class-signature.php @@ -1,4 +1,10 @@ $detail['key'], ); - // persist keys + // Persist keys. \add_option( $option_key, $key_pair ); return $key_pair; @@ -135,7 +141,7 @@ class Signature { if ( $user_id > 0 ) { $user = \get_userdata( $user_id ); - // sanatize username because it could include spaces and special chars + // Sanitize username because it could include spaces and special chars. $id = sanitize_title( $user->user_login ); } @@ -176,13 +182,13 @@ class Signature { } /** - * Generates the Signature for a HTTP Request + * Generates the Signature for an HTTP Request. * * @param int $user_id The WordPress User ID. * @param string $http_method The HTTP method. * @param string $url The URL to send the request to. * @param string $date The date the request is sent. - * @param string $digest The digest of the request body. + * @param string $digest Optional. The digest of the request body. Default null. * * @return string The signature. */ @@ -195,12 +201,12 @@ class Signature { $host = $url_parts['host']; $path = '/'; - // add path + // Add path. if ( ! empty( $url_parts['path'] ) ) { $path = $url_parts['path']; } - // add query + // Add query. if ( ! empty( $url_parts['query'] ) ) { $path .= '?' . $url_parts['query']; } @@ -231,18 +237,18 @@ class Signature { * * @param WP_REST_Request|array $request The request object or $_SERVER array. * - * @return mixed A boolean or WP_Error. + * @return bool|WP_Error A boolean or WP_Error. */ public static function verify_http_signature( $request ) { - if ( is_object( $request ) ) { // REST Request object - // check if route starts with "index.php" + if ( is_object( $request ) ) { // REST Request object. + // Check if route starts with "index.php". if ( str_starts_with( $request->get_route(), '/index.php' ) || ! rest_get_url_prefix() ) { $route = $request->get_route(); } else { $route = '/' . rest_get_url_prefix() . '/' . ltrim( $request->get_route(), '/' ); } - // fix route for subdirectory installs + // Fix route for subdirectory installs. $path = \wp_parse_url( \get_home_url(), PHP_URL_PATH ); if ( \is_string( $path ) ) { @@ -323,14 +329,14 @@ class Signature { } /** - * Get public key from key_id + * Get public key from key_id. * * @param string $key_id The URL to the public key. * * @return WP_Error|string The public key or WP_Error. */ - public static function get_remote_key( $key_id ) { // phpcs:ignore - $actor = get_remote_metadata_by_actor( strip_fragment_from_url( $key_id ) ); // phpcs:ignore + public static function get_remote_key( $key_id ) { + $actor = get_remote_metadata_by_actor( strip_fragment_from_url( $key_id ) ); if ( \is_wp_error( $actor ) ) { return new WP_Error( 'activitypub_no_remote_profile_found', @@ -349,9 +355,9 @@ class Signature { } /** - * Gets the signature algorithm from the signature header + * Gets the signature algorithm from the signature header. * - * @param array $signature_block + * @param array $signature_block The signature block. * * @return string The signature algorithm. */ @@ -359,7 +365,7 @@ class Signature { if ( $signature_block['algorithm'] ) { switch ( $signature_block['algorithm'] ) { case 'rsa-sha-512': - return 'sha512'; // hs2019 https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures-12 + return 'sha512'; // hs2019 https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures-12. default: return 'sha256'; } @@ -368,11 +374,11 @@ class Signature { } /** - * Parses the Signature header + * Parses the Signature header. * * @param string $signature The signature header. * - * @return array signature parts + * @return array Signature parts. */ public static function parse_signature_header( $signature ) { $parsed_header = array(); @@ -405,16 +411,17 @@ class Signature { } /** - * Gets the header data from the included pseudo headers + * Gets the header data from the included pseudo headers. * * @param array $signed_headers The signed headers. - * @param array $signature_block (pseudo-headers) - * @param array $headers (http headers) + * @param array $signature_block The signature block. + * @param array $headers The HTTP headers. * * @return string signed headers for comparison */ public static function get_signed_data( $signed_headers, $signature_block, $headers ) { $signed_data = ''; + // This also verifies time-based values by returning false if any of these are out of range. foreach ( $signed_headers as $header ) { if ( 'host' === $header ) { @@ -433,7 +440,7 @@ class Signature { } if ( '(created)' === $header ) { if ( ! empty( $signature_block['(created)'] ) && \intval( $signature_block['(created)'] ) > \time() ) { - // created in future + // Created in the future. return false; } @@ -444,7 +451,7 @@ class Signature { } if ( '(expires)' === $header ) { if ( ! empty( $signature_block['(expires)'] ) && \intval( $signature_block['(expires)'] ) < \time() ) { - // expired in past + // Expired in the past. return false; } @@ -454,7 +461,7 @@ class Signature { } } if ( 'date' === $header ) { - // allow a bit of leeway for misconfigured clocks. + // Allow a bit of leeway for misconfigured clocks. $d = new DateTime( $headers[ $header ][0] ); $d->setTimeZone( new DateTimeZone( 'UTC' ) ); $c = $d->format( 'U' ); @@ -463,7 +470,7 @@ class Signature { $dminus = time() - ( 3 * HOUR_IN_SECONDS ); if ( $c > $dplus || $c < $dminus ) { - // time out of range + // Time out of range. return false; } } @@ -473,22 +480,22 @@ class Signature { } /** - * Generates the digest for a HTTP Request + * Generates the digest for an HTTP Request. * * @param string $body The body of the request. * * @return string The digest. */ public static function generate_digest( $body ) { - $digest = \base64_encode( \hash( 'sha256', $body, true ) ); // phpcs:ignore + $digest = \base64_encode( \hash( 'sha256', $body, true ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode return "SHA-256=$digest"; } /** * Formats the $_SERVER to resemble the WP_REST_REQUEST array, - * for use with verify_http_signature() + * for use with verify_http_signature(). * - * @param array $_SERVER The $_SERVER array. + * @param array $server The $_SERVER array. * * @return array $request The formatted request array. */ diff --git a/includes/class-webfinger.php b/includes/class-webfinger.php index f26de250..f6a189af 100644 --- a/includes/class-webfinger.php +++ b/includes/class-webfinger.php @@ -1,11 +1,17 @@ @ + * Transform a URI to an acct @. * - * @param string $uri The URI (acct:, mailto:, http:, https:) + * @param string $uri The URI (acct:, mailto:, http:, https:). * - * @return string|WP_Error Error or acct URI + * @return string|WP_Error Error or acct URI. */ public static function uri_to_acct( $uri ) { $data = self::get_data( $uri ); @@ -89,7 +95,7 @@ class Webfinger { return $data; } - // check if subject is an acct URI + // Check if subject is an acct URI. if ( isset( $data['subject'] ) && \str_starts_with( $data['subject'], 'acct:' ) @@ -97,7 +103,7 @@ class Webfinger { return $data['subject']; } - // search for an acct URI in the aliases + // Search for an acct URI in the aliases. if ( isset( $data['aliases'] ) ) { foreach ( $data['aliases'] as $alias ) { if ( \str_starts_with( $alias, 'acct:' ) ) { @@ -120,10 +126,9 @@ class Webfinger { * Convert a URI string to an identifier and its host. * Automatically adds acct: if it's missing. * - * @param string $url The URI (acct:, mailto:, http:, https:) + * @param string $url The URI (acct:, mailto:, http:, https:). * - * @return WP_Error|array Error reaction or array with - * identifier and host as values + * @return WP_Error|array Error reaction or array with identifier and host as values. */ public static function get_identifier_and_host( $url ) { if ( ! $url ) { @@ -137,7 +142,7 @@ class Webfinger { ); } - // remove leading @ + // Remove leading @. $url = ltrim( $url, '@' ); if ( ! preg_match( '/^([a-zA-Z+]+):/', $url, $match ) ) { @@ -178,12 +183,11 @@ class Webfinger { } /** - * Get the WebFinger data for a given URI + * Get the WebFinger data for a given URI. * - * @param string $uri The Identifier: @ or URI + * @param string $uri The Identifier: @ or URI. * - * @return WP_Error|array Error reaction or array with - * identifier and host as values + * @return WP_Error|array Error reaction or array with identifier and host as values. */ public static function get_data( $uri ) { $identifier_and_host = self::get_identifier_and_host( $uri ); @@ -234,7 +238,9 @@ class Webfinger { } /** - * Get the Remote-Follow endpoint for a given URI + * Get the Remote-Follow endpoint for a given URI. + * + * @param string $uri The WebFinger Resource URI. * * @return string|WP_Error Error or the Remote-Follow endpoint URI. */ @@ -273,11 +279,11 @@ class Webfinger { } /** - * Generate a cache key for a given URI + * Generate a cache key for a given URI. * - * @param string $uri A WebFinger Resource URI + * @param string $uri A WebFinger Resource URI. * - * @return string The cache key + * @return string The cache key. */ public static function generate_cache_key( $uri ) { $uri = ltrim( $uri, '@' ); diff --git a/includes/collection/class-extra-fields.php b/includes/collection/class-extra-fields.php index 25362e9f..320ed478 100644 --- a/includes/collection/class-extra-fields.php +++ b/includes/collection/class-extra-fields.php @@ -1,13 +1,19 @@ ]*?>.*?@si', '', $content ); $content = \strip_shortcodes( $content ); $content = \trim( \preg_replace( '/[\n\r\t]/', '', $content ) ); - $content = \apply_filters( 'activitypub_extra_field_content', $content, $post ); - return $content; + /** + * Filters the content of an extra field. + * + * @param string $content The content. + * @param \WP_Post $post The post. + */ + return \apply_filters( 'activitypub_extra_field_content', $content, $post ); } /** - * Transforms the Extra Fields (Cutom Post Types) to ActivityPub Actor-Attachments. + * Transforms the Extra Fields (Custom Post Types) to ActivityPub Actor-Attachments. * * @param \WP_Post[] $fields The extra fields. * @@ -88,7 +107,7 @@ class Extra_Fields { $link_added = false; - // Add support for FEP-fb2a, for more information see FEDERATION.md + // Add support for FEP-fb2a, for more information see FEDERATION.md. $link_content = \trim( \strip_tags( $content, '' ) ); if ( \stripos( $link_content, 'get_posts() ); + return compact( 'followers', 'total' ); } /** - * Get all Followers - * - * @param array $args The WP_Query arguments. + * Get all Followers. * * @return array The Term list of Followers. */ @@ -219,7 +225,7 @@ class Followers { /** * Count the total number of followers * - * @param int $user_id The ID of the WordPress User + * @param int $user_id The ID of the WordPress User. * * @return int The number of Followers */ @@ -251,11 +257,11 @@ class Followers { } /** - * Returns all Inboxes fo a Users Followers + * Returns all Inboxes for a Users Followers. * - * @param int $user_id The ID of the WordPress User + * @param int $user_id The ID of the WordPress User. * - * @return array The list of Inboxes + * @return array The list of Inboxes. */ public static function get_inboxes( $user_id ) { $cache_key = sprintf( self::CACHE_KEY_INBOXES, $user_id ); @@ -265,7 +271,7 @@ class Followers { return $inboxes; } - // get all Followers of a ID of the WordPress User + // Get all Followers of a ID of the WordPress User. $posts = new WP_Query( array( 'nopaging' => true, @@ -316,13 +322,12 @@ class Followers { } /** - * Get all Followers that have not been updated for a given time + * 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. + * @param int $number Optional. Limits the result. Default 50. + * @param int $older_than Optional. The time in seconds. Default 86400 (1 day). * - * @return mixed The Term list of Followers, the format depends on $output. + * @return array The Term list of Followers. */ public static function get_outdated_followers( $number = 50, $older_than = 86400 ) { $args = array( @@ -330,7 +335,7 @@ class Followers { 'posts_per_page' => $number, 'orderby' => 'modified', 'order' => 'ASC', - 'post_status' => 'any', // 'any' includes 'trash + 'post_status' => 'any', // 'any' includes 'trash'. 'date_query' => array( array( 'column' => 'post_modified_gmt', @@ -343,19 +348,18 @@ class Followers { $items = array(); foreach ( $posts->get_posts() as $follower ) { - $items[] = Follower::init_from_cpt( $follower ); // phpcs:ignore + $items[] = Follower::init_from_cpt( $follower ); } return $items; } /** - * Get all Followers that had errors + * 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. + * @param int $number Optional. The number of Followers to return. Default 20. * - * @return mixed The Term list of Followers, the format depends on $output. + * @return array The Term list of Followers. */ public static function get_faulty_followers( $number = 20 ) { $args = array( @@ -393,7 +397,7 @@ class Followers { $items = array(); foreach ( $posts->get_posts() as $follower ) { - $items[] = Follower::init_from_cpt( $follower ); // phpcs:ignore + $items[] = Follower::init_from_cpt( $follower ); } return $items; @@ -403,8 +407,7 @@ class Followers { * 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. + * The error will be stored in 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. diff --git a/includes/collection/class-interactions.php b/includes/collection/class-interactions.php index 802070a6..36262e86 100644 --- a/includes/collection/class-interactions.php +++ b/includes/collection/class-interactions.php @@ -1,7 +1,12 @@ comment_post_ID; } - // not a reply to a post or comment + // Not a reply to a post or comment. if ( ! $comment_post_id ) { return false; } @@ -53,16 +58,16 @@ class Interactions { } /** - * Update a comment + * Update a comment. * - * @param array $activity The activity-object + * @param array $activity The activity object. * - * @return array|string|int|\WP_Error|false The commentdata or false on failure + * @return array|string|int|\WP_Error|false The comment data or false on failure. */ public static function update_comment( $activity ) { $meta = get_remote_metadata_by_actor( $activity['actor'] ); - // Determine comment_ID + // Determine comment_ID. $comment = object_id_to_comment( \esc_url_raw( $activity['object']['id'] ) ); $commentdata = \get_comment( $comment, ARRAY_A ); @@ -70,7 +75,7 @@ class Interactions { return false; } - // found a local comment id + // Found a local comment id. $commentdata['comment_author'] = \esc_attr( $meta['name'] ? $meta['name'] : $meta['preferredUsername'] ); $commentdata['comment_content'] = \addslashes( $activity['object']['content'] ); @@ -126,7 +131,7 @@ class Interactions { /** * Get interaction(s) for a given URL/ID. * - * @param strin $url The URL/ID to get interactions for. + * @param string $url The URL/ID to get interactions for. * * @return array The interactions as WP_Comment objects. */ @@ -168,7 +173,7 @@ class Interactions { public static function get_interactions_by_actor( $actor ) { $meta = get_remote_metadata_by_actor( $actor ); - // get URL, because $actor seems to be the ID + // Get URL, because $actor seems to be the ID. if ( $meta && ! is_wp_error( $meta ) && isset( $meta['url'] ) ) { $actor = object_to_uri( $meta['url'] ); } @@ -193,7 +198,7 @@ class Interactions { * Adds line breaks to the list of allowed comment tags. * * @param array $allowed_tags Allowed HTML tags. - * @param string $context Context. + * @param string $context Optional. Context. Default empty. * * @return array Filtered tag list. */ @@ -218,21 +223,21 @@ class Interactions { /** * Convert an Activity to a WP_Comment * - * @param array $activity The Activity array + * @param array $activity The Activity array. * - * @return array|false The commentdata or false on failure + * @return array|false The comment data or false on failure. */ public static function activity_to_comment( $activity ) { $comment_content = null; $actor = object_to_uri( $activity['actor'] ); $actor = get_remote_metadata_by_actor( $actor ); - // check Actor-Meta + // Check Actor-Meta. if ( ! $actor || is_wp_error( $actor ) ) { return false; } - // check Actor-Name + // Check Actor-Name. if ( isset( $actor['name'] ) ) { $comment_author = $actor['name']; } elseif ( isset( $actor['preferredUsername'] ) ) { @@ -275,19 +280,19 @@ class Interactions { } /** - * Persist a comment + * Persist a comment. * - * @param array $commentdata The commentdata array - * @param string $action Either 'insert' or 'update' + * @param array $commentdata The commentdata array. + * @param string $action Optional. Either 'insert' or 'update'. Default 'insert'. * - * @return array|string|int|\WP_Error|false The commentdata or false on failure + * @return array|string|int|\WP_Error|false The comment data or false on failure */ public static function persist( $commentdata, $action = self::INSERT ) { - // disable flood control + // Disable flood control. \remove_action( 'check_comment_flood', 'check_comment_flood_db', 10 ); - // do not require email for AP entries + // Do not require email for AP entries. \add_filter( 'pre_option_require_name_email', '__return_false' ); - // No nonce possible for this submission route + // No nonce possible for this submission route. \add_filter( 'akismet_comment_nonce', function () { @@ -304,7 +309,7 @@ class Interactions { \remove_filter( 'wp_kses_allowed_html', array( self::class, 'allowed_comment_html' ), 10 ); \remove_filter( 'pre_option_require_name_email', '__return_false' ); - // re-add flood control + // Restore flood control. \add_action( 'check_comment_flood', 'check_comment_flood_db', 10, 4 ); if ( 1 === $state ) { diff --git a/includes/collection/class-replies.php b/includes/collection/class-replies.php index 11c17081..34a5aa02 100644 --- a/includes/collection/class-replies.php +++ b/includes/collection/class-replies.php @@ -1,4 +1,10 @@ false, @@ -110,7 +119,7 @@ class Users { $username = str_replace( array( '*', '%' ), '', $username ); - // check for login or nicename. + // Check for login or nicename. $user = new WP_User_Query( array( 'count_total' => false, @@ -138,21 +147,21 @@ class Users { * * @param string $uri The User-Resource. * - * @return \Acitvitypub\Model\User The User. + * @return User|WP_Error The User or WP_Error if user not found. */ public static function get_by_resource( $uri ) { $uri = object_to_uri( $uri ); $scheme = 'acct'; $match = array(); - // try to extract the scheme and the host + // Try to extract the scheme and the host. if ( preg_match( '/^([a-zA-Z^:]+):(.*)$/i', $uri, $match ) ) { - // extract the scheme + // Extract the scheme. $scheme = \esc_attr( $match[1] ); } switch ( $scheme ) { - // check for http(s) URIs + // Check for http(s) URIs. case 'http': case 'https': $resource_path = \wp_parse_url( $uri, PHP_URL_PATH ); @@ -166,7 +175,7 @@ class Users { $resource_path = \trim( $resource_path, '/' ); - // check for http(s)://blog.example.com/@username + // Check for http(s)://blog.example.com/@username. if ( str_starts_with( $resource_path, '@' ) ) { $identifier = \str_replace( '@', '', $resource_path ); $identifier = \trim( $identifier, '/' ); @@ -175,14 +184,14 @@ class Users { } } - // check for http(s)://blog.example.com/author/username + // Check for http(s)://blog.example.com/author/username. $user_id = url_to_authorid( $uri ); if ( $user_id ) { return self::get_by_id( $user_id ); } - // check for http(s)://blog.example.com/ + // Check for http(s)://blog.example.com/. if ( normalize_url( site_url() ) === normalize_url( $uri ) || normalize_url( home_url() ) === normalize_url( $uri ) @@ -195,7 +204,7 @@ class Users { \__( 'User not found', 'activitypub' ), array( 'status' => 404 ) ); - // check for acct URIs + // Check for acct URIs. case 'acct': $uri = \str_replace( 'acct:', '', $uri ); $identifier = \substr( $uri, 0, \strrpos( $uri, '@' ) ); @@ -210,7 +219,7 @@ class Users { ); } - // prepare wildcards https://github.com/mastodon/mastodon/issues/22213 + // Prepare wildcards https://github.com/mastodon/mastodon/issues/22213. if ( in_array( $identifier, array( '_', '*', '' ), true ) ) { return self::get_by_id( self::BLOG_USER_ID ); } @@ -230,7 +239,7 @@ class Users { * * @param string $id The User-Resource. * - * @return \Acitvitypub\Model\User The User. + * @return User|Blog|Application|WP_Error The User or WP_Error if user not found. */ public static function get_by_various( $id ) { $user = null; @@ -238,11 +247,11 @@ class Users { if ( is_numeric( $id ) ) { $user = self::get_by_id( $id ); } elseif ( - // is URL + // Is URL. filter_var( $id, FILTER_VALIDATE_URL ) || - // is acct + // Is acct. str_starts_with( $id, 'acct:' ) || - // is email + // Is email. filter_var( $id, FILTER_VALIDATE_EMAIL ) ) { $user = self::get_by_resource( $id ); diff --git a/includes/compat.php b/includes/compat.php index 27959131..fa8627b7 100644 --- a/includes/compat.php +++ b/includes/compat.php @@ -1,6 +1,8 @@ $v ) { + foreach ( $input as $k => $v ) { if ( ++$next_key !== $k ) { return false; } diff --git a/includes/debug.php b/includes/debug.php index daa66a77..b289c80d 100644 --- a/includes/debug.php +++ b/includes/debug.php @@ -1,17 +1,22 @@ wp_rewrite_rules(); - // not using rewrite rules, and 'author=N' method failed, so we're out of options + // Not using rewrite rules, and 'author=N' method failed, so we're out of options. if ( empty( $rewrite ) ) { return 0; } - // generate rewrite rule for the author url + // Generate rewrite rule for the author url. $author_rewrite = $wp_rewrite->get_author_permastruct(); $author_regexp = \str_replace( '%author%', '', $author_rewrite ); - // match the rewrite rule with the passed url + // Match the rewrite rule with the passed url. if ( \preg_match( '/https?:\/\/(.+)' . \preg_quote( $author_regexp, '/' ) . '([^\/]+)/i', $url, $match ) ) { $user = \get_user_by( 'slug', $match[2] ); if ( $user ) { @@ -211,10 +228,9 @@ function url_to_authorid( $url ) { } /** - * Verify if url is a wp_ap_comment, - * Or if it is a previously received remote comment + * Verify that url is a wp_ap_comment or a previously received remote comment. * - * @return int comment_id + * @return int|bool Comment ID or false if not found. */ function is_comment() { $comment_id = get_query_var( 'c', null ); @@ -231,13 +247,13 @@ function is_comment() { } /** - * Check for Tombstone Objects + * Check for Tombstone Objects. * * @see https://www.w3.org/TR/activitypub/#delete-activity-outbox * - * @param WP_Error $wp_error A WP_Error-Response of an HTTP-Request + * @param WP_Error $wp_error A WP_Error-Response of an HTTP-Request. * - * @return boolean true if HTTP-Code is 410 or 404 + * @return boolean True if HTTP-Code is 410 or 404. */ function is_tombstone( $wp_error ) { if ( ! is_wp_error( $wp_error ) ) { @@ -254,12 +270,12 @@ function is_tombstone( $wp_error ) { /** * Get the REST URL relative to this plugin's namespace. * - * @param string $path Optional. REST route path. Otherwise this plugin's namespaced root. + * @param string $path Optional. REST route path. Default ''. * * @return string REST URL relative to this plugin's namespace. */ function get_rest_url_by_path( $path = '' ) { - // we'll handle the leading slash. + // We'll handle the leading slash. $path = ltrim( $path, '/' ); $namespaced_path = sprintf( '/%s/%s', ACTIVITYPUB_REST_NAMESPACE, $path ); return \get_rest_url( null, $namespaced_path ); @@ -268,25 +284,23 @@ function get_rest_url_by_path( $path = '' ) { /** * Convert a string from camelCase to snake_case. * - * @param string $string The string to convert. + * @param string $input The string to convert. * * @return string The converted string. */ -// phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound -function camel_to_snake_case( $string ) { - return strtolower( preg_replace( '/(?query_vars['activitypub'] ) ) { return true; } @@ -391,7 +403,7 @@ function is_activitypub_request() { /** * This function checks if a user is disabled for ActivityPub. * - * @param int $user_id The User-ID. + * @param int $user_id The user ID. * * @return boolean True if the user is disabled, false otherwise. */ @@ -433,6 +445,12 @@ function is_user_disabled( $user_id ) { break; } + /** + * Allow plugins to disable users for ActivityPub. + * + * @param boolean $return True if the user is disabled, false otherwise. + * @param int $user_id The User-ID. + */ return apply_filters( 'activitypub_is_user_disabled', $return, $user_id ); } @@ -442,7 +460,7 @@ function is_user_disabled( $user_id ) { * This function is used to check if the 'blog' or 'user' * type is disabled for ActivityPub. * - * @param enum $type Can be 'blog' or 'user'. + * @param string $type User type. 'blog' or 'user'. * * @return boolean True if the user type is disabled, false otherwise. */ @@ -497,6 +515,12 @@ function is_user_type_disabled( $type ) { break; } + /** + * Allow plugins to disable user types for ActivityPub. + * + * @param boolean $return True if the user type is disabled, false otherwise. + * @param string $type The User-Type. + */ return apply_filters( 'activitypub_is_user_type_disabled', $return, $type ); } @@ -551,20 +575,25 @@ function is_json( $data ) { } /** - * Check if a blog is public based on the `blog_public` option + * Check whther a blog is public based on the `blog_public` option. * - * @return bollean True if public, false if not + * @return bool True if public, false if not */ function is_blog_public() { + /** + * Filter whether the blog is public. + * + * @param bool $public Whether the blog is public. + */ return (bool) apply_filters( 'activitypub_is_blog_public', \get_option( 'blog_public', 1 ) ); } /** - * Sanitize a URL + * Sanitize a URL. * - * @param string $value The URL to sanitize + * @param string $value The URL to sanitize. * - * @return string|null The sanitized URL or null if invalid + * @return string|null The sanitized URL or null if invalid. */ function sanitize_url( $value ) { if ( filter_var( $value, FILTER_VALIDATE_URL ) === false ) { @@ -575,11 +604,11 @@ function sanitize_url( $value ) { } /** - * Extract recipient URLs from Activity object + * Extract recipient URLs from Activity object. * - * @param array $data + * @param array $data The Activity object as array. * - * @return array The list of user URLs + * @return array The list of user URLs. */ function extract_recipients_from_activity( $data ) { $recipient_items = array(); @@ -606,10 +635,10 @@ function extract_recipients_from_activity( $data ) { $recipients = array(); - // flatten array + // Flatten array. foreach ( $recipient_items as $recipient ) { if ( is_array( $recipient ) ) { - // check if recipient is an object + // Check if recipient is an object. if ( array_key_exists( 'id', $recipient ) ) { $recipients[] = $recipient['id']; } @@ -622,11 +651,11 @@ function extract_recipients_from_activity( $data ) { } /** - * Check if passed Activity is Public + * Check if passed Activity is Public. * - * @param array $data The Activity object as array + * @param array $data The Activity object as array. * - * @return boolean True if public, false if not + * @return boolean True if public, false if not. */ function is_activity_public( $data ) { $recipients = extract_recipients_from_activity( $data ); @@ -635,11 +664,11 @@ function is_activity_public( $data ) { } /** - * Get active users based on a given duration + * Get active users based on a given duration. * - * @param int $duration The duration to check in month(s) + * @param int $duration Optional. The duration to check in month(s). Default 1. * - * @return int The number of active users + * @return int The number of active users. */ function get_active_users( $duration = 1 ) { @@ -650,7 +679,7 @@ function get_active_users( $duration = 1 ) { if ( false === $count ) { global $wpdb; - // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching + // phpcs:ignore WordPress.DB.DirectDatabaseQuery $count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT( DISTINCT post_author ) FROM {$wpdb->posts} WHERE post_type = 'post' AND post_status = 'publish' AND post_date <= DATE_SUB( NOW(), INTERVAL %d MONTH )", @@ -661,32 +690,32 @@ function get_active_users( $duration = 1 ) { set_transient( $transient_key, $count, DAY_IN_SECONDS ); } - // if 0 authors where active + // If 0 authors where active. if ( 0 === $count ) { return 0; } - // if single user mode + // If single user mode. if ( is_single_user() ) { return 1; } - // if blog user is disabled + // If blog user is disabled. if ( is_user_disabled( Users::BLOG_USER_ID ) ) { return (int) $count; } - // also count blog user + // Also count blog user. return (int) $count + 1; } /** - * Get the total number of users + * Get the total number of users. * - * @return int The total number of users + * @return int The total number of users. */ function get_total_users() { - // if single user mode + // If single user mode. if ( is_single_user() ) { return 1; } @@ -703,7 +732,7 @@ function get_total_users() { $users = 1; } - // if blog user is disabled + // If blog user is disabled. if ( is_user_disabled( Users::BLOG_USER_ID ) ) { return (int) $users; } @@ -716,65 +745,66 @@ function get_total_users() { * * @param string $id ActivityPub object ID (usually a URL) to check. * - * @return int|boolean Comment ID, or false on failure. + * @return \WP_Comment|boolean Comment, or false on failure. */ function object_id_to_comment( $id ) { return Comment::object_id_to_comment( $id ); } /** - * Verify if URL is a local comment, - * Or if it is a previously received remote comment + * Verify that URL is a local comment or a previously received remote comment. * (For threading comments locally) * * @param string $url The URL to check. * - * @return int comment_ID or null if not found + * @return string|null Comment ID or null if not found */ function url_to_commentid( $url ) { return Comment::url_to_commentid( $url ); } /** - * Get the URI of an ActivityPub object + * Get the URI of an ActivityPub object. * - * @param array $object The ActivityPub object + * @param array|string $data The ActivityPub object. * * @return string The URI of the ActivityPub object */ -function object_to_uri( $object ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.objectFound - // check if it is already simple - if ( ! $object || is_string( $object ) ) { - return $object; +function object_to_uri( $data ) { + // Check whether it is already simple. + if ( ! $data || is_string( $data ) ) { + return $data; } - // check if it is a list, then take first item - // this plugin does not support collections - if ( array_is_list( $object ) ) { - $object = $object[0]; + /* + * Check if it is a list, then take first item. + * This plugin does not support collections. + */ + if ( array_is_list( $data ) ) { + $data = $data[0]; } - // check if it is simplified now - if ( is_string( $object ) ) { - return $object; + // Check if it is simplified now. + if ( is_string( $data ) ) { + return $data; } $type = 'Object'; - if ( isset( $object['type'] ) ) { - $type = $object['type']; + if ( isset( $data['type'] ) ) { + $type = $data['type']; } - // return part of Object that makes most sense + // Return part of Object that makes most sense. switch ( $type ) { case 'Link': - $object = $object['href']; + $data = $data['href']; break; default: - $object = $object['id']; + $data = $data['id']; break; } - return $object; + return $data; } /** @@ -836,9 +866,8 @@ function is_local_comment( $comment ) { /** * Mark a WordPress object as federated. * - * @param WP_Comment|WP_Post|mixed $wp_object - * - * @return void + * @param \WP_Comment|\WP_Post $wp_object The WordPress object. + * @param string $state The state of the object. */ function set_wp_object_state( $wp_object, $state ) { $meta_key = 'activitypub_status'; @@ -848,6 +877,12 @@ function set_wp_object_state( $wp_object, $state ) { } elseif ( $wp_object instanceof \WP_Comment ) { \update_comment_meta( $wp_object->comment_ID, $meta_key, $state ); } else { + /** + * Allow plugins to mark WordPress objects as federated. + * + * @param \WP_Comment|\WP_Post $wp_object The WordPress object. + * @param string $state The state of the object. + */ \apply_filters( 'activitypub_mark_wp_object_as_federated', $wp_object ); } } @@ -855,7 +890,7 @@ function set_wp_object_state( $wp_object, $state ) { /** * Get the federation state of a WordPress object. * - * @param WP_Comment|WP_Post|mixed $wp_object + * @param \WP_Comment|\WP_Post $wp_object The WordPress object. * * @return string|false The state of the object or false if not found. */ @@ -867,6 +902,11 @@ function get_wp_object_state( $wp_object ) { } elseif ( $wp_object instanceof \WP_Comment ) { return \get_comment_meta( $wp_object->comment_ID, $meta_key, true ); } else { + /** + * Allow plugins to get the federation state of a WordPress object. + * + * @param \WP_Comment|\WP_Post $wp_object The WordPress object. + */ return \apply_filters( 'activitypub_get_wp_object_state', false, $wp_object ); } } @@ -876,7 +916,7 @@ function get_wp_object_state( $wp_object ) { * * Set some default descriptions for the default post types. * - * @param WP_Post_Type $post_type The post type object. + * @param \WP_Post_Type $post_type The post type object. * * @return string The description of the post type. */ @@ -899,6 +939,12 @@ function get_post_type_description( $post_type ) { } } + /** + * Allow plugins to get the description of a post type. + * + * @param string $description The description of the post type. + * @param \WP_Post_Type $post_type The post type object. + */ return apply_filters( 'activitypub_post_type_description', $description, $post_type->name, $post_type ); } @@ -908,9 +954,9 @@ function get_post_type_description( $post_type ) { * @return string The masked version. */ function get_masked_wp_version() { - // only show the major and minor version + // Only show the major and minor version. $version = get_bloginfo( 'version' ); - // strip the RC or beta part + // Strip the RC or beta part. $version = preg_replace( '/-.*$/', '', $version ); $version = explode( '.', $version ); $version = array_slice( $version, 0, 2 ); @@ -959,9 +1005,9 @@ function get_enclosures( $post_id ) { * * @see https://developer.wordpress.org/reference/functions/get_post_ancestors/ * - * @param int|WP_Comment $comment Comment ID or comment object. + * @param int|\WP_Comment $comment Comment ID or comment object. * - * @return WP_Comment[] Array of ancestor comments or empty array if there are none. + * @return \WP_Comment[] Array of ancestor comments or empty array if there are none. */ function get_comment_ancestors( $comment ) { $comment = \get_comment( $comment ); @@ -976,7 +1022,6 @@ function get_comment_ancestors( $comment ) { $id = (int) $comment->comment_parent; $ancestors[] = $id; - // phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition while ( $id > 0 ) { $ancestor = \get_comment( $id ); $parent_id = (int) $ancestor->comment_parent; @@ -1019,13 +1064,13 @@ function custom_large_numbers( $formatted, $number, $decimals ) { $thousands_sep = $wp_locale->number_format['thousands_sep']; } - if ( $number < 1000 ) { // any number less than a Thousand. + if ( $number < 1000 ) { // Any number less than a Thousand. return \number_format( $number, $decimals, $decimal_point, $thousands_sep ); - } elseif ( $number < 1000000 ) { // any number less than a million + } elseif ( $number < 1000000 ) { // Any number less than a million. return \number_format( $number / 1000, $decimals, $decimal_point, $thousands_sep ) . 'K'; - } elseif ( $number < 1000000000 ) { // any number less than a billion + } elseif ( $number < 1000000000 ) { // Any number less than a billion. return \number_format( $number / 1000000, $decimals, $decimal_point, $thousands_sep ) . 'M'; - } else { // at least a billion + } else { // At least a billion. return \number_format( $number / 1000000000, $decimals, $decimal_point, $thousands_sep ) . 'B'; } @@ -1037,7 +1082,7 @@ function custom_large_numbers( $formatted, $number, $decimals ) { * Registers a ActivityPub comment type. * * @param string $comment_type Key for comment type. - * @param array $args Arguments. + * @param array $args Optional. Array of arguments for registering a comment type. Default empty array. * * @return array The registered Activitypub comment type. */ @@ -1106,14 +1151,14 @@ function get_reply_intent_uri() { /** * Replace content with links, mentions or hashtags by Regex callback and not affect protected tags. * - * @param $content string The content that should be changed - * @param $regex string The regex to use - * @param $regex_callback callable Callback for replacement logic + * @param string $content The content that should be changed. + * @param string $regex The regex to use. + * @param callable $regex_callback Callback for replacement logic. * * @return string The content with links, mentions, hashtags, etc. */ function enrich_content_data( $content, $regex, $regex_callback ) { - // small protection against execution timeouts: limit to 1 MB + // Small protection against execution timeouts: limit to 1 MB. if ( mb_strlen( $content ) > MB_IN_BYTES ) { return $content; } @@ -1178,10 +1223,10 @@ function enrich_content_data( $content, $regex, $regex_callback ) { * 2. The first part of the post content if it contains the tag. * 3. An excerpt of the post content if it is longer than the specified length. * - * @param int|WP_Post $post The post ID or post object. - * @param integer $length The maximum length of the summary. - * Default is 500. It will ne ignored if the post excerpt - * and the content above the tag. + * @param int|\WP_Post $post The post ID or post object. + * @param integer $length The maximum length of the summary. + * Default is 500. It will be ignored if the post excerpt + * and the content above the tag. * * @return string The generated post summary. */ @@ -1195,12 +1240,22 @@ function generate_post_summary( $post, $length = 500 ) { $content = \sanitize_post_field( 'post_excerpt', $post->post_excerpt, $post->ID ); if ( $content ) { + /** + * Filters the post excerpt. + * + * @param string $content The post excerpt. + */ return \apply_filters( 'the_excerpt', $content ); } $content = \sanitize_post_field( 'post_content', $post->post_content, $post->ID ); $content_parts = \get_extended( $content ); + /** + * Filters the excerpt more value. + * + * @param string $excerpt_more The excerpt more. + */ $excerpt_more = \apply_filters( 'activitypub_excerpt_more', '[…]' ); $length = $length - strlen( $excerpt_more ); @@ -1235,7 +1290,7 @@ function generate_post_summary( $post, $length = 500 ) { /** * Get the content warning of a post. * - * @param int $post_id The post ID. + * @param int|\WP_Post $post_id The post ID or post object. * * @return string|false The content warning or false if not found. */ diff --git a/includes/handler/class-announce.php b/includes/handler/class-announce.php index e9e4ff7e..b0aa90fd 100644 --- a/includes/handler/class-announce.php +++ b/includes/handler/class-announce.php @@ -1,4 +1,10 @@ get_json_params(); diff --git a/includes/handler/class-delete.php b/includes/handler/class-delete.php index 3cc732bf..5b514dfa 100644 --- a/includes/handler/class-delete.php +++ b/includes/handler/class-delete.php @@ -1,7 +1,12 @@ delete(); self::maybe_delete_interactions( $activity ); @@ -110,7 +129,7 @@ class Delete { * @param array $activity The delete activity. */ public static function maybe_delete_interactions( $activity ) { - // verify if Actor is deleted. + // Verify that Actor is deleted. if ( Http::is_tombstone( $activity['actor'] ) ) { \wp_schedule_single_event( \time(), @@ -123,7 +142,7 @@ class Delete { /** * Delete comments from an Actor. * - * @param array $comments The comments to delete. + * @param array $actor The actor whose comments to delete. */ public static function delete_interactions( $actor ) { $comments = Interactions::get_interactions_by_actor( $actor ); @@ -139,8 +158,6 @@ class Delete { * Delete a Reaction if URL is a Tombstone. * * @param array $activity The delete activity. - * - * @return void */ public static function maybe_delete_interaction( $activity ) { if ( is_array( $activity['object'] ) ) { diff --git a/includes/handler/class-follow.php b/includes/handler/class-follow.php index c22a9362..fb94ba6d 100644 --- a/includes/handler/class-follow.php +++ b/includes/handler/class-follow.php @@ -1,4 +1,10 @@ get__id(); - // save follower + // Save follower. $follower = Followers::add_follower( $user_id, $activity['actor'] @@ -59,7 +63,7 @@ class Follow { $follower ); - // send notification + // Send notification. $notification = new Notification( 'follow', $activity['actor'], @@ -70,23 +74,20 @@ class Follow { } /** - * Send Accept response + * Send Accept response. * - * @param string $actor The Actor URL - * @param array $activity_object The Activity object - * @param int $user_id The ID of the WordPress User - * @param Activitypub\Model\Follower $follower The Follower object - * - * @return void + * @param string $actor The Actor URL. + * @param array $activity_object The Activity object. + * @param int $user_id The ID of the WordPress User. + * @param \Activitypub\Model\Follower $follower The Follower object. */ public static function send_follow_response( $actor, $activity_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 + // Impossible to send a "Reject" because we can not get the Remote-Inbox. return; } - // only send minimal data + // Only send minimal data. $activity_object = array_intersect_key( $activity_object, array_flip( @@ -101,10 +102,10 @@ class Follow { $user = Users::get_by_id( $user_id ); - // get inbox + // Get inbox. $inbox = $follower->get_shared_inbox(); - // send "Accept" activity + // Send "Accept" activity. $activity = new Activity(); $activity->set_type( 'Accept' ); $activity->set_object( $activity_object ); diff --git a/includes/handler/class-like.php b/includes/handler/class-like.php index e395d2cf..94facde4 100644 --- a/includes/handler/class-like.php +++ b/includes/handler/class-like.php @@ -1,4 +1,10 @@ add_help_tab( array( @@ -54,17 +59,17 @@ '

' . \__( 'Fediverse', 'activitypub' ) . '

' . '

' . \__( 'The Fediverse is a new word made of two words: "federation" + "universe"', 'activitypub' ) . '

' . '

' . \__( 'It is a federated social network running on free open software on a myriad of computers across the globe. Many independent servers are interconnected and allow people to interact with one another. There\'s no one central site: you choose a server to register. This ensures some decentralization and sovereignty of data. Fediverse (also called Fedi) has no built-in advertisements, no tricky algorithms, no one big corporation dictating the rules. Instead we have small cozy communities of like-minded people. Welcome!', 'activitypub' ) . '

' . - '

' . \__( 'For more informations please visit fediverse.party', 'activitypub' ) . '

' . + '

' . \__( 'For more information please visit fediverse.party', 'activitypub' ) . '

' . '

' . \__( 'ActivityPub', 'activitypub' ) . '

' . '

' . \__( 'ActivityPub is a decentralized social networking protocol based on the ActivityStreams 2.0 data format. ActivityPub is an official W3C recommended standard published by the W3C Social Web Working Group. It provides a client to server API for creating, updating and deleting content, as well as a federated server to server API for delivering notifications and subscribing to content.', 'activitypub' ) . '

' . '

' . \__( 'WebFinger', 'activitypub' ) . '

' . '

' . \__( 'WebFinger is used to discover information about people or other entities on the Internet that are identified by a URI using standard Hypertext Transfer Protocol (HTTP) methods over a secure transport. A WebFinger resource returns a JavaScript Object Notation (JSON) object describing the entity that is queried. The JSON object is referred to as the JSON Resource Descriptor (JRD).', 'activitypub' ) . '

' . '

' . \__( 'For a person, the type of information that might be discoverable via WebFinger includes a personal profile address, identity service, telephone number, or preferred avatar. For other entities on the Internet, a WebFinger resource might return JRDs containing link relations that enable a client to discover, for example, that a printer can print in color on A4 paper, the physical location of a server, or other static information.', 'activitypub' ) . '

' . '

' . \__( 'On Mastodon [and other Plattforms], user profiles can be hosted either locally on the same website as yours, or remotely on a completely different website. The same username may be used on a different domain. Therefore, a Mastodon user\'s full mention consists of both the username and the domain, in the form @username@domain. In practical terms, @user@example.com is not the same as @user@example.org. If the domain is not included, Mastodon will try to find a local user named @username. However, in order to deliver to someone over ActivityPub, the @username@domain mention is not enough – mentions must be translated to an HTTPS URI first, so that the remote actor\'s inbox and outbox can be found. (This paragraph is copied from the Mastodon Documentation)', 'activitypub' ) . '

' . - '

' . \__( 'For more informations please visit webfinger.net', 'activitypub' ) . '

' . + '

' . \__( 'For more information please visit webfinger.net', 'activitypub' ) . '

' . '

' . \__( 'NodeInfo', 'activitypub' ) . '

' . '

' . \__( 'NodeInfo is an effort to create a standardized way of exposing metadata about a server running one of the distributed social networks. The two key goals are being able to get better insights into the user base of distributed social networking and the ability to build tools that allow users to choose the best fitting software and server for their needs.', 'activitypub' ) . '

' . - '

' . \__( 'For more informations please visit nodeinfo.diaspora.software', 'activitypub' ) . '

', + '

' . \__( 'For more information please visit nodeinfo.diaspora.software', 'activitypub' ) . '

', ) ); diff --git a/includes/model/class-application.php b/includes/model/class-application.php index a0bda431..b7d38af2 100644 --- a/includes/model/class-application.php +++ b/includes/model/class-application.php @@ -1,4 +1,10 @@ + * @var string */ protected $webfinger; + /** + * Returns the type of the object. + * + * @return string The type of the object. + */ public function get_type() { return 'Application'; } + /** + * Returns whether the Application manually approves followers. + * + * @return true Whether the Application manually approves followers. + */ public function get_manually_approves_followers() { return true; } + /** + * Returns the ID of the Application. + * + * @return string The ID of the Application. + */ public function get_id() { return get_rest_url_by_path( 'application' ); } @@ -73,10 +97,20 @@ class Application extends Actor { return $this->get_url(); } + /** + * Get the Username. + * + * @return string The Username. + */ public function get_name() { return 'application'; } + /** + * Get the preferred username. + * + * @return string The preferred username. + */ public function get_preferred_username() { return $this->get_name(); } @@ -87,10 +121,10 @@ class Application extends Actor { * @return array The User-Icon. */ public function get_icon() { - // try site icon first + // Try site icon first. $icon_id = get_option( 'site_icon' ); - // try custom logo second + // Try custom logo second. if ( ! $icon_id ) { $icon_id = get_theme_mod( 'custom_logo' ); } @@ -105,7 +139,7 @@ class Application extends Actor { } if ( ! $icon_url ) { - // fallback to default icon + // Fallback to default icon. $icon_url = plugins_url( '/assets/img/wp-logo.png', ACTIVITYPUB_PLUGIN_FILE ); } @@ -131,6 +165,11 @@ class Application extends Actor { return null; } + /** + * Get the first published date. + * + * @return string The published date. + */ public function get_published() { $first_post = new WP_Query( array( @@ -176,6 +215,11 @@ class Application extends Actor { return $this->get_preferred_username() . '@' . \wp_parse_url( \home_url(), \PHP_URL_HOST ); } + /** + * Returns the public key. + * + * @return array The public key. + */ public function get_public_key() { return array( 'id' => $this->get_id() . '#main-key', @@ -185,9 +229,9 @@ class Application extends Actor { } /** - * Get the User-Description. + * Get the User description. * - * @return string The User-Description. + * @return string The User description. */ public function get_summary() { return \wpautop( @@ -198,6 +242,11 @@ class Application extends Actor { ); } + /** + * Returns the canonical URL of the object. + * + * @return string|null The canonical URL of the object. + */ public function get_canonical_url() { return \home_url(); } diff --git a/includes/model/class-blog.php b/includes/model/class-blog.php index aff08831..3cbd6f91 100644 --- a/includes/model/class-blog.php +++ b/includes/model/class-blog.php @@ -1,8 +1,13 @@ + * @var string */ protected $webfinger; /** - * If the User is discoverable. + * Whether the User is discoverable. * * @see https://docs.joinmastodon.org/spec/activitypub/#discoverable * @@ -74,7 +81,7 @@ class Blog extends Actor { protected $discoverable; /** - * Restrict posting to mods + * Restrict posting to mods. * * @see https://join-lemmy.org/docs/contributors/05-federation.html * @@ -82,18 +89,28 @@ class Blog extends Actor { */ protected $posting_restricted_to_mods; + /** + * Whether the User manually approves followers. + * + * @return false + */ public function get_manually_approves_followers() { return false; } + /** + * Whether the User is discoverable. + * + * @return boolean + */ public function get_discoverable() { return true; } /** - * Get the User-ID. + * Get the User ID. * - * @return string The User-ID. + * @return string The User ID. */ public function get_id() { return $this->get_url(); @@ -115,9 +132,9 @@ class Blog extends Actor { } /** - * Get the User-Name. + * Get the Username. * - * @return string The User-Name. + * @return string The Username. */ public function get_name() { return \wp_strip_all_tags( @@ -130,9 +147,9 @@ class Blog extends Actor { } /** - * Get the User-Description. + * Get the User description. * - * @return string The User-Description. + * @return string The User description. */ public function get_summary() { $summary = \get_option( 'activitypub_blog_description', null ); @@ -150,9 +167,9 @@ class Blog extends Actor { } /** - * Get the User-Url. + * Get the User url. * - * @return string The User-Url. + * @return string The User url. */ public function get_url() { return \esc_url( \trailingslashit( get_home_url() ) . '@' . $this->get_preferred_username() ); @@ -173,12 +190,12 @@ class Blog extends Actor { * @return string The auto-generated Username. */ public static function get_default_username() { - // check if domain host has a subdomain + // Check if domain host has a subdomain. $host = \wp_parse_url( \get_home_url(), \PHP_URL_HOST ); $host = \preg_replace( '/^www\./i', '', $host ); /** - * Filter the default blog username. + * Filters the default blog username. * * @param string $host The default username. */ @@ -186,9 +203,9 @@ class Blog extends Actor { } /** - * Get the preferred User-Name. + * Get the preferred Username. * - * @return string The User-Name. + * @return string The Username. */ public function get_preferred_username() { $username = \get_option( 'activitypub_blog_identifier' ); @@ -201,15 +218,15 @@ class Blog extends Actor { } /** - * Get the User-Icon. + * Get the User icon. * - * @return array The User-Icon. + * @return array The User icon. */ public function get_icon() { - // try site_logo, falling back to site_icon, first + // Try site_logo, falling back to site_icon, first. $icon_id = get_option( 'site_icon' ); - // try custom logo second + // Try custom logo second. if ( ! $icon_id ) { $icon_id = get_theme_mod( 'custom_logo' ); } @@ -224,7 +241,7 @@ class Blog extends Actor { } if ( ! $icon_url ) { - // fallback to default icon + // Fallback to default icon. $icon_url = plugins_url( '/assets/img/wp-logo.png', ACTIVITYPUB_PLUGIN_FILE ); } @@ -261,6 +278,11 @@ class Blog extends Actor { return null; } + /** + * Get the published date. + * + * @return string The published date. + */ public function get_published() { $first_post = new WP_Query( array( @@ -279,10 +301,20 @@ class Blog extends Actor { return \gmdate( 'Y-m-d\TH:i:s\Z', $time ); } + /** + * Get the canonical URL. + * + * @return string|null The canonical URL. + */ public function get_canonical_url() { return \home_url(); } + /** + * Get the Moderators endpoint. + * + * @return string|null The Moderators endpoint. + */ public function get_moderators() { if ( is_single_user() || 'Group' !== $this->get_type() ) { return null; @@ -291,6 +323,11 @@ class Blog extends Actor { return get_rest_url_by_path( 'collections/moderators' ); } + /** + * Get attributedTo value. + * + * @return string|null The attributedTo value. + */ public function get_attributed_to() { if ( is_single_user() || 'Group' !== $this->get_type() ) { return null; @@ -299,6 +336,11 @@ class Blog extends Actor { return get_rest_url_by_path( 'collections/moderators' ); } + /** + * Get the public key information. + * + * @return array The public key. + */ public function get_public_key() { return array( 'id' => $this->get_id() . '#main-key', @@ -307,6 +349,11 @@ class Blog extends Actor { ); } + /** + * Returns whether posting is restricted to mods. + * + * @return bool|null True if posting is restricted to mods, null if not applicable. + */ public function get_posting_restricted_to_mods() { if ( 'Group' === $this->get_type() ) { return true; @@ -351,6 +398,11 @@ class Blog extends Actor { return get_rest_url_by_path( sprintf( 'actors/%d/following', $this->get__id() ) ); } + /** + * Returns endpoints. + * + * @return array|null The endpoints. + */ public function get_endpoints() { $endpoints = null; @@ -381,6 +433,11 @@ class Blog extends Actor { return get_rest_url_by_path( sprintf( 'actors/%d/collections/featured', $this->get__id() ) ); } + /** + * Returns whether the site is indexable. + * + * @return bool Whether the site is indexable. + */ public function get_indexable() { if ( is_blog_public() ) { return true; @@ -390,7 +447,7 @@ class Blog extends Actor { } /** - * Update the User-Name. + * Update the Username. * * @param mixed $value The new value. * @return bool True if the attribute was updated, false otherwise. @@ -400,7 +457,7 @@ class Blog extends Actor { } /** - * Update the User-Description. + * Update the User description. * * @param mixed $value The new value. * @return bool True if the attribute was updated, false otherwise. @@ -410,7 +467,7 @@ class Blog extends Actor { } /** - * Update the User-Icon. + * Update the User icon. * * @param mixed $value The new value. * @return bool True if the attribute was updated, false otherwise. @@ -436,11 +493,11 @@ class Blog extends Actor { } /** - * Get the User - Hashtags . + * Get the User - Hashtags. * * @see https://docs.joinmastodon.org/spec/activitypub/#Hashtag * - * @return array The User - Hashtags . + * @return array The User - Hashtags. */ public function get_tag() { $hashtags = array(); diff --git a/includes/model/class-follower.php b/includes/model/class-follower.php index 21565911..af30303d 100644 --- a/includes/model/class-follower.php +++ b/includes/model/class-follower.php @@ -1,13 +1,18 @@ summary ) ) { @@ -51,7 +56,7 @@ class Follower extends Actor { * Getter for URL attribute. * * Falls back to ID, if no URL is set. This is relevant for - * Plattforms like Lemmy, where the ID is the URL. + * Platforms like Lemmy, where the ID is the URL. * * @return string The URL. */ @@ -65,8 +70,6 @@ class Follower extends Actor { /** * Reset (delete) all errors. - * - * @return void */ public function reset_errors() { delete_post_meta( $this->_id, 'activitypub_errors' ); @@ -103,21 +106,19 @@ class Follower extends Actor { } /** - * Update the current Follower-Object. - * - * @return void + * Update the current Follower object. */ public function update() { $this->save(); } /** - * Validate the current Follower-Object. + * Validate the current Follower object. * * @return boolean True if the verification was successful. */ public function is_valid() { - // the minimum required attributes + // The minimum required attributes. $required_attributes = array( 'id', 'preferredUsername', @@ -136,9 +137,9 @@ class Follower extends Actor { } /** - * Save the current Follower-Object. + * Save the current Follower object. * - * @return int|WP_Error The Post-ID or an WP_Error. + * @return int|WP_Error The post ID or an WP_Error. */ public function save() { if ( ! $this->is_valid() ) { @@ -177,8 +178,7 @@ class Follower extends Actor { ); if ( ! empty( $post_id ) ) { - // If this is an update, prevent the "followed" date from being - // overwritten by the current date. + // If this is an update, prevent the "followed" date from being overwritten by the current date. $post = get_post( $post_id ); $args['post_date'] = $post->post_date; $args['post_date_gmt'] = $post->post_date_gmt; @@ -191,24 +191,22 @@ class Follower extends Actor { } /** - * Upsert the current Follower-Object. + * Upsert the current Follower object. * - * @return int|WP_Error The Post-ID or an WP_Error. + * @return int|WP_Error The post ID or an WP_Error. */ public function upsert() { return $this->save(); } /** - * Delete the current Follower-Object. + * Delete the current Follower object. * * Beware that this os deleting a Follower for ALL users!!! * * To delete only the User connection (unfollow) * * @see \Activitypub\Rest\Followers::remove_follower() - * - * @return void */ public function delete() { wp_delete_post( $this->_id ); @@ -216,8 +214,6 @@ class Follower extends Actor { /** * Update the post meta. - * - * @return void */ protected function get_post_meta_input() { $meta_input = array(); @@ -279,7 +275,7 @@ class Follower extends Actor { } /** - * Get the Icon URL (Avatar) + * Get the Icon URL (Avatar). * * @return string The URL to the Avatar. */ @@ -298,7 +294,7 @@ class Follower extends Actor { } /** - * Get the Icon URL (Avatar) + * Get the Icon URL (Avatar). * * @return string The URL to the Avatar. */ @@ -334,9 +330,8 @@ class Follower extends Actor { /** * Convert a Custom-Post-Type input to an Activitypub\Model\Follower. * - * @return string The JSON string. - * - * @return array Activitypub\Model\Follower + * @param \WP_Post $post The post object. + * @return \Activitypub\Activity\Base_Object|WP_Error */ public static function init_from_cpt( $post ) { $actor_json = get_post_meta( $post->ID, 'activitypub_actor_json', true ); @@ -371,10 +366,10 @@ class Follower extends Actor { if ( $path ) { if ( \strpos( $name, '@' ) !== false ) { - // expected: https://example.com/@user (default URL pattern) + // Expected: https://example.com/@user (default URL pattern). $name = \preg_replace( '|^/@?|', '', $path ); } else { - // expected: https://example.com/users/user (default ID pattern) + // Expected: https://example.com/users/user (default ID pattern). $parts = \explode( '/', $path ); $name = \array_pop( $parts ); } @@ -384,7 +379,7 @@ class Follower extends Actor { \strpos( $name, 'acct' ) === 0 || \strpos( $name, '@' ) === 0 ) { - // expected: user@example.com or acct:user@example (WebFinger) + // Expected: user@example.com or acct:user@example (WebFinger). $name = \ltrim( $name, '@' ); $name = \ltrim( $name, 'acct:' ); $parts = \explode( '@', $name ); diff --git a/includes/model/class-user.php b/includes/model/class-user.php index 7849b9ab..997c5210 100644 --- a/includes/model/class-user.php +++ b/includes/model/class-user.php @@ -1,19 +1,24 @@ + * @var string */ protected $webfinger; + /** + * The type of the object. + * + * @return string The type of the object. + */ public function get_type() { return 'Person'; } + /** + * Generate a User object from a WP_User. + * + * @param int $user_id The user ID. + * + * @return WP_Error|User The User object or WP_Error if user not found. + */ public static function from_wp_user( $user_id ) { if ( is_user_disabled( $user_id ) ) { return new WP_Error( @@ -83,27 +100,27 @@ class User extends Actor { } /** - * Get the User-ID. + * Get the user ID. * - * @return string The User-ID. + * @return string The user ID. */ public function get_id() { return $this->get_url(); } /** - * Get the User-Name. + * Get the Username. * - * @return string The User-Name. + * @return string The Username. */ public function get_name() { return \esc_attr( \get_the_author_meta( 'display_name', $this->_id ) ); } /** - * Get the User-Description. + * Get the User description. * - * @return string The User-Description. + * @return string The User description. */ public function get_summary() { $description = get_user_option( 'activitypub_description', $this->_id ); @@ -114,27 +131,37 @@ class User extends Actor { } /** - * Get the User-Url. + * Get the User url. * - * @return string The User-Url. + * @return string The User url. */ public function get_url() { return \esc_url( \get_author_posts_url( $this->_id ) ); } /** - * Returns the User-URL with @-Prefix for the username. + * Returns the User URL with @-Prefix for the username. * - * @return string The User-URL with @-Prefix for the username. + * @return string The User URL with @-Prefix for the username. */ public function get_alternate_url() { return \esc_url( \trailingslashit( get_home_url() ) . '@' . $this->get_preferred_username() ); } + /** + * Get the preferred username. + * + * @return string The preferred username. + */ public function get_preferred_username() { return \esc_attr( \get_the_author_meta( 'login', $this->_id ) ); } + /** + * Get the User icon. + * + * @return array The User icon. + */ public function get_icon() { $icon = \get_user_option( 'activitypub_icon', $this->_id ); if ( wp_attachment_is_image( $icon ) ) { @@ -157,6 +184,11 @@ class User extends Actor { ); } + /** + * Returns the header image. + * + * @return array|null The header image. + */ public function get_image() { $header_image = get_user_option( 'activitypub_header_image', $this->_id ); $image_url = null; @@ -179,10 +211,20 @@ class User extends Actor { return null; } + /** + * Returns the date the user was created. + * + * @return false|string The date the user was created. + */ public function get_published() { return \gmdate( 'Y-m-d\TH:i:s\Z', \strtotime( \get_the_author_meta( 'registered', $this->_id ) ) ); } + /** + * Returns the public key. + * + * @return array The public key. + */ public function get_public_key() { return array( 'id' => $this->get_id() . '#main-key', @@ -236,6 +278,11 @@ class User extends Actor { return get_rest_url_by_path( sprintf( 'actors/%d/collections/featured', $this->get__id() ) ); } + /** + * Returns the endpoints. + * + * @return array|null The endpoints. + */ public function get_endpoints() { $endpoints = null; @@ -267,18 +314,38 @@ class User extends Actor { return $this->get_preferred_username() . '@' . \wp_parse_url( \home_url(), \PHP_URL_HOST ); } + /** + * Returns the canonical URL. + * + * @return string The canonical URL. + */ public function get_canonical_url() { return $this->get_url(); } + /** + * Returns the streams. + * + * @return null The streams. + */ public function get_streams() { return null; } + /** + * Returns the tag. + * + * @return array The tag. + */ public function get_tag() { return array(); } + /** + * Returns the indexable state. + * + * @return bool Whether the user is indexable. + */ public function get_indexable() { if ( is_blog_public() ) { return true; @@ -287,12 +354,11 @@ class User extends Actor { } } - /** - * Update the User-Name. + * Update the username. * - * @param mixed $value The new value. - * @return bool True if the attribute was updated, false otherwise. + * @param string $value The new value. + * @return int|WP_Error The updated user ID or WP_Error on failure. */ public function update_name( $value ) { $userdata = array( @@ -303,9 +369,9 @@ class User extends Actor { } /** - * Update the User-Description. + * Update the User description. * - * @param mixed $value The new value. + * @param string $value The new value. * @return bool True if the attribute was updated, false otherwise. */ public function update_summary( $value ) { @@ -313,9 +379,9 @@ class User extends Actor { } /** - * Update the User-Icon. + * Update the User icon. * - * @param mixed $value The new value. Should be an attachment ID. + * @param int $value The new value. Should be an attachment ID. * @return bool True if the attribute was updated, false otherwise. */ public function update_icon( $value ) { @@ -328,7 +394,7 @@ class User extends Actor { /** * Update the User-Header-Image. * - * @param mixed $value The new value. Should be an attachment ID. + * @param int $value The new value. Should be an attachment ID. * @return bool True if the attribute was updated, false otherwise. */ public function update_header( $value ) { diff --git a/includes/rest/class-actors.php b/includes/rest/class-actors.php index f7bfc45a..60f03d29 100644 --- a/includes/rest/class-actors.php +++ b/includes/rest/class-actors.php @@ -1,18 +1,22 @@ get_param( 'user_id' ); @@ -79,15 +83,15 @@ class Actors { $link_header = sprintf( '<%1$s>; rel="alternate"; type="application/activity+json"', $user->get_id() ); - // redirect to canonical URL if it is not an ActivityPub request + // Redirect to canonical URL if it is not an ActivityPub request. if ( ! is_activitypub_request() ) { header( 'Link: ' . $link_header ); header( 'Location: ' . $user->get_canonical_url(), true, 301 ); exit; } - /* - * Action triggerd prior to the ActivityPub profile being created and sent to the client + /** + * Action triggered prior to the ActivityPub profile being created and sent to the client. */ \do_action( 'activitypub_rest_users_pre' ); @@ -102,11 +106,11 @@ class Actors { /** - * Endpoint for remote follow UI/Block + * Endpoint for remote follow UI/Block. * * @param WP_REST_Request $request The request object. * - * @return void|string The URL to the remote follow page + * @return WP_REST_Response|\WP_Error The response object or WP_Error. */ public static function remote_follow_get( WP_REST_Request $request ) { $resource = $request->get_param( 'resource' ); @@ -136,9 +140,9 @@ class Actors { } /** - * The supported parameters + * The supported parameters. * - * @return array list of parameters + * @return array List of parameters, */ public static function request_parameters() { $params = array(); diff --git a/includes/rest/class-collection.php b/includes/rest/class-collection.php index c15ddd7d..02cc99bf 100644 --- a/includes/rest/class-collection.php +++ b/includes/rest/class-collection.php @@ -1,4 +1,10 @@ get_param( 'type' ); @@ -144,9 +150,9 @@ class Collection { /** * The Featured Tags endpoint * - * @param WP_REST_Request $request The request object. + * @param \WP_REST_Request $request The request object. * - * @return WP_REST_Response The response object. + * @return WP_REST_Response|\WP_Error The response object or WP_Error. */ public static function tags_get( $request ) { $user_id = $request->get_param( 'user_id' ); @@ -196,9 +202,9 @@ class Collection { /** * Featured posts endpoint * - * @param WP_REST_Request $request The request object. + * @param \WP_REST_Request $request The request object. * - * @return WP_REST_Response The response object. + * @return WP_REST_Response|\WP_Error The response object or WP_Error. */ public static function featured_get( $request ) { $user_id = $request->get_param( 'user_id' ); @@ -254,7 +260,7 @@ class Collection { } /** - * Moderators endpoint + * Moderators endpoint. * * @return WP_REST_Response The response object. */ @@ -279,9 +285,9 @@ class Collection { } /** - * The supported parameters + * The supported parameters. * - * @return array list of parameters + * @return array List of parameters. */ public static function request_parameters() { $params = array(); @@ -295,9 +301,9 @@ class Collection { } /** - * The supported parameters + * The supported parameters. * - * @return array list of parameters + * @return array list of parameters. */ public static function request_parameters_for_replies() { $params = array(); diff --git a/includes/rest/class-comment.php b/includes/rest/class-comment.php index cb9e1126..095c8589 100644 --- a/includes/rest/class-comment.php +++ b/includes/rest/class-comment.php @@ -1,4 +1,10 @@ get_param( 'resource' ); diff --git a/includes/rest/class-followers.php b/includes/rest/class-followers.php index 0543a199..fe97548e 100644 --- a/includes/rest/class-followers.php +++ b/includes/rest/class-followers.php @@ -1,7 +1,12 @@ get_param( 'user_id' ); @@ -64,36 +69,34 @@ class Followers { $page = (int) $request->get_param( 'page' ); $context = $request->get_param( 'context' ); - /* - * Action triggerd prior to the ActivityPub profile being created and sent to the client + /** + * Action triggered prior to the ActivityPub profile being created and sent to the client */ \do_action( 'activitypub_rest_followers_pre' ); $data = Follower_Collection::get_followers_with_count( $user_id, $per_page, $page, array( 'order' => ucwords( $order ) ) ); $json = new stdClass(); + // phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $json->{'@context'} = \Activitypub\get_context(); + $json->id = get_rest_url_by_path( sprintf( 'actors/%d/followers', $user->get__id() ) ); + $json->generator = 'http://wordpress.org/?v=' . get_masked_wp_version(); + $json->actor = $user->get_id(); + $json->type = 'OrderedCollectionPage'; + $json->totalItems = $data['total']; + $json->partOf = get_rest_url_by_path( sprintf( 'actors/%d/followers', $user->get__id() ) ); - $json->id = get_rest_url_by_path( sprintf( 'actors/%d/followers', $user->get__id() ) ); - $json->generator = 'http://wordpress.org/?v=' . get_masked_wp_version(); - $json->actor = $user->get_id(); - $json->type = 'OrderedCollectionPage'; + $json->first = \add_query_arg( 'page', 1, $json->partOf ); + $json->last = \add_query_arg( 'page', \ceil( $json->totalItems / $per_page ), $json->partOf ); - $json->totalItems = $data['total']; // phpcs:ignore - $json->partOf = get_rest_url_by_path( sprintf( 'actors/%d/followers', $user->get__id() ) ); // phpcs:ignore - - $json->first = \add_query_arg( 'page', 1, $json->partOf ); // phpcs:ignore - $json->last = \add_query_arg( 'page', \ceil ( $json->totalItems / $per_page ), $json->partOf ); // phpcs:ignore - - if ( $page && ( ( \ceil ( $json->totalItems / $per_page ) ) > $page ) ) { // phpcs:ignore - $json->next = \add_query_arg( 'page', $page + 1, $json->partOf ); // phpcs:ignore + if ( $page && ( ( \ceil( $json->totalItems / $per_page ) ) > $page ) ) { + $json->next = \add_query_arg( 'page', $page + 1, $json->partOf ); } - if ( $page && ( $page > 1 ) ) { // phpcs:ignore - $json->prev = \add_query_arg( 'page', $page - 1, $json->partOf ); // phpcs:ignore + if ( $page && ( $page > 1 ) ) { + $json->prev = \add_query_arg( 'page', $page - 1, $json->partOf ); } - // phpcs:ignore $json->orderedItems = array_map( function ( $item ) use ( $context ) { if ( 'full' === $context ) { @@ -103,6 +106,7 @@ class Followers { }, $data['followers'] ); + // phpcs:enable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $rest_response = new WP_REST_Response( $json, 200 ); $rest_response->header( 'Content-Type', 'application/activity+json; charset=' . get_option( 'blog_charset' ) ); @@ -111,9 +115,9 @@ class Followers { } /** - * The supported parameters + * The supported parameters. * - * @return array list of parameters + * @return array List of parameters. */ public static function request_parameters() { $params = array(); diff --git a/includes/rest/class-following.php b/includes/rest/class-following.php index e3e22cc5..bf546e96 100644 --- a/includes/rest/class-following.php +++ b/includes/rest/class-following.php @@ -1,4 +1,10 @@ get_param( 'user_id' ); @@ -58,8 +64,8 @@ class Following { return $user; } - /* - * Action triggerd prior to the ActivityPub profile being created and sent to the client + /** + * Action triggered prior to the ActivityPub profile being created and sent to the client. */ \do_action( 'activitypub_rest_following_pre' ); @@ -67,19 +73,25 @@ class Following { $json->{'@context'} = \Activitypub\get_context(); + // phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $json->id = get_rest_url_by_path( sprintf( 'actors/%d/following', $user->get__id() ) ); $json->generator = 'http://wordpress.org/?v=' . get_masked_wp_version(); $json->actor = $user->get_id(); $json->type = 'OrderedCollectionPage'; + $json->partOf = get_rest_url_by_path( sprintf( 'actors/%d/following', $user->get__id() ) ); - $json->partOf = get_rest_url_by_path( sprintf( 'actors/%d/following', $user->get__id() ) ); // phpcs:ignore + /** + * Filter the list of following urls. + * + * @param array $items The array of following urls. + * @param \Activitypub\Model\User $user The user object. + */ + $items = apply_filters( 'activitypub_rest_following', array(), $user ); - $items = apply_filters( 'activitypub_rest_following', array(), $user ); // phpcs:ignore - - $json->totalItems = is_countable( $items ) ? count( $items ) : 0; // phpcs:ignore - $json->orderedItems = $items; // phpcs:ignore - - $json->first = $json->partOf; // phpcs:ignore + $json->totalItems = is_countable( $items ) ? count( $items ) : 0; + $json->orderedItems = $items; + $json->first = $json->partOf; + // phpcs:enable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $rest_response = new WP_REST_Response( $json, 200 ); $rest_response->header( 'Content-Type', 'application/activity+json; charset=' . get_option( 'blog_charset' ) ); @@ -88,9 +100,9 @@ class Following { } /** - * The supported parameters + * The supported parameters. * - * @return array list of parameters + * @return array List of parameters. */ public static function request_parameters() { $params = array(); diff --git a/includes/rest/class-inbox.php b/includes/rest/class-inbox.php index 9ade01ea..d4a104f6 100644 --- a/includes/rest/class-inbox.php +++ b/includes/rest/class-inbox.php @@ -1,7 +1,12 @@ get_param( 'user_id' ); @@ -80,27 +85,33 @@ class Inbox { return $user; } - /* - * Action triggerd prior to the ActivityPub profile being created and sent to the client + /** + * Action triggered prior to the ActivityPub profile being created and sent to the client. */ \do_action( 'activitypub_rest_inbox_pre' ); $json = new \stdClass(); + // phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $json->{'@context'} = get_context(); $json->id = get_rest_url_by_path( sprintf( 'actors/%d/inbox', $user->get__id() ) ); $json->generator = 'http://wordpress.org/?v=' . get_masked_wp_version(); $json->type = 'OrderedCollectionPage'; - $json->partOf = get_rest_url_by_path( sprintf( 'actors/%d/inbox', $user->get__id() ) ); // phpcs:ignore - $json->totalItems = 0; // phpcs:ignore - $json->orderedItems = array(); // phpcs:ignore - $json->first = $json->partOf; // phpcs:ignore + $json->partOf = get_rest_url_by_path( sprintf( 'actors/%d/inbox', $user->get__id() ) ); + $json->totalItems = 0; + $json->orderedItems = array(); + $json->first = $json->partOf; + // phpcs:enable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase - // filter output + /** + * Filter the ActivityPub inbox array. + * + * @param array $json The ActivityPub inbox array. + */ $json = \apply_filters( 'activitypub_rest_inbox_array', $json ); - /* - * Action triggerd after the ActivityPub profile has been created and sent to the client + /** + * Action triggered after the ActivityPub profile has been created and sent to the client. */ \do_action( 'activitypub_inbox_post' ); @@ -111,11 +122,11 @@ class Inbox { } /** - * Handles user-inbox requests + * Handles user-inbox requests. * - * @param WP_REST_Request $request + * @param \WP_REST_Request $request The request object. * - * @return WP_REST_Response + * @return WP_REST_Response|\WP_Error The response object or WP_Error. */ public static function user_inbox_post( $request ) { $user_id = $request->get_param( 'user_id' ); @@ -130,7 +141,23 @@ class Inbox { $type = $request->get_param( 'type' ); $type = \strtolower( $type ); + /** + * ActivityPub inbox action. + * + * @param array $data The data array. + * @param int|null $user_id The user ID. + * @param string $type The type of the activity. + * @param Activity $activity The Activity object. + */ \do_action( 'activitypub_inbox', $data, $user->get__id(), $type, $activity ); + + /** + * ActivityPub inbox action for specific activity types. + * + * @param array $data The data array. + * @param int|null $user_id The user ID. + * @param Activity $activity The Activity object. + */ \do_action( "activitypub_inbox_{$type}", $data, $user->get__id(), $activity ); $rest_response = new WP_REST_Response( array(), 202 ); @@ -140,9 +167,9 @@ class Inbox { } /** - * The shared inbox + * The shared inbox. * - * @param WP_REST_Request $request + * @param \WP_REST_Request $request The request object. * * @return WP_REST_Response */ @@ -152,7 +179,23 @@ class Inbox { $type = $request->get_param( 'type' ); $type = \strtolower( $type ); + /** + * ActivityPub inbox action. + * + * @param array $data The data array. + * @param int|null $user_id The user ID. + * @param string $type The type of the activity. + * @param Activity $activity The Activity object. + */ \do_action( 'activitypub_inbox', $data, null, $type, $activity ); + + /** + * ActivityPub inbox action for specific activity types. + * + * @param array $data The data array. + * @param int|null $user_id The user ID. + * @param Activity $activity The Activity object. + */ \do_action( "activitypub_inbox_{$type}", $data, null, $activity ); $rest_response = new WP_REST_Response( array(), 202 ); @@ -162,9 +205,9 @@ class Inbox { } /** - * The supported parameters + * The supported parameters. * - * @return array list of parameters + * @return array List of parameters. */ public static function user_inbox_get_parameters() { $params = array(); @@ -182,9 +225,9 @@ class Inbox { } /** - * The supported parameters + * The supported parameters. * - * @return array list of parameters + * @return array List of parameters. */ public static function user_inbox_post_parameters() { $params = array(); @@ -201,10 +244,7 @@ class Inbox { $params['actor'] = array( 'required' => true, - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed, VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable - 'sanitize_callback' => function ( $param, $request, $key ) { - return object_to_uri( $param ); - }, + 'sanitize_callback' => 'object_to_uri', ); $params['type'] = array( @@ -214,6 +254,14 @@ class Inbox { $params['object'] = array( 'required' => true, 'validate_callback' => function ( $param, $request, $key ) { + /** + * Filter the ActivityPub object validation. + * + * @param bool $validate The validation result. + * @param array $param The object data. + * @param object $request The request object. + * @param string $key The key. + */ return apply_filters( 'activitypub_validate_object', true, $param, $request, $key ); }, ); @@ -222,17 +270,16 @@ class Inbox { } /** - * The supported parameters + * The supported parameters. * - * @return array list of parameters + * @return array List of parameters. */ public static function shared_inbox_post_parameters() { $params = self::user_inbox_post_parameters(); $params['to'] = array( 'required' => false, - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed, VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable - 'sanitize_callback' => function ( $param, $request, $key ) { + 'sanitize_callback' => function ( $param ) { if ( \is_string( $param ) ) { $param = array( $param ); } @@ -242,8 +289,7 @@ class Inbox { ); $params['cc'] = array( - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed, VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable - 'sanitize_callback' => function ( $param, $request, $key ) { + 'sanitize_callback' => function ( $param ) { if ( \is_string( $param ) ) { $param = array( $param ); } @@ -253,8 +299,7 @@ class Inbox { ); $params['bcc'] = array( - // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed, VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable - 'sanitize_callback' => function ( $param, $request, $key ) { + 'sanitize_callback' => function ( $param ) { if ( \is_string( $param ) ) { $param = array( $param ); } @@ -267,11 +312,11 @@ class Inbox { } /** - * Get local user recipients + * Get local user recipients. * - * @param array $data + * @param array $data The data array. * - * @return array The list of local users + * @return array The list of local users. */ public static function get_recipients( $data ) { $recipients = extract_recipients_from_activity( $data ); diff --git a/includes/rest/class-interaction.php b/includes/rest/class-interaction.php index 011f1303..8bf78267 100644 --- a/includes/rest/class-interaction.php +++ b/includes/rest/class-interaction.php @@ -1,12 +1,21 @@ get_param( 'uri' ); @@ -78,10 +87,16 @@ class Interaction { $redirect_url = \apply_filters( 'activitypub_interactions_reply_url', $redirect_url, $uri, $object ); } - // generic Interaction hook + /** + * Filter the redirect URL. + * + * @param string $redirect_url The URL to redirect to. + * @param string $uri The URI of the object. + * @param array $object The object. + */ $redirect_url = \apply_filters( 'activitypub_interactions_url', $redirect_url, $uri, $object ); - // check if hook is implemented + // Check if hook is implemented. if ( ! $redirect_url ) { \wp_die( esc_html__( diff --git a/includes/rest/class-nodeinfo.php b/includes/rest/class-nodeinfo.php index 1ec5d502..3eb5fc00 100644 --- a/includes/rest/class-nodeinfo.php +++ b/includes/rest/class-nodeinfo.php @@ -1,4 +1,10 @@ get_param( 'user_id' ); @@ -64,41 +69,43 @@ class Outbox { $page = $request->get_param( 'page', 1 ); - /* - * Action triggerd prior to the ActivityPub profile being created and sent to the client + /** + * Action triggered prior to the ActivityPub profile being created and sent to the client. */ \do_action( 'activitypub_rest_outbox_pre' ); $json = new stdClass(); + // phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $json->{'@context'} = get_context(); $json->id = get_rest_url_by_path( sprintf( 'actors/%d/outbox', $user_id ) ); $json->generator = 'http://wordpress.org/?v=' . get_masked_wp_version(); $json->actor = $user->get_id(); $json->type = 'OrderedCollectionPage'; - $json->partOf = get_rest_url_by_path( sprintf( 'actors/%d/outbox', $user_id ) ); // phpcs:ignore - $json->totalItems = 0; // phpcs:ignore + $json->partOf = get_rest_url_by_path( sprintf( 'actors/%d/outbox', $user_id ) ); + $json->totalItems = 0; if ( $user_id > 0 ) { $count_posts = \count_user_posts( $user_id, $post_types, true ); - $json->totalItems = \intval( $count_posts ); // phpcs:ignore + $json->totalItems = \intval( $count_posts ); } else { foreach ( $post_types as $post_type ) { $count_posts = \wp_count_posts( $post_type ); - $json->totalItems += \intval( $count_posts->publish ); // phpcs:ignore + $json->totalItems += \intval( $count_posts->publish ); } } - $json->first = \add_query_arg( 'page', 1, $json->partOf ); // phpcs:ignore - $json->last = \add_query_arg( 'page', \ceil ( $json->totalItems / 10 ), $json->partOf ); // phpcs:ignore + $json->first = \add_query_arg( 'page', 1, $json->partOf ); + $json->last = \add_query_arg( 'page', \ceil( $json->totalItems / 10 ), $json->partOf ); - if ( $page && ( ( \ceil ( $json->totalItems / 10 ) ) > $page ) ) { // phpcs:ignore - $json->next = \add_query_arg( 'page', $page + 1, $json->partOf ); // phpcs:ignore + if ( $page && ( ( \ceil( $json->totalItems / 10 ) ) > $page ) ) { + $json->next = \add_query_arg( 'page', $page + 1, $json->partOf ); } if ( $page && ( $page > 1 ) ) { // phpcs:ignore - $json->prev = \add_query_arg( 'page', $page - 1, $json->partOf ); // phpcs:ignore + $json->prev = \add_query_arg( 'page', $page - 1, $json->partOf ); } + // phpcs:enable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase if ( $page ) { $posts = \get_posts( @@ -121,15 +128,19 @@ class Outbox { $activity = new Activity(); $activity->set_type( 'Create' ); $activity->set_object( $post ); - $json->orderedItems[] = $activity->to_array( false ); // phpcs:ignore + $json->orderedItems[] = $activity->to_array( false ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase } } - // filter output + /** + * Filter the ActivityPub outbox array. + * + * @param array $json The ActivityPub outbox array. + */ $json = \apply_filters( 'activitypub_rest_outbox_array', $json ); - /* - * Action triggerd after the ActivityPub profile has been created and sent to the client + /** + * Action triggered after the ActivityPub profile has been created and sent to the client */ \do_action( 'activitypub_outbox_post' ); @@ -140,9 +151,9 @@ class Outbox { } /** - * The supported parameters + * The supported parameters. * - * @return array list of parameters + * @return array List of parameters. */ public static function request_parameters() { $params = array(); diff --git a/includes/rest/class-server.php b/includes/rest/class-server.php index a910e367..aac34982 100644 --- a/includes/rest/class-server.php +++ b/includes/rest/class-server.php @@ -1,14 +1,19 @@ get_route(); - // check if it is an activitypub request and exclude webfinger and nodeinfo endpoints + // Check if it is an activitypub request and exclude webfinger and nodeinfo endpoints. if ( ! \str_starts_with( $route, '/' . ACTIVITYPUB_REST_NAMESPACE ) || \str_starts_with( $route, '/' . \trailingslashit( ACTIVITYPUB_REST_NAMESPACE ) . 'webfinger' ) || @@ -95,13 +100,13 @@ class Server { } /** - * Filter to defer signature verification + * Filter to defer signature verification. * * Skip signature verification for debugging purposes or to reduce load for * certain Activity-Types, like "Delete". * - * @param bool $defer Whether to defer signature verification. - * @param WP_REST_Request $request The request used to generate the response. + * @param bool $defer Whether to defer signature verification. + * @param \WP_REST_Request $request The request used to generate the response. * * @return bool Whether to defer signature verification. */ @@ -112,9 +117,9 @@ class Server { } if ( - // POST-Requests are always signed + // POST-Requests are always signed. 'GET' !== $request->get_method() || - // GET-Requests only require a signature in secure mode + // GET-Requests only require a signature in secure mode. ( 'GET' === $request->get_method() && ACTIVITYPUB_AUTHORIZED_FETCH ) ) { $verified_request = Signature::verify_http_signature( $request ); @@ -133,10 +138,10 @@ class Server { /** * Callback function to validate incoming ActivityPub requests * - * @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response Result to send to the client. - * Usually a WP_REST_Response or WP_Error. - * @param array $handler Route handler used for the request. - * @param WP_REST_Request $request Request used to generate the response. + * @param WP_REST_Response|\WP_HTTP_Response|WP_Error|mixed $response Result to send to the client. + * Usually a WP_REST_Response or WP_Error. + * @param array $handler Route handler used for the request. + * @param \WP_REST_Request $request Request used to generate the response. * * @return mixed|WP_Error The response, error, or modified response. */ @@ -156,7 +161,7 @@ class Server { $params = $request->get_json_params(); - // Type is required for ActivityPub requests, so it fail later in the process + // Type is required for ActivityPub requests, so it fail later in the process. if ( ! isset( $params['type'] ) ) { return $response; } diff --git a/includes/rest/class-webfinger.php b/includes/rest/class-webfinger.php index b6bba3d5..868ed50d 100644 --- a/includes/rest/class-webfinger.php +++ b/includes/rest/class-webfinger.php @@ -1,11 +1,16 @@ id === 'settings_page_activitypub' ) { $this->user_id = Users::BLOG_USER_ID; @@ -30,6 +47,11 @@ class Followers extends WP_List_Table { ); } + /** + * Get columns. + * + * @return array + */ public function get_columns() { return array( 'cb' => '', @@ -42,16 +64,22 @@ class Followers extends WP_List_Table { ); } + /** + * Returns sortable columns. + * + * @return array + */ public function get_sortable_columns() { - $sortable_columns = array( + return array( 'post_title' => array( 'post_title', true ), 'modified' => array( 'modified', false ), 'published' => array( 'published', false ), ); - - return $sortable_columns; } + /** + * Prepare items. + */ public function prepare_items() { $columns = $this->get_columns(); $hidden = array(); @@ -113,12 +141,24 @@ class Followers extends WP_List_Table { } } + /** + * Returns bulk actions. + * + * @return array + */ public function get_bulk_actions() { return array( 'delete' => __( 'Delete', 'activitypub' ), ); } + /** + * Column default. + * + * @param array $item Item. + * @param string $column_name Column name. + * @return string + */ public function column_default( $item, $column_name ) { if ( ! array_key_exists( $column_name, $item ) ) { return __( 'None', 'activitypub' ); @@ -126,6 +166,12 @@ class Followers extends WP_List_Table { return $item[ $column_name ]; } + /** + * Column avatar. + * + * @param array $item Item. + * @return string + */ public function column_avatar( $item ) { return sprintf( '', @@ -133,45 +179,63 @@ class Followers extends WP_List_Table { ); } + /** + * Column url. + * + * @param array $item Item. + * @return string + */ public function column_url( $item ) { return sprintf( '%s', - $item['url'], + esc_url( $item['url'] ), $item['url'] ); } + /** + * Column cb. + * + * @param array $item Item. + * @return string + */ public function column_cb( $item ) { return sprintf( '', esc_attr( $item['identifier'] ) ); } + /** + * Process action. + */ public function process_action() { if ( ! isset( $_REQUEST['followers'] ) || ! isset( $_REQUEST['_wpnonce'] ) ) { - return false; + return; } $nonce = sanitize_text_field( wp_unslash( $_REQUEST['_wpnonce'] ) ); if ( ! wp_verify_nonce( $nonce, 'bulk-' . $this->_args['plural'] ) ) { - return false; + return; } if ( ! current_user_can( 'edit_user', $this->user_id ) ) { - return false; + return; } $followers = $_REQUEST['followers']; // phpcs:ignore - switch ( $this->current_action() ) { - case 'delete': - if ( ! is_array( $followers ) ) { - $followers = array( $followers ); - } - foreach ( $followers as $follower ) { - FollowerCollection::remove_follower( $this->user_id, $follower ); - } - break; + if ( $this->current_action() === 'delete' ) { + if ( ! is_array( $followers ) ) { + $followers = array( $followers ); + } + foreach ( $followers as $follower ) { + FollowerCollection::remove_follower( $this->user_id, $follower ); + } } } + /** + * Returns user count. + * + * @return int + */ public function get_user_count() { return FollowerCollection::count_followers( $this->user_id ); } diff --git a/includes/transformer/class-attachment.php b/includes/transformer/class-attachment.php index 2fc46350..98aaf8bf 100644 --- a/includes/transformer/class-attachment.php +++ b/includes/transformer/class-attachment.php @@ -1,10 +1,14 @@ wp_object->ID ); $media_type = preg_replace( '/(\/[a-zA-Z]+)/i', '', $mime_type ); + $type = ''; switch ( $media_type ) { case 'audio': diff --git a/includes/transformer/class-base.php b/includes/transformer/class-base.php index f33e5642..6d4c202a 100644 --- a/includes/transformer/class-base.php +++ b/includes/transformer/class-base.php @@ -1,4 +1,10 @@ wp_object = $wp_object; @@ -50,9 +55,9 @@ abstract class Base { /** * Transform all properties with available get(ter) functions. * - * @param Base_Object|object $object + * @param Base_Object|object $activitypub_object The ActivityPub Object. * - * @return Base_Object|object $object + * @return Base_Object|object */ protected function transform_object_properties( $activitypub_object ) { $vars = $activitypub_object->get_object_var_keys(); @@ -76,13 +81,12 @@ abstract class Base { /** * Transform the WordPress Object into an ActivityPub Object. * - * @return Activitypub\Activity\Base_Object + * @return Base_Object|object The ActivityPub Object. */ public function to_object() { $activitypub_object = new Base_Object(); - $activitypub_object = $this->transform_object_properties( $activitypub_object ); - return $activitypub_object; + return $this->transform_object_properties( $activitypub_object ); } /** @@ -90,7 +94,7 @@ abstract class Base { * * @param string $type The Activity-Type. * - * @return \Activitypub\Activity\Activity The Activity. + * @return Activity The Activity. */ public function to_activity( $type ) { $object = $this->to_object(); @@ -101,7 +105,7 @@ abstract class Base { // Pre-fill the Activity with data (for example cc and to). $activity->set_object( $object ); - // Use simple Object (only ID-URI) for Like and Announce + // Use simple Object (only ID-URI) for Like and Announce. if ( in_array( $type, array( 'Like', 'Announce' ), true ) ) { $activity->set_object( $object->get_id() ); } @@ -109,27 +113,27 @@ abstract class Base { return $activity; } + /** + * Get the ID of the WordPress Object. + */ abstract protected function get_id(); /** * Get the replies Collection. */ public function get_replies() { - $replies = Replies::get_collection( $this->wp_object, $this->get_id() ); - return $replies; + return Replies::get_collection( $this->wp_object ); } /** * Returns the ID of the WordPress Object. - * - * @return int The ID of the WordPress Object */ abstract public function get_wp_user_id(); /** * Change the User-ID of the WordPress Post. * - * @return int The User-ID of the WordPress Post + * @param int $user_id The new user ID. */ abstract public function change_wp_user_id( $user_id ); } diff --git a/includes/transformer/class-comment.php b/includes/transformer/class-comment.php index 930f8fe5..7f0d3f68 100644 --- a/includes/transformer/class-comment.php +++ b/includes/transformer/class-comment.php @@ -1,21 +1,23 @@ wp_object->user_id = $user_id; } /** - * Transforms the WP_Comment object to an ActivityPub Object + * Transforms the WP_Comment object to an ActivityPub Object. * * @see \Activitypub\Activity\Base_Object * - * @return \Activitypub\Activity\Base_Object The ActivityPub Object + * @return \Activitypub\Activity\Base_Object The ActivityPub Object. */ public function to_object() { $comment = $this->wp_object; @@ -106,28 +108,41 @@ class Comment extends Base { * @return string The content. */ protected function get_content() { - // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited $comment = $this->wp_object; $content = $comment->comment_content; + /** + * Filter the content of the comment. + * + * @param string $content The content of the comment. + * @param \WP_Comment $comment The comment object. + * @param array $args The arguments. + * + * @return string The filtered content of the comment. + */ $content = \apply_filters( 'comment_text', $content, $comment, array() ); $content = \preg_replace( '/[\n\r\t]/', '', $content ); $content = \trim( $content ); - $content = \apply_filters( 'activitypub_the_content', $content, $comment ); - return $content; + /** + * Filter the content of the comment. + * + * @param string $content The content of the comment. + * @param \WP_Comment $comment The comment object. + * + * @return string The filtered content of the comment. + */ + return \apply_filters( 'activitypub_the_content', $content, $comment ); } /** * Returns the in-reply-to for the ActivityPub Item. * - * @return int The URL of the in-reply-to. + * @return false|string|null The URL of the in-reply-to. */ protected function get_in_reply_to() { - $comment = $this->wp_object; - + $comment = $this->wp_object; $parent_comment = null; - $in_reply_to = null; if ( $comment->comment_parent ) { $parent_comment = \get_comment( $comment->comment_parent ); @@ -211,6 +226,15 @@ class Comment extends Base { protected function get_mentions() { \add_filter( 'activitypub_extract_mentions', array( $this, 'extract_reply_context' ) ); + /** + * Filter the mentions in the comment. + * + * @param array $mentions The list of mentions. + * @param string $content The content of the comment. + * @param \WP_Comment $comment The comment object. + * + * @return array The filtered list of mentions. + */ return apply_filters( 'activitypub_extract_mentions', array(), $this->wp_object->comment_content, $this->wp_object ); } @@ -222,7 +246,7 @@ class Comment extends Base { protected function get_comment_ancestors() { $ancestors = get_comment_ancestors( $this->wp_object ); - // Now that we have the full tree of ancestors, only return the ones received from the fediverse + // Now that we have the full tree of ancestors, only return the ones received from the fediverse. return array_filter( $ancestors, function ( $comment_id ) { @@ -235,12 +259,12 @@ class Comment extends Base { * Collect all other Users that participated in this comment-thread * to send them a notification about the new reply. * - * @param array $mentions The already mentioned ActivityPub users + * @param array $mentions The already mentioned ActivityPub users. * * @return array The list of all Repliers. */ public function extract_reply_context( $mentions ) { - // Check if `$this->wp_object` is a WP_Comment + // Check if `$this->wp_object` is a WP_Comment. if ( 'WP_Comment' !== get_class( $this->wp_object ) ) { return $mentions; } @@ -276,9 +300,9 @@ class Comment extends Base { /** * Filter the locale of the comment. * - * @param string $lang The locale of the comment. - * @param int $comment_id The comment ID. - * @param WP_Post $post The comment object. + * @param string $lang The locale of the comment. + * @param int $comment_id The comment ID. + * @param \WP_Post $post The comment object. * * @return string The filtered locale of the comment. */ diff --git a/includes/transformer/class-factory.php b/includes/transformer/class-factory.php index 2824072c..e8e59796 100644 --- a/includes/transformer/class-factory.php +++ b/includes/transformer/class-factory.php @@ -1,11 +1,13 @@ post_type ) { diff --git a/includes/transformer/class-post.php b/includes/transformer/class-post.php index ca996cf8..85a8b809 100644 --- a/includes/transformer/class-post.php +++ b/includes/transformer/class-post.php @@ -1,23 +1,26 @@ wp_object->post_author = $user_id; @@ -80,7 +85,7 @@ class Post extends Base { * * If `single_user` mode is enabled, the Blog-User is returned. * - * @return Activitypub\Activity\Actor The User-Object. + * @return \Activitypub\Activity\Actor The User-Object. */ protected function get_actor_object() { if ( $this->actor_object ) { @@ -126,7 +131,7 @@ class Post extends Base { $permalink = \get_post_meta( $post->ID, 'activitypub_canonical_url', true ); break; case 'draft': - // get_sample_permalink is in wp-admin, not always loaded + // Get_sample_permalink is in wp-admin, not always loaded. if ( ! \function_exists( '\get_sample_permalink' ) ) { require_once ABSPATH . 'wp-admin/includes/post.php'; } @@ -179,7 +184,7 @@ class Post extends Base { ); $id = $this->wp_object->ID; - // list post thumbnail first if this post has one + // List post thumbnail first if this post has one. if ( \function_exists( 'has_post_thumbnail' ) && \has_post_thumbnail( $id ) ) { $media['image'][] = array( 'id' => \get_post_thumbnail_id( $id ) ); } @@ -207,17 +212,17 @@ class Post extends Base { */ $media = \apply_filters( 'activitypub_attachment_ids', $media, $this->wp_object ); - $attchments = \array_filter( \array_map( array( self::class, 'wp_attachment_to_activity_attachment' ), $media ) ); + $attachments = \array_filter( \array_map( array( self::class, 'wp_attachment_to_activity_attachment' ), $media ) ); /** * Filter the attachments for a post. * - * @param array $attchments The attachments. + * @param array $attachments The attachments. * @param WP_Post $this->wp_object The post object. * * @return array The filtered attachments. */ - return \apply_filters( 'activitypub_attachments', $attchments, $this->wp_object ); + return \apply_filters( 'activitypub_attachments', $attachments, $this->wp_object ); } /** @@ -235,7 +240,7 @@ class Post extends Base { } foreach ( $enclosures as $enclosure ) { - // check if URL is an attachment + // Check if URL is an attachment. $attachment_id = \attachment_url_to_postid( $enclosure['url'] ); if ( $attachment_id ) { $enclosure['id'] = $attachment_id; @@ -271,29 +276,27 @@ class Post extends Base { * @return array The attachments. */ protected function get_block_attachments( $media, $max_media ) { - // max media can't be negative or zero + // Max media can't be negative or zero. if ( $max_media <= 0 ) { return array(); } $blocks = \parse_blocks( $this->wp_object->post_content ); - $media = self::get_media_from_blocks( $blocks, $media ); - return $media; + return self::get_media_from_blocks( $blocks, $media ); } /** * Recursively get media IDs from blocks. * - * @param array $blocks The blocks to search for media IDs - * @param array $media The media IDs to append new IDs to - * @param int $max_media The maximum number of media to return. + * @param array $blocks The blocks to search for media IDs. + * @param array $media The media IDs to append new IDs to. * * @return array The image IDs. */ protected static function get_media_from_blocks( $blocks, $media ) { foreach ( $blocks as $block ) { - // recurse into inner blocks + // Recurse into inner blocks. if ( ! empty( $block['innerBlocks'] ) ) { $media = self::get_media_from_blocks( $block['innerBlocks'], $media ); } @@ -364,7 +367,7 @@ class Post extends Base { * @return array The attachments. */ protected function get_classic_editor_images( $media, $max_images ) { - // max images can't be negative or zero + // Max images can't be negative or zero. if ( $max_images <= 0 ) { return array(); } @@ -388,12 +391,12 @@ class Post extends Base { * @return array The attachments. */ protected function get_classic_editor_image_embeds( $max_images ) { - // if someone calls that function directly, bail + // If someone calls that function directly, bail. if ( ! \class_exists( '\WP_HTML_Tag_Processor' ) ) { return array(); } - // max images can't be negative or zero + // Max images can't be negative or zero. if ( $max_images <= 0 ) { return array(); } @@ -403,20 +406,21 @@ class Post extends Base { $content = \get_post_field( 'post_content', $this->wp_object ); $tags = new \WP_HTML_Tag_Processor( $content ); - // This linter warning is a false positive - we have to - // re-count each time here as we modify $images. + // This linter warning is a false positive - we have to re-count each time here as we modify $images. // phpcs:ignore Squiz.PHP.DisallowSizeFunctionsInLoops.Found while ( $tags->next_tag( 'img' ) && ( \count( $images ) <= $max_images ) ) { $src = $tags->get_attribute( 'src' ); - // If the img source is in our uploads dir, get the - // associated ID. Note: if there's a -500x500 - // type suffix, we remove it, but we try the original - // first in case the original image is actually called - // that. Likewise, we try adding the -scaled suffix for - // the case that this is a small version of an image - // that was big enough to get scaled down on upload: - // https://make.wordpress.org/core/2019/10/09/introducing-handling-of-big-images-in-wordpress-5-3/ + /* + * If the img source is in our uploads dir, get the + * associated ID. Note: if there's a -500x500 + * type suffix, we remove it, but we try the original + * first in case the original image is actually called + * that. Likewise, we try adding the -scaled suffix for + * the case that this is a small version of an image + * that was big enough to get scaled down on upload: + * https://make.wordpress.org/core/2019/10/09/introducing-handling-of-big-images-in-wordpress-5-3/ + */ if ( null !== $src && \str_starts_with( $src, $base ) ) { $img_id = \attachment_url_to_postid( $src ); @@ -455,7 +459,7 @@ class Post extends Base { * @return array The attachment IDs. */ protected function get_classic_editor_image_attachments( $max_images ) { - // max images can't be negative or zero + // Max images can't be negative or zero. if ( $max_images <= 0 ) { return array(); } @@ -485,12 +489,21 @@ class Post extends Base { /** * Filter media IDs by object type. * - * @param array $media The media array grouped by type. - * @param string $type The object type. + * @param array $media The media array grouped by type. + * @param string $type The object type. + * @param WP_Post $wp_object The post object. * * @return array The filtered media IDs. */ protected static function filter_media_by_object_type( $media, $type, $wp_object ) { + /** + * Filter the object type for media attachments. + * + * @param string $type The object type. + * @param WP_Post $wp_object The post object. + * + * @return string The filtered object type. + */ $type = \apply_filters( 'filter_media_by_object_type', \strtolower( $type ), $wp_object ); if ( ! empty( $media[ $type ] ) ) { @@ -516,7 +529,7 @@ class Post extends Base { $attachment = array(); $mime_type = \get_post_mime_type( $id ); $mime_type_parts = \explode( '/', $mime_type ); - // switching on image/audio/video + // Switching on image/audio/video. switch ( $mime_type_parts[0] ) { case 'image': $image_size = 'large'; @@ -564,7 +577,7 @@ class Post extends Base { 'name' => \esc_attr( \get_the_title( $id ) ), ); $meta = wp_get_attachment_metadata( $id ); - // height and width for videos + // Height and width for videos. if ( isset( $meta['width'] ) && isset( $meta['height'] ) ) { $attachment['width'] = \esc_attr( $meta['width'] ); $attachment['height'] = \esc_attr( $meta['height'] ); @@ -573,6 +586,14 @@ class Post extends Base { break; } + /** + * Filter the attachment for a post. + * + * @param array $attachment The attachment. + * @param int $id The attachment ID. + * + * @return array The filtered attachment. + */ return \apply_filters( 'activitypub_attachment', $attachment, $id ); } @@ -679,7 +700,11 @@ class Post extends Base { return $cc; } - + /** + * Returns the Audience for the Post. + * + * @return string|null The audience. + */ public function get_audience() { if ( is_single_user() ) { return null; @@ -818,7 +843,7 @@ class Post extends Base { $content = \apply_filters( 'activitypub_the_content', $content, $post ); - // Don't need these any more, should never appear in a post. + // Don't need these anymore, should never appear in a post. Shortcodes::unregister(); return $content; @@ -863,6 +888,15 @@ class Post extends Base { * @return array The list of @-Mentions. */ protected function get_mentions() { + /** + * Filter the mentions in the post content. + * + * @param array $mentions The mentions. + * @param string $content The post content. + * @param WP_Post $post The post object. + * + * @return array The filtered mentions. + */ return apply_filters( 'activitypub_extract_mentions', array(), @@ -1002,8 +1036,8 @@ class Post extends Base { * @see https://www.w3.org/TR/activitypub/#security-sanitizing-content * @see https://www.w3.org/wiki/ActivityPub/Primer/HTML * - * @param string $block_content The block content (html) - * @param object $block The block object + * @param string $block_content The block content (html). + * @param object $block The block object. * * @return string A block level link */ diff --git a/integration/class-buddypress.php b/integration/class-buddypress.php index 14afbe4d..1e86ee5f 100644 --- a/integration/class-buddypress.php +++ b/integration/class-buddypress.php @@ -1,23 +1,37 @@ url = bp_core_get_user_domain( $author_id ); // add BP member profile URL as user URL + $author->url = bp_core_get_user_domain( $author_id ); // Add BP member profile URL as user URL. - // add BuddyPress' cover_image instead of WordPress' header_image + // Add BuddyPress' cover_image instead of WordPress' header_image. $cover_image_url = bp_attachments_get_attachment( 'url', array( 'item_id' => $author_id ) ); if ( $cover_image_url ) { @@ -27,7 +41,7 @@ class Buddypress { ); } - // change profile URL to BuddyPress' profile URL + // Change profile URL to BuddyPress' profile URL. $author->attachment['profile_url'] = array( 'type' => 'PropertyValue', 'name' => \__( 'Profile', 'activitypub' ), @@ -43,9 +57,9 @@ class Buddypress { ), ); - // replace blog URL on multisite + // Replace blog URL on multisite. if ( is_multisite() ) { - $user_blogs = get_blogs_of_user( $author_id ); // get sites of user to send as AP metadata + $user_blogs = get_blogs_of_user( $author_id ); // Get sites of user to send as AP metadata. if ( ! empty( $user_blogs ) ) { unset( $author->attachment['blog_url'] ); diff --git a/integration/class-enable-mastodon-apps.php b/integration/class-enable-mastodon-apps.php index c04b68fa..04c24ff7 100644 --- a/integration/class-enable-mastodon-apps.php +++ b/integration/class-enable-mastodon-apps.php @@ -1,4 +1,10 @@ update_icon( $data['avatar'] ) ) { - // unset the avatar so it doesn't get saved again by other plugins. + // Unset the avatar so it doesn't get saved again by other plugins. // Ditto for all other fields below. unset( $data['avatar'] ); } @@ -106,7 +110,7 @@ class Enable_Mastodon_Apps { } /** - * Get extra fields for Mastodon API + * Get extra fields for Mastodon API. * * @param int $user_id The user id to act on. * @return array The extra fields. @@ -126,11 +130,10 @@ class Enable_Mastodon_Apps { } /** - * Set extra fields for Mastodon API + * Set extra fields for Mastodon API. * * @param int $user_id The user id to act on. * @param array $fields The fields to set. It is assumed to be the entire set of desired fields. - * @return void */ private static function set_extra_fields( $user_id, $fields ) { // The Mastodon API submits a simple hash for every field. @@ -168,12 +171,12 @@ class Enable_Mastodon_Apps { } } } + /** - * Add followers to Mastodon API + * Add followers to Mastodon API. * - * @param array $followers An array of followers - * @param string $user_id The user id - * @param WP_REST_Request $request The request object + * @param array $followers An array of followers. + * @param string $user_id The user id. * * @return array The filtered followers */ @@ -219,18 +222,16 @@ class Enable_Mastodon_Apps { $activitypub_followers ); - $followers = array_merge( $mastodon_followers, $followers ); - - return $followers; + return array_merge( $mastodon_followers, $followers ); } /** * Resolve external accounts for Mastodon API * - * @param Enable_Mastodon_Apps\Entity\Account $user_data The user data - * @param string $user_id The user id + * @param Account $user_data The user data. + * @param string $user_id The user id. * - * @return Enable_Mastodon_Apps\Entity\Account The filtered Account + * @return Account The filtered Account. */ public static function api_account_external( $user_data, $user_id ) { if ( $user_data || ( is_numeric( $user_id ) && $user_id ) ) { @@ -258,6 +259,14 @@ class Enable_Mastodon_Apps { return $user_data; } + /** + * Resolve internal accounts for Mastodon API + * + * @param Account $user_data The user data. + * @param string $user_id The user id. + * + * @return Account The filtered Account. + */ public static function api_account_internal( $user_data, $user_id ) { $user_id_to_use = self::maybe_map_user_to_blog( $user_id ); $user = Users::get_by_id( $user_id_to_use ); @@ -266,9 +275,9 @@ class Enable_Mastodon_Apps { return $user_data; } - // convert user to account. + // Convert user to account. $account = new Account(); - // even if we have a blog user, maintain the provided user_id so as not to confuse clients + // Even if we have a blog user, maintain the provided user_id so as not to confuse clients. $account->id = (int) $user_id; $account->username = $user->get_preferred_username(); $account->acct = $account->username; @@ -301,7 +310,7 @@ class Enable_Mastodon_Apps { $account->last_status_at = ! empty( $posts ) ? new DateTime( $posts[0]->post_date_gmt ) : $account->created_at; $account->fields = self::get_extra_fields( $user_id_to_use ); - // Now do it in source['fields'] with stripped tags + // Now do it in source['fields'] with stripped tags. $account->source['fields'] = \array_map( function ( $field ) { $field['value'] = \wp_strip_all_tags( $field['value'], true ); @@ -315,6 +324,13 @@ class Enable_Mastodon_Apps { return $account; } + /** + * Get account for actor. + * + * @param string $uri The URI. + * + * @return Account|null The account. + */ private static function get_account_for_actor( $uri ) { if ( ! is_string( $uri ) ) { return null; @@ -362,6 +378,14 @@ class Enable_Mastodon_Apps { return $account; } + /** + * Search by URL for Mastodon API. + * + * @param array $search_data The search data. + * @param object $request The request object. + * + * @return array The filtered search data. + */ public static function api_search_by_url( $search_data, $request ) { $p = \wp_parse_url( $request->get_param( 'q' ) ); if ( ! $p || ! isset( $p['host'] ) ) { @@ -386,6 +410,14 @@ class Enable_Mastodon_Apps { return $search_data; } + /** + * Search for Mastodon API. + * + * @param array $search_data The search data. + * @param object $request The request object. + * + * @return array The filtered search data. + */ public static function api_search( $search_data, $request ) { $user_id = \get_current_user_id(); if ( ! $user_id ) { @@ -433,6 +465,13 @@ class Enable_Mastodon_Apps { return $search_data; } + /** + * Get posts query args for Mastodon API. + * + * @param array $args The query arguments. + * + * @return array The filtered args. + */ public static function api_get_posts_query_args( $args ) { if ( isset( $args['author'] ) && is_string( $args['author'] ) ) { $uri = Webfinger_Util::resolve( $args['author'] ); @@ -445,6 +484,14 @@ class Enable_Mastodon_Apps { return $args; } + /** + * Convert an activity to a status. + * + * @param array $item The activity. + * @param Account $account The account. + * + * @return Status|null The status. + */ private static function activity_to_status( $item, $account ) { if ( isset( $item['object'] ) ) { $object = $item['object']; @@ -517,6 +564,14 @@ class Enable_Mastodon_Apps { return $status; } + /** + * Get posts for Mastodon API. + * + * @param array $statuses The statuses. + * @param array $args The arguments. + * + * @return array The filtered statuses. + */ public static function api_statuses_external( $statuses, $args ) { if ( ! isset( $args['activitypub'] ) ) { return $statuses; @@ -579,6 +634,15 @@ class Enable_Mastodon_Apps { return array_slice( $activitypub_statuses, 0, $limit ); } + /** + * Get replies for Mastodon API. + * + * @param array $context The context. + * @param int $post_id The post id. + * @param string $url The URL. + * + * @return array The filtered context. + */ public static function api_get_replies( $context, $post_id, $url ) { $meta = Http::get_remote_object( $url, true ); if ( is_wp_error( $meta ) || ! isset( $meta['replies']['first']['next'] ) ) { diff --git a/integration/class-jetpack.php b/integration/class-jetpack.php index d3662364..002de2cb 100644 --- a/integration/class-jetpack.php +++ b/integration/class-jetpack.php @@ -1,21 +1,40 @@ = '2.0' ) { @@ -47,11 +53,11 @@ class Nodeinfo { } /** - * Extend NodeInfo2 data + * Extend NodeInfo2 data. * - * @param array $nodeinfo NodeInfo2 data + * @param array $nodeinfo NodeInfo2 data. * - * @return array The extended array + * @return array The extended array. */ public static function add_nodeinfo2_data( $nodeinfo ) { $nodeinfo['protocols'][] = 'activitypub'; @@ -66,11 +72,11 @@ class Nodeinfo { } /** - * Extend the well-known nodeinfo data + * Extend the well-known nodeinfo data. * - * @param array $data The well-known nodeinfo data + * @param array $data The well-known nodeinfo data. * - * @return array The extended array + * @return array The extended array. */ public static function add_wellknown_nodeinfo_data( $data ) { $data['links'][] = array( diff --git a/integration/class-opengraph.php b/integration/class-opengraph.php index 2d0f8c96..4eb1b1e0 100644 --- a/integration/class-opengraph.php +++ b/integration/class-opengraph.php @@ -1,4 +1,10 @@ get_webfinger(); return $metadata; } if ( \is_author() ) { - // Use the Author of the Archive-Page + // Use the Author of the Archive-Page. $user_id = \get_queried_object_id(); } elseif ( \is_singular() ) { - // Use the Author of the Post + // Use the Author of the Post. $user_id = \get_post_field( 'post_author', \get_queried_object_id() ); } elseif ( ! is_user_type_disabled( 'blog' ) ) { - // Use the Blog-User for any other page, if the Blog-User is not disabled + // Use the Blog-User for any other page, if the Blog-User is not disabled. $user_id = Users::BLOG_USER_ID; } else { - // Do not add any metadata otherwise + // Do not add any metadata otherwise. return $metadata; } @@ -78,7 +84,7 @@ class Opengraph { return $metadata; } - // add WebFinger resource + // Add WebFinger resource. $metadata['fediverse:creator'] = $user->get_webfinger(); return $metadata; diff --git a/integration/class-seriously-simple-podcasting.php b/integration/class-seriously-simple-podcasting.php index 1a5ccbe8..c678f6d3 100644 --- a/integration/class-seriously-simple-podcasting.php +++ b/integration/class-seriously-simple-podcasting.php @@ -1,4 +1,10 @@ log( sprintf( - // translators: %s is a URL + // translators: %s is a URL. __( 'New Follower: %s', 'activitypub' ), $notification->actor ), diff --git a/integration/class-webfinger.php b/integration/class-webfinger.php index f566e523..7ae9607d 100644 --- a/integration/class-webfinger.php +++ b/integration/class-webfinger.php @@ -1,7 +1,12 @@ ID ); @@ -56,12 +61,12 @@ class Webfinger { } /** - * Add WebFinger discovery links + * Add WebFinger discovery links. * - * @param array $jrd the jrd array - * @param string $uri the WebFinger resource + * @param array $jrd The jrd array. + * @param string $uri The WebFinger resource. * - * @return array the jrd array + * @return array|\WP_Error The jrd array or WP_Error. */ public static function add_pseudo_user_discovery( $jrd, $uri ) { $user = User_Collection::get_by_resource( $uri ); diff --git a/integration/load.php b/integration/load.php index ed254bc3..0bdef288 100644 --- a/integration/load.php +++ b/integration/load.php @@ -1,10 +1,15 @@ - - - + diff --git a/templates/admin-header.php b/templates/admin-header.php index 2c310572..301f7348 100644 --- a/templates/admin-header.php +++ b/templates/admin-header.php @@ -1,5 +1,10 @@