PluginProbe
ActivityPub / 3.2.5
ActivityPub v3.2.5
9.3.1 9.3.0 9.2.2 9.2.1 9.2.0 9.1.0 9.0.2 9.0.1 9.0.0 8.3.0 8.2.1 8.2.0 8.1.1 1.0.5 1.0.6 1.0.7 1.0.8 1.0.9 1.1.0 1.2.0 1.3.0 2.0.0 2.0.1 2.1.0 2.1.1 All 160 releases
← All changes | includes/class-comment.php +203 -615 8.3.03.2.5 View file →
@@ -1,18 +1,16 @@
1 1 <?php
2 -/**
3 - * ActivityPub Comment Class
4 - *
5 - * @package Activitypub
6 - */
7 2
8 3 namespace Activitypub;
9 4
10 -use Activitypub\Collection\Actors;
11 -use Activitypub\Collection\Remote_Posts;
5 +use Activitypub\Collection\Users;
6 +use WP_Comment_Query;
12 7
8 +use function Activitypub\is_user_disabled;
9 +use function Activitypub\is_single_user;
10 +
13 11 /**
14 - * ActivityPub Comment Class.
12 + * ActivityPub Comment Class
15 13 *
16 14 * This class is a helper/utils class that provides a collection of static
17 15 * methods that are used to handle comments.
18 16 */
@@ -17,150 +15,76 @@
17 15 * methods that are used to handle comments.
18 16 */
19 17 class Comment {
20 18 /**
21 - * Initialize the class, registering WordPress hooks.
19 + * Initialize the class, registering WordPress hooks
22 20 */
23 21 public static function init() {
24 22 self::register_comment_types();
25 23
26 - \add_filter( 'map_meta_cap', array( self::class, 'map_meta_cap' ), 10, 4 );
27 24 \add_filter( 'comment_reply_link', array( self::class, 'comment_reply_link' ), 10, 3 );
28 25 \add_filter( 'comment_class', array( self::class, 'comment_class' ), 10, 3 );
29 - \add_filter( 'comment_feed_where', array( static::class, 'comment_feed_where' ) );
30 - \add_filter( 'get_comment_link', array( self::class, 'remote_comment_link' ), 11, 2 );
26 + \add_filter( 'get_comment_link', array( self::class, 'remote_comment_link' ), 11, 3 );
27 + \add_action( 'wp_enqueue_scripts', array( self::class, 'enqueue_scripts' ) );
31 28 \add_action( 'pre_get_comments', array( static::class, 'comment_query' ) );
32 - \add_filter( 'pre_comment_approved', array( static::class, 'pre_comment_approved' ), 11, 2 );
29 +
33 30 \add_filter( 'get_avatar_comment_types', array( static::class, 'get_avatar_comment_types' ), 99 );
34 - \add_action( 'update_option_activitypub_allow_likes', array( self::class, 'maybe_update_comment_counts' ), 10, 2 );
35 - \add_action( 'update_option_activitypub_allow_reposts', array( self::class, 'maybe_update_comment_counts' ), 10, 2 );
36 - \add_filter( 'pre_wp_update_comment_count_now', array( static::class, 'pre_wp_update_comment_count_now' ), 5, 3 );
37 - \add_filter( 'get_comment_author', array( static::class, 'render_emoji' ), 10, 2 );
38 - \add_filter( 'comment_author', array( static::class, 'unescape_emoji' ), 20 ); // After esc_html().
39 - \add_filter( 'rest_comment_query', array( static::class, 'rest_comment_query' ) );
40 - \add_filter( 'comment_text', array( static::class, 'render_blocks' ), 5 ); // Before other filters.
41 31 }
42 32
43 33 /**
44 - * Render blocks in comment content.
34 + * Filter the comment reply link.
45 35 *
46 - * Comments don't automatically parse blocks like posts do.
47 - * This filter applies do_blocks() to render activitypub/emoji
48 - * and activitypub/image blocks in comment content.
36 + * We don't want to show the comment reply link for federated comments
37 + * if the user is disabled for federation.
49 38 *
50 - * @param string $content The comment content.
39 + * @param string $link The HTML markup for the comment reply link.
40 + * @param array $args An array of arguments overriding the defaults.
41 + * @param WP_Comment $comment The object of the comment being replied.
51 42 *
52 - * @return string The content with blocks rendered.
43 + * @return string The filtered HTML markup for the comment reply link.
53 44 */
54 - public static function render_blocks( $content ) {
55 - if ( empty( $content ) || ! \str_contains( $content, '<!-- wp:activitypub/' ) ) {
56 - return $content;
57 - }
45 + public static function comment_reply_link( $link, $args, $comment ) {
46 + if ( self::are_comments_allowed( $comment ) ) {
47 + $user_id = get_current_user_id();
48 + if ( $user_id && self::was_received( $comment ) && \user_can( $user_id, 'activitypub' ) ) {
49 + return self::create_fediverse_reply_link( $link, $args );
50 + }
58 51
59 - $blocks = \parse_blocks( $content );
60 - $output = '';
61 -
62 - foreach ( $blocks as $block ) {
63 - if ( ! empty( $block['blockName'] ) && \str_starts_with( $block['blockName'], 'activitypub/' ) ) {
64 - $output .= \render_block( $block );
65 - } else {
66 - $output .= \serialize_block( $block );
67 - }
52 + return $link;
68 53 }
69 54
70 - return $output;
71 - }
55 + $attrs = array(
56 + 'selectedComment' => self::generate_id( $comment ),
57 + 'commentId' => $comment->comment_ID,
58 + );
72 59
73 - /**
74 - * Remove edit capabilities for comments received via ActivityPub.
75 - *
76 - * @param array $caps Array of capabilities.
77 - * @param string $cap Capability name.
78 - * @param int $user_id User ID.
79 - * @param array $args Array of arguments.
80 - *
81 - * @return array Modified array of capabilities.
82 - */
83 - public static function map_meta_cap( $caps, $cap, $user_id, $args ) {
84 - if ( 'edit_comment' === $cap && self::was_received( $args[0] ) ) {
85 - if ( ! \is_admin() || ( isset( $GLOBALS['current_screen'] ) && 'comment' === $GLOBALS['current_screen']->id ) ) {
86 - $caps[] = 'do_not_allow';
87 - }
88 - }
60 + $div = sprintf(
61 + '<div class="activitypub-remote-reply" data-attrs="%s"></div>',
62 + esc_attr( wp_json_encode( $attrs ) )
63 + );
89 64
90 - return $caps;
65 + return apply_filters( 'activitypub_comment_reply_link', $div );
91 66 }
92 67
93 68 /**
94 - * Filter the comment reply link.
69 + * Create a link to reply to a federated comment.
70 + * This function adds a title attribute to the reply link to inform the user
71 + * that the comment was received from the fediverse and the reply will be sent
72 + * to the original author.
95 73 *
96 - * Handles three cases for replies to fediverse comments:
97 - * 1. User can federate → show normal reply link
98 - * 2. User is logged in but can't federate → show warning (no reply link)
99 - * 3. User is not logged in → show remote reply block
74 + * @param string $link The HTML markup for the comment reply link.
75 + * @param array $args The args provided by the `comment_reply_link` filter.
100 76 *
101 - * @param string $link The HTML markup for the comment reply link.
102 - * @param array $args An array of arguments overriding the defaults.
103 - * @param \WP_Comment $comment The object of the comment being replied.
104 - *
105 - * @return string The filtered HTML markup for the comment reply link.
77 + * @return string The modified HTML markup for the comment reply link.
106 78 */
107 - public static function comment_reply_link( $link, $args, $comment ) {
108 - if ( self::are_comments_allowed( $comment ) ) {
109 - return $link;
110 - }
111 -
112 - // Logged-in user without ActivityPub capability - show warning instead of reply link.
113 - if ( \is_user_logged_in() ) {
114 - $author = \esc_html( $comment->comment_author );
115 -
116 - $message = sprintf(
117 - /* translators: %s: comment author name */
118 - \__( '%s is on the Fediverse. To reply to them, ask your administrator to enable ActivityPub for your account.', 'activitypub' ),
119 - $author
120 - );
121 -
122 - // Add link to users page if current user can edit users.
123 - if ( \current_user_can( 'edit_users' ) ) {
124 - $message = sprintf(
125 - /* translators: 1: comment author name, 2: URL to the users management page */
126 - \__( '%1$s is on the Fediverse. To reply to them, <a href="%2$s">enable ActivityPub for your account</a>.', 'activitypub' ),
127 - $author,
128 - \esc_url( \admin_url( 'users.php' ) )
129 - );
130 - }
131 -
132 - $warning = sprintf(
133 - '<p class="activitypub-reply-warning"><em>%s</em></p>',
134 - \wp_kses( $message, array( 'a' => array( 'href' => array() ) ) )
135 - );
136 -
137 - /**
138 - * Filters the warning message shown to logged-in users without ActivityPub capability.
139 - *
140 - * @param string $warning The warning HTML markup.
141 - * @param \WP_Comment $comment The comment being replied to.
142 - */
143 - return \apply_filters( 'activitypub_federation_warning', $warning, $comment );
144 - }
145 -
146 - if ( ! \WP_Block_Type_Registry::get_instance()->is_registered( 'activitypub/remote-reply' ) ) {
147 - \register_block_type_from_metadata( ACTIVITYPUB_PLUGIN_DIR . 'build/remote-reply' );
148 - }
149 -
150 - $attributes = array(
151 - 'selectedComment' => self::generate_id( $comment ),
152 - 'commentId' => $comment->comment_ID,
79 + private static function create_fediverse_reply_link( $link, $args ) {
80 + $str_to_replace = sprintf( '>%s<', $args['reply_text'] );
81 + $replace_with = sprintf(
82 + ' title="%s">%s<',
83 + esc_attr__( 'This comment was received from the fediverse and your reply will be sent to the original author', 'activitypub' ),
84 + esc_html__( 'Reply with federation', 'activitypub' )
153 85 );
154 -
155 - $block = \do_blocks( \sprintf( '<!-- wp:activitypub/remote-reply %s /-->', \wp_json_encode( $attributes ) ) );
156 -
157 - /**
158 - * Filters the HTML markup for the ActivityPub remote comment reply container.
159 - *
160 - * @param string $block The HTML markup for the remote reply container.
161 - */
162 - return \apply_filters( 'activitypub_comment_reply_link', $block );
86 + return str_replace( $str_to_replace, $replace_with, $link );
163 87 }
164 88
165 89 /**
166 90 * Check if it is allowed to comment to a comment.
@@ -183,15 +107,20 @@
183 107 if ( ! $current_user ) {
184 108 return false;
185 109 }
186 110
187 - if ( is_single_user() && \user_can( $current_user, 'activitypub' ) ) {
188 - // On a single user site, comments by users with the `activitypub` capability will be federated as the blog user.
189 - $current_user = Actors::BLOG_USER_ID;
111 + if ( is_single_user() && \user_can( $current_user, 'publish_posts' ) ) {
112 + // On a single user site, comments by users with the `publish_posts` capability will be federated as the blog user
113 + $current_user = Users::BLOG_USER_ID;
190 114 }
191 115
192 - // User is not allowed to federate comments.
193 - return user_can_activitypub( $current_user );
116 + $is_user_disabled = is_user_disabled( $current_user );
117 +
118 + if ( $is_user_disabled ) {
119 + return false;
120 + }
121 +
122 + return true;
194 123 }
195 124
196 125 /**
197 126 * Check if a comment is federated.
@@ -275,9 +204,9 @@
275 204 *
276 205 * @return boolean True if the comment should be federated, false otherwise.
277 206 */
278 207 public static function should_be_federated( $comment ) {
279 - // We should not federate federated comments.
208 + // we should not federate federated comments
280 209 if ( self::was_received( $comment ) ) {
281 210 return false;
282 211 }
283 212
@@ -283,29 +212,31 @@
283 212
284 213 $comment = \get_comment( $comment );
285 214 $user_id = $comment->user_id;
286 215
287 - // Comments without user can't be federated.
216 + // comments without user can't be federated
288 217 if ( ! $user_id ) {
289 218 return false;
290 219 }
291 220
292 - if ( is_single_user() && \user_can( $user_id, 'activitypub' ) ) {
293 - // On a single user site, comments by users with the `activitypub` capability will be federated as the blog user.
294 - $user_id = Actors::BLOG_USER_ID;
221 + if ( is_single_user() && \user_can( $user_id, 'publish_posts' ) ) {
222 + // On a single user site, comments by users with the `publish_posts` capability will be federated as the blog user
223 + $user_id = Users::BLOG_USER_ID;
295 224 }
296 225
297 - // User is not allowed to federate comments.
298 - if ( ! user_can_activitypub( $user_id ) ) {
226 + $is_user_disabled = is_user_disabled( $user_id );
227 +
228 + // user is disabled for federation
229 + if ( $is_user_disabled ) {
299 230 return false;
300 231 }
301 232
302 - // It is a comment to the post and can be federated.
233 + // it is a comment to the post and can be federated
303 234 if ( empty( $comment->comment_parent ) ) {
304 235 return true;
305 236 }
306 237
307 - // Check if parent comment is federated.
238 + // check if parent comment is federated
308 239 $parent_comment = \get_comment( $comment->comment_parent );
309 240
310 241 return ! self::is_local( $parent_comment );
311 242 }
@@ -317,14 +248,12 @@
317 248 *
318 249 * @return \WP_Comment|false Comment object, or false on failure.
319 250 */
320 251 public static function object_id_to_comment( $id ) {
321 - $comment_query = new \WP_Comment_Query(
252 + $comment_query = new WP_Comment_Query(
322 253 array(
323 254 'meta_key' => 'source_id', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
324 255 'meta_value' => $id, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value
325 - 'orderby' => 'comment_date',
326 - 'order' => 'DESC',
327 256 )
328 257 );
329 258
330 259 if ( ! $comment_query->comments ) {
@@ -330,30 +259,34 @@
330 259 if ( ! $comment_query->comments ) {
331 260 return false;
332 261 }
333 262
263 + if ( count( $comment_query->comments ) > 1 ) {
264 + return false;
265 + }
266 +
334 267 return $comment_query->comments[0];
335 268 }
336 269
337 270 /**
338 271 * Verify if URL is a local comment, or if it is a previously received
339 - * remote comment (For threading comments locally).
272 + * remote comment (For threading comments locally)
340 273 *
341 274 * @param string $url The URL to check.
342 275 *
343 - * @return string|null Comment ID or null if not found.
276 + * @return int comment_ID or null if not found
344 277 */
345 278 public static function url_to_commentid( $url ) {
346 - if ( ! $url || ! \filter_var( $url, \FILTER_VALIDATE_URL ) ) {
279 + if ( ! $url || ! filter_var( $url, \FILTER_VALIDATE_URL ) ) {
347 280 return null;
348 281 }
349 282
350 - // Check for local comment.
351 - if ( is_same_domain( $url ) ) {
283 + // check for local comment
284 + if ( \wp_parse_url( \home_url(), \PHP_URL_HOST ) === \wp_parse_url( $url, \PHP_URL_HOST ) ) {
352 285 $query = \wp_parse_url( $url, \PHP_URL_QUERY );
353 286
354 287 if ( $query ) {
355 - \parse_str( $query, $params );
288 + parse_str( $query, $params );
356 289
357 290 if ( ! empty( $params['c'] ) ) {
358 291 $comment = \get_comment( $params['c'] );
359 292
@@ -378,9 +311,9 @@
378 311 ),
379 312 ),
380 313 );
381 314
382 - $query = new \WP_Comment_Query();
315 + $query = new WP_Comment_Query();
383 316 $comments = $query->query( $args );
384 317
385 318 if ( $comments && is_array( $comments ) ) {
386 319 return $comments[0]->comment_ID;
@@ -398,9 +331,9 @@
398 331 *
399 332 * @return string[] An array of classes.
400 333 */
401 334 public static function comment_class( $classes, $css_class, $comment_id ) {
402 - // Check if ActivityPub comment.
335 + // check if ActivityPub comment
403 336 if ( 'activitypub' === get_comment_meta( $comment_id, 'protocol', true ) ) {
404 337 $classes[] = 'activitypub-comment';
405 338 }
406 339
@@ -407,120 +340,52 @@
407 340 return $classes;
408 341 }
409 342
410 343 /**
411 - * Makes the comment feed filterable by comment type.
344 + * Link remote comments to source url.
412 345 *
413 - * Also excludes ActivityPub comment types from the feed when no type is specified.
346 + * @param string $comment_link
347 + * @param object|WP_Comment $comment
414 348 *
415 - * @param string $where The `WHERE` clause for the comment feed query.
416 - *
417 - * @return string The modified `WHERE` clause.
349 + * @return string $url
418 350 */
419 - public static function comment_feed_where( $where ) {
420 - global $wpdb;
421 -
422 - $comment_type = \get_query_var( 'type' );
423 -
424 - if ( 'all' === $comment_type ) {
425 - return $where;
351 + public static function remote_comment_link( $comment_link, $comment ) {
352 + if ( ! $comment || is_admin() ) {
353 + return $comment_link;
426 354 }
427 355
428 - $comment_types = self::get_comment_type_slugs();
356 + $comment_meta = \get_comment_meta( $comment->comment_ID );
429 357
430 - if ( \in_array( $comment_type, $comment_types, true ) ) {
431 - $where .= $wpdb->prepare( ' AND comment_type = %s', $comment_type );
432 - } else {
433 - $comment_types = \array_map( 'esc_sql', $comment_types );
434 - $placeholders = implode( ', ', array_fill( 0, count( $comment_types ), '%s' ) );
435 - // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber, WordPress.DB.PreparedSQL.NotPrepared
436 - $where .= $wpdb->prepare( sprintf( ' AND comment_type NOT IN (%s)', $placeholders ), ...$comment_types );
437 - }
438 -
439 - return $where;
440 - }
441 -
442 - /**
443 - * Gets the public comment id via the WordPress comments meta.
444 - *
445 - * @param int $wp_comment_id The internal WordPress comment ID.
446 - * @param bool $fallback Whether the code should fall back to `source_url` if `source_id` is not set.
447 - *
448 - * @return string|null The ActivityPub id/url of the comment.
449 - */
450 - public static function get_source_id( $wp_comment_id, $fallback = true ) {
451 - $comment_meta = \get_comment_meta( $wp_comment_id );
452 -
453 - if ( ! empty( $comment_meta['source_id'][0] ) ) {
454 - return $comment_meta['source_id'][0];
455 - } elseif ( ! empty( $comment_meta['source_url'][0] ) && $fallback ) {
456 - return $comment_meta['source_url'][0];
457 - }
458 -
459 - return null;
460 - }
461 -
462 - /**
463 - * Gets the public comment url via the WordPress comments meta.
464 - *
465 - * @param int $wp_comment_id The internal WordPress comment ID.
466 - * @param bool $fallback Whether the code should fall back to `source_id` if `source_url` is not set.
467 - *
468 - * @return string|null The ActivityPub id/url of the comment.
469 - */
470 - public static function get_source_url( $wp_comment_id, $fallback = true ) {
471 - $comment_meta = \get_comment_meta( $wp_comment_id );
472 -
473 358 if ( ! empty( $comment_meta['source_url'][0] ) ) {
474 359 return $comment_meta['source_url'][0];
475 - } elseif ( ! empty( $comment_meta['source_id'][0] ) && $fallback ) {
360 + } elseif ( ! empty( $comment_meta['source_id'][0] ) ) {
476 361 return $comment_meta['source_id'][0];
477 362 }
478 363
479 - return null;
364 + return $comment_link;
480 365 }
481 366
482 - /**
483 - * Link remote comments to source url.
484 - *
485 - * @param string $comment_link The comment link.
486 - * @param object|\WP_Comment $comment The comment object.
487 - *
488 - * @return string $url
489 - */
490 - public static function remote_comment_link( $comment_link, $comment ) {
491 - if ( ! $comment || \is_admin() || \is_search() ) {
492 - return $comment_link;
493 - }
494 367
495 - $remote_comment_link = null;
496 - if ( 'comment' === $comment->comment_type ) {
497 - $remote_comment_link = self::get_source_url( $comment->comment_ID );
498 - }
499 -
500 - return $remote_comment_link ?? $comment_link;
501 - }
502 -
503 -
504 368 /**
505 369 * Generates an ActivityPub URI for a comment
506 370 *
507 - * @param \WP_Comment|int $comment A comment object or comment ID.
371 + * @param WP_Comment|int $comment A comment object or comment ID
508 372 *
509 373 * @return string ActivityPub URI for comment
510 374 */
511 375 public static function generate_id( $comment ) {
512 - $comment = \get_comment( $comment );
376 + $comment = \get_comment( $comment );
377 + $comment_meta = \get_comment_meta( $comment->comment_ID );
513 378
514 - // Show external comment ID if it exists.
515 - $public_comment_link = self::get_source_id( $comment->comment_ID );
516 -
517 - if ( $public_comment_link ) {
518 - return $public_comment_link;
379 + // show external comment ID if it exists
380 + if ( ! empty( $comment_meta['source_id'][0] ) ) {
381 + return $comment_meta['source_id'][0];
382 + } elseif ( ! empty( $comment_meta['source_url'][0] ) ) {
383 + return $comment_meta['source_url'][0];
519 384 }
520 385
521 - // Generate URI based on comment ID.
522 - return \add_query_arg( 'c', $comment->comment_ID, \home_url( '/' ) );
386 + // generate URI based on comment ID
387 + return \add_query_arg( 'c', $comment->comment_ID, \trailingslashit( \home_url() ) );
523 388 }
524 389
525 390 /**
526 391 * Check if a post has remote comments
@@ -531,9 +396,9 @@
531 396 */
532 397 private static function post_has_remote_comments( $post_id ) {
533 398 $comments = \get_comments(
534 399 array(
535 - 'post_id' => $post_id,
400 + 'post_id' => $post_id,
536 401 // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
537 402 'meta_query' => array(
538 403 'relation' => 'AND',
539 404 array(
@@ -552,26 +417,57 @@
552 417 return ! empty( $comments );
553 418 }
554 419
555 420 /**
556 - * Get the comment type by activity type.
557 - *
558 - * @param string $activity_type The activity type.
559 - *
560 - * @return array|null The comment type.
421 + * Enqueue scripts for remote comments
561 422 */
562 - public static function get_comment_type_by_activity_type( $activity_type ) {
563 - $activity_type = \strtolower( $activity_type );
564 - $activity_type = \sanitize_key( $activity_type );
565 - $comment_types = self::get_comment_types();
423 + public static function enqueue_scripts() {
424 + if ( ! \is_singular() || \is_user_logged_in() ) {
425 + // only on single pages, only for logged out users
426 + return;
427 + }
566 428
567 - foreach ( $comment_types as $comment_type ) {
568 - if ( in_array( $activity_type, $comment_type['activity_types'], true ) ) {
569 - return $comment_type;
570 - }
429 + if ( ! \post_type_supports( \get_post_type(), 'activitypub' ) ) {
430 + // post type does not support ActivityPub
431 + return;
571 432 }
572 433
573 - return null;
434 + if ( ! \comments_open() || ! \get_comments_number() ) {
435 + // no comments, no need to load the script
436 + return;
437 + }
438 +
439 + if ( ! self::post_has_remote_comments( \get_the_ID() ) ) {
440 + // no remote comments, no need to load the script
441 + return;
442 + }
443 +
444 + $handle = 'activitypub-remote-reply';
445 + $data = array(
446 + 'namespace' => ACTIVITYPUB_REST_NAMESPACE,
447 + );
448 + $js = sprintf( 'var _activityPubOptions = %s;', wp_json_encode( $data ) );
449 + $asset_file = ACTIVITYPUB_PLUGIN_DIR . 'build/remote-reply/index.asset.php';
450 +
451 + if ( \file_exists( $asset_file ) ) {
452 + $assets = require_once $asset_file;
453 +
454 + \wp_enqueue_script(
455 + $handle,
456 + \plugins_url( 'build/remote-reply/index.js', __DIR__ ),
457 + $assets['dependencies'],
458 + $assets['version'],
459 + true
460 + );
461 + \wp_add_inline_script( $handle, $js, 'before' );
462 +
463 + \wp_enqueue_style(
464 + $handle,
465 + \plugins_url( 'build/remote-reply/style-index.css', __DIR__ ),
466 + [ 'wp-components' ],
467 + $assets['version']
468 + );
469 + }
574 470 }
575 471
576 472 /**
577 473 * Return the registered custom comment types.
@@ -580,81 +476,61 @@
580 476 */
581 477 public static function get_comment_types() {
582 478 global $activitypub_comment_types;
583 479
584 - return (array) $activitypub_comment_types;
480 + return $activitypub_comment_types;
585 481 }
586 482
587 483 /**
588 - * Is this a registered comment type.
484 + * Is this a registered comment type
589 485 *
590 - * @param string $slug The slug of the type.
591 - *
486 + * @param string $slug The name of the type
592 487 * @return boolean True if registered.
593 488 */
594 489 public static function is_registered_comment_type( $slug ) {
595 - $slug = \strtolower( $slug );
596 - $slug = \sanitize_key( $slug );
490 + $slug = strtolower( $slug );
491 + $slug = sanitize_key( $slug );
597 492
598 - $comment_types = self::get_comment_types();
599 -
600 - return isset( $comment_types[ $slug ] );
493 + return in_array( $slug, array_keys( self::get_comment_types() ), true );
601 494 }
602 495
603 496 /**
604 - * Return the registered custom comment type slugs.
497 + * Return the registered custom comment types names.
605 498 *
606 - * @return array The registered custom comment type slugs.
499 + * @return array The registered custom comment type names
607 500 */
608 - public static function get_comment_type_slugs() {
609 - if ( ! did_action( 'init' ) ) {
610 - _doing_it_wrong( __METHOD__, 'This function should not be called before the init action has run. Comment types are only available after init.', '7.5.0' );
611 -
612 - return array();
613 - }
614 -
615 - return array_keys( self::get_comment_types() );
501 + public static function get_comment_type_names() {
502 + return array_values( wp_list_pluck( self::get_comment_types(), 'type' ) );
616 503 }
617 504
618 505 /**
619 - * Get the custom comment type.
506 + * Get a comment type
620 507 *
621 - * Check if the type is registered, if not, check if it is a custom type.
508 + * @param string $type The comment type
622 509 *
623 - * It looks for the array key in the registered types and returns the array.
624 - * If it is not found, it looks for the type in the custom types and returns the array.
625 - *
626 - * @param string $type The comment type.
627 - *
628 - * @return array The comment type.
510 + * @return array The comment type
629 511 */
630 512 public static function get_comment_type( $type ) {
631 - $type = strtolower( $type );
632 - $type = sanitize_key( $type );
513 + $type = strtolower( $type );
514 + $type = sanitize_key( $type );
515 + $types = self::get_comment_types();
633 516
634 - $comment_types = self::get_comment_types();
635 - $type_array = array();
636 -
637 - // Check array keys.
638 - if ( in_array( $type, array_keys( $comment_types ), true ) ) {
639 - $type_array = $comment_types[ $type ];
517 + if ( in_array( $type, array_keys( $types ), true ) ) {
518 + $type_array = $types[ $type ];
519 + } else {
520 + $type_array = array();
640 521 }
641 522
642 - /**
643 - * Filter the comment type.
644 - *
645 - * @param array $type_array The comment type.
646 - */
647 523 return apply_filters( "activitypub_comment_type_{$type}", $type_array );
648 524 }
649 525
650 526 /**
651 - * Get a comment type attribute.
527 + * Get a comment type attribute
652 528 *
653 - * @param string $type The comment type.
654 - * @param string $attr The attribute to get.
529 + * @param string $type The comment type
530 + * @param string $attr The attribute to get
655 531 *
656 - * @return mixed The value of the attribute.
532 + * @return mixed The value of the attribute
657 533 */
658 534 public static function get_comment_type_attr( $type, $attr ) {
659 535 $type_array = self::get_comment_type( $type );
660 536
@@ -663,37 +539,30 @@
663 539 } else {
664 540 $value = '';
665 541 }
666 542
667 - /**
668 - * Filter the comment type attribute.
669 - *
670 - * @param mixed $value The value of the attribute.
671 - * @param string $type The comment type.
672 - */
673 543 return apply_filters( "activitypub_comment_type_{$attr}", $value, $type );
674 544 }
675 545
546 +
547 +
676 548 /**
677 - * Register the comment types used by the ActivityPub plugin.
549 + * Register the comment types used by the ActivityPub plugin
550 + *
551 + * @return void
678 552 */
679 553 public static function register_comment_types() {
680 554 register_comment_type(
681 - 'repost',
555 + 'announce',
682 556 array(
683 - 'label' => __( 'Reposts', 'activitypub' ),
684 - 'singular' => __( 'Repost', 'activitypub' ),
685 - 'description' => 'A repost (or Announce) is when a post appears in the timeline because someone else shared it, while still showing the original author as the source.',
686 - 'icon' => '♻️',
687 - 'class' => 'p-repost',
688 - 'type' => 'repost',
689 - 'collection' => 'reposts',
690 - 'activity_types' => array( 'announce' ),
691 - 'excerpt' => html_entity_decode( \__( '&hellip; reposted this!', 'activitypub' ) ),
692 - /* translators: %d: Number of reposts */
693 - 'count_single' => _x( '%d repost', 'number of reposts', 'activitypub' ),
694 - /* translators: %d: Number of reposts */
695 - 'count_plural' => _x( '%d reposts', 'number of reposts', 'activitypub' ),
557 + 'label' => __( 'Reposts', 'activitypub' ),
558 + 'singular' => __( 'Repost', 'activitypub' ),
559 + 'description' => __( 'A repost on the indieweb is a post that is purely a 100% re-publication of another (typically someone else\'s) post.', 'activitypub' ),
560 + 'icon' => '♻️',
561 + 'class' => 'p-repost',
562 + 'type' => 'repost',
563 + // translators: %1$s username, %2$s opject format (post, audio, ...), %3$s URL, %4$s domain
564 + 'excerpt' => __( '&hellip; reposted this!', 'activitypub' ),
696 565 )
697 566 );
698 567
699 568 register_comment_type(
@@ -698,53 +567,29 @@
698 567
699 568 register_comment_type(
700 569 'like',
701 570 array(
702 - 'label' => __( 'Likes', 'activitypub' ),
703 - 'singular' => __( 'Like', 'activitypub' ),
704 - 'description' => 'A like is a small positive reaction that shows appreciation for a post without sharing it further.',
705 - 'icon' => '👍',
706 - 'class' => 'p-like',
707 - 'type' => 'like',
708 - 'collection' => 'likes',
709 - 'activity_types' => array( 'like' ),
710 - 'excerpt' => html_entity_decode( \__( '&hellip; liked this!', 'activitypub' ) ),
711 - /* translators: %d: Number of likes */
712 - 'count_single' => _x( '%d like', 'number of likes', 'activitypub' ),
713 - /* translators: %d: Number of likes */
714 - 'count_plural' => _x( '%d likes', 'number of likes', 'activitypub' ),
571 + 'label' => __( 'Likes', 'activitypub' ),
572 + 'singular' => __( 'Like', 'activitypub' ),
573 + 'description' => __( 'A like is a popular webaction button and in some cases post type on various silos such as Facebook and Instagram.', 'activitypub' ),
574 + 'icon' => '👍',
575 + 'class' => 'p-like',
576 + 'type' => 'like',
577 + // translators: %1$s username, %2$s opject format (post, audio, ...), %3$s URL, %4$s domain
578 + 'excerpt' => __( '&hellip; liked this!', 'activitypub' ),
715 579 )
716 580 );
717 -
718 - register_comment_type(
719 - 'quote',
720 - array(
721 - 'label' => __( 'Quotes', 'activitypub' ),
722 - 'singular' => __( 'Quote', 'activitypub' ),
723 - 'description' => 'A quote is when a post is shared along with an added comment, so the original post appears together with the sharer&#8217;s own words.',
724 - 'icon' => '❞',
725 - 'class' => 'p-quote',
726 - 'type' => 'quote',
727 - 'collection' => 'quotes',
728 - 'activity_types' => array( 'quote' ),
729 - 'excerpt' => html_entity_decode( \__( '&hellip; quoted this!', 'activitypub' ) ),
730 - /* translators: %d: Number of quotes */
731 - 'count_single' => _x( '%d quote', 'number of quotes', 'activitypub' ),
732 - /* translators: %d: Number of quotes */
733 - 'count_plural' => _x( '%d quotes', 'number of quotes', 'activitypub' ),
734 - )
735 - );
736 581 }
737 582
738 583 /**
739 - * Show avatars on Activities if set.
584 + * Show avatars on Activities if set
740 585 *
741 - * @param array $types List of avatar enabled comment types.
586 + * @param array $types list of avatar enabled comment types
742 587 *
743 588 * @return array show avatars on Activities
744 589 */
745 590 public static function get_avatar_comment_types( $types ) {
746 - $comment_types = self::get_comment_type_slugs();
591 + $comment_types = self::get_comment_type_names();
747 592 $types = array_merge( $types, $comment_types );
748 593
749 594 return array_unique( $types );
750 595 }
@@ -755,284 +600,27 @@
755 600 * @author Jan Boddez
756 601 *
757 602 * @see https://github.com/janboddez/indieblocks/blob/a2d59de358031056a649ee47a1332ce9e39d4ce2/includes/functions.php#L423-L432
758 603 *
759 - * @param \WP_Comment_Query $query Comment count.
604 + * @param WP_Comment_Query $query Comment count.
760 605 */
761 606 public static function comment_query( $query ) {
762 - if ( ! $query instanceof \WP_Comment_Query ) {
607 + if ( ! $query instanceof WP_Comment_Query ) {
763 608 return;
764 609 }
765 610
766 - // Do not exclude likes and reposts on ActivityPub requests.
767 - if ( defined( 'ACTIVITYPUB_REQUEST' ) && ACTIVITYPUB_REQUEST ) {
611 + if ( is_admin() || ! is_singular() ) {
768 612 return;
769 613 }
770 614
771 - // Do not exclude likes and reposts on REST requests (handled by rest_comment_query).
772 - if ( \wp_is_serving_rest_request() ) {
615 + if ( ! empty( $query->query_vars['type__in'] ) ) {
773 616 return;
774 617 }
775 618
776 - // Filter post types for admin requests.
777 - if ( \is_admin() ) {
778 - $query->query_vars['post_type'] = self::get_allowed_comment_post_types();
619 + if ( isset( $query->query_vars['count'] ) && true === $query->query_vars['count'] ) {
779 620 return;
780 621 }
781 622
782 - // Do not exclude likes and reposts on non-singular pages.
783 - if ( ! \is_singular() ) {
784 - return;
785 - }
786 -
787 - // Do not exclude likes and reposts if the query is for specific types.
788 - if ( ! empty( $query->query_vars['type__in'] ) || ! empty( $query->query_vars['type'] ) ) {
789 - return;
790 - }
791 -
792 - // Do not exclude likes and reposts if the query is already excluding other comment types.
793 - if ( ! empty( $query->query_vars['type__not_in'] ) ) {
794 - return;
795 - }
796 -
797 - // Exclude likes and reposts by the ActivityPub plugin.
798 - $query->query_vars['type__not_in'] = self::get_comment_type_slugs();
799 - }
800 -
801 - /**
802 - * Filters comments in REST API requests.
803 - *
804 - * Excludes comments on ActivityPub post types and ActivityPub comment
805 - * types (likes, reposts) from the REST API.
806 - *
807 - * @param array $prepared_args Array of arguments for WP_Comment_Query.
808 - *
809 - * @return array Modified array of arguments.
810 - */
811 - public static function rest_comment_query( $prepared_args ) {
812 - // Exclude comments on ActivityPub post types.
813 - $prepared_args['post_type'] = self::get_allowed_comment_post_types();
814 -
815 - // Exclude ActivityPub comment types (likes, reposts) unless explicitly requested.
816 - if ( empty( $prepared_args['type'] ) && empty( $prepared_args['type__in'] ) ) {
817 - $prepared_args['type__not_in'] = self::get_comment_type_slugs();
818 - }
819 -
820 - return $prepared_args;
821 - }
822 -
823 - /**
824 - * Returns post types that should show comments (excluding hidden post types).
825 - *
826 - * @return array Array of post type names.
827 - */
828 - private static function get_allowed_comment_post_types() {
829 - $hide_for = self::hide_for();
830 -
831 - if ( empty( $hide_for ) ) {
832 - return \get_post_types_by_support( 'comments' );
833 - }
834 -
835 - return \array_diff( \get_post_types_by_support( 'comments' ), $hide_for );
836 - }
837 -
838 - /**
839 - * Filter the comment status before it is set.
840 - *
841 - * @param int|string|\WP_Error $approved The approved comment status.
842 - * @param array $comment_data The comment data.
843 - *
844 - * @return int|string|\WP_Error The approval status. 1, 0, 'spam', 'trash', or WP_Error.
845 - */
846 - public static function pre_comment_approved( $approved, $comment_data ) {
847 - /*
848 - * Only return early for already-approved comments, trash, or errors.
849 - * Don't short-circuit on 'spam' - we may want to override Akismet.
850 - * Respect 'trash' since it comes from the WordPress disallowed list.
851 - */
852 - if ( 1 === $approved || '1' === $approved || 'trash' === $approved || \is_wp_error( $approved ) ) {
853 - return $approved;
854 - }
855 -
856 - // Maybe auto-approve likes and reposts.
857 - if (
858 - \in_array( $comment_data['comment_type'], self::get_comment_type_slugs(), true ) &&
859 - '1' === \get_option( 'activitypub_auto_approve_reactions' )
860 - ) {
861 - return 1;
862 - }
863 -
864 - /*
865 - * Always auto-approve comments on remote posts (ap_post) since
866 - * they are not visible in the WP admin comment moderation screen.
867 - */
868 - $post_id = $comment_data['comment_post_ID'];
869 - $post = \get_post( $post_id );
870 -
871 - if ( $post && \in_array( $post->post_type, self::hide_for(), true ) ) {
872 - return 1;
873 - }
874 -
875 - if ( '1' !== \get_option( 'comment_previously_approved' ) ) {
876 - return $approved;
877 - }
878 -
879 - if (
880 - empty( $comment_data['comment_meta']['protocol'] ) ||
881 - 'activitypub' !== $comment_data['comment_meta']['protocol']
882 - ) {
883 - return $approved;
884 - }
885 -
886 - global $wpdb;
887 -
888 - $author = $comment_data['comment_author'];
889 - $author_url = $comment_data['comment_author_url'];
890 - // phpcs:ignore
891 - $ok_to_comment = $wpdb->get_var( $wpdb->prepare( "SELECT comment_approved FROM $wpdb->comments WHERE comment_author = %s AND comment_author_url = %s and comment_approved = '1' LIMIT 1", $author, $author_url ) );
892 -
893 - if ( 1 === (int) $ok_to_comment ) {
894 - return 1;
895 - }
896 -
897 - return $approved;
898 - }
899 -
900 - /**
901 - * Update comment counts when interaction settings are disabled.
902 - *
903 - * Triggers a recount when likes or reposts are disabled to ensure accurate comment counts.
904 - *
905 - * @param mixed $old_value The old option value.
906 - * @param mixed $value The new option value.
907 - */
908 - public static function maybe_update_comment_counts( $old_value, $value ) {
909 - if ( '1' === $old_value && '1' !== $value ) {
910 - Migration::update_comment_counts();
911 - }
912 - }
913 -
914 - /**
915 - * Filters the comment count to exclude ActivityPub comment types.
916 - *
917 - * @param int|null $new_count The new comment count. Default null.
918 - * @param int $old_count The old comment count.
919 - * @param int $post_id Post ID.
920 - *
921 - * @return int|null The updated comment count, or null to use the default query.
922 - */
923 - public static function pre_wp_update_comment_count_now( $new_count, $old_count, $post_id ) {
924 - if ( null === $new_count ) {
925 - $excluded_types = array_filter( self::get_comment_type_slugs(), array( self::class, 'is_comment_type_enabled' ) );
926 -
927 - if ( ! empty( $excluded_types ) ) {
928 - /*
929 - * Include 'note' type when Gutenberg's filter is registered, so a
930 - * single query excludes both ActivityPub and Gutenberg types.
931 - */
932 - if ( \has_filter( 'pre_wp_update_comment_count_now', 'gutenberg_exclude_notes_from_comment_count' ) ) {
933 - $excluded_types[] = 'note';
934 - }
935 -
936 - /**
937 - * Filters the comment types excluded from the comment count.
938 - *
939 - * Runs at priority 5 on `pre_wp_update_comment_count_now` so that
940 - * a single query can exclude types from multiple plugins. Other
941 - * plugins can hook here to add their own comment types.
942 - *
943 - * @since 8.0.0
944 - *
945 - * @param string[] $excluded_types The comment type slugs to exclude.
946 - * @param int $post_id The post ID.
947 - */
948 - $excluded_types = \apply_filters( 'activitypub_excluded_comment_types', $excluded_types, $post_id );
949 - $excluded_types = array_unique( array_filter( $excluded_types ) );
950 -
951 - global $wpdb;
952 -
953 - // phpcs:ignore WordPress.DB
954 - $new_count = (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved = '1' AND comment_type NOT IN ('" . implode( "','", $excluded_types ) . "')", $post_id ) );
955 - }
956 - }
957 -
958 - return $new_count;
959 - }
960 -
961 - /**
962 - * Check if a comment type is enabled.
963 - *
964 - * @param string $comment_type The comment type.
965 - * @return bool True if the comment type is enabled.
966 - */
967 - public static function is_comment_type_enabled( $comment_type ) {
968 - return '1' === get_option( "activitypub_allow_{$comment_type}s", '1' );
969 - }
970 -
971 - /**
972 - * Get post types to hide comments for in admin.
973 - *
974 - * These are non-public post types whose comments should not appear
975 - * in the main comments list in the WordPress admin.
976 - *
977 - * @return string[] Array of post type names to hide comments for.
978 - */
979 - public static function hide_for() {
980 - $post_types = array( Remote_Posts::POST_TYPE );
981 -
982 - /**
983 - * Filters the list of post types to hide comments for.
984 - *
985 - * @param string[] $post_types Array of post type names to hide comments for.
986 - */
987 - return \apply_filters( 'activitypub_hide_comments_for', $post_types );
988 - }
989 -
990 - /**
991 - * Render emoji in comment author name.
992 - *
993 - * Replaces emoji shortcodes with img tags on the get_comment_author filter.
994 - * Emoji data is retrieved from the linked remote actor.
995 - *
996 - * @param string $author The comment author name.
997 - * @param string $comment_id The comment ID as a numeric string.
998 - *
999 - * @return string The comment author name with rendered emoji.
1000 - */
1001 - public static function render_emoji( $author, $comment_id ) {
1002 - $remote_actor_id = \get_comment_meta( $comment_id, '_activitypub_remote_actor_id', true );
1003 -
1004 - if ( empty( $remote_actor_id ) ) {
1005 - return $author;
1006 - }
1007 -
1008 - $emoji_data = \get_post_meta( $remote_actor_id, '_activitypub_emoji', true );
1009 -
1010 - if ( empty( $emoji_data ) ) {
1011 - return $author;
1012 - }
1013 -
1014 - return Emoji::replace_from_json( $author, $emoji_data );
1015 - }
1016 -
1017 - /**
1018 - * Selectively unescape emoji images in comment author.
1019 - *
1020 - * This runs at priority 20 after WordPress's esc_html() filter on comment_author.
1021 - *
1022 - * @param string $author The comment author name (already escaped by WordPress).
1023 - *
1024 - * @return string The comment author name with emoji images unescaped.
1025 - */
1026 - public static function unescape_emoji( $author ) {
1027 - // Only attempt to unescape if there are emoji images present in the escaped string.
1028 - if ( false === \strpos( $author, 'class=&quot;emoji&quot;' ) ) {
1029 - return $author;
1030 - }
1031 -
1032 - // Decode entities so we can selectively restore emoji <img> tags.
1033 - $decoded = \html_entity_decode( $author, ENT_QUOTES | ENT_HTML5, 'UTF-8' );
1034 -
1035 - // Use strict KSES validation to only allow valid emoji img tags.
1036 - return \wp_kses( $decoded, Emoji::get_kses_allowed_html() );
623 + // Exclude likes and reposts by the Webmention plugin.
624 + $query->query_vars['type__not_in'] = self::get_comment_type_names();
1037 625 }
1038 626 }