| @@ -1,14 +1,16 @@ | ||
| 1 | 1 | <?php |
| 2 | 2 | namespace Activitypub; |
| 3 | 3 | |
| 4 | +use WP_Query; | |
| 4 | 5 | use WP_Error; |
| 5 | -use WP_Comment_Query; | |
| 6 | 6 | use Activitypub\Http; |
| 7 | +use Activitypub\Comment; | |
| 7 | 8 | use Activitypub\Webfinger; |
| 8 | 9 | use Activitypub\Activity\Activity; |
| 9 | 10 | use Activitypub\Collection\Followers; |
| 10 | 11 | use Activitypub\Collection\Users; |
| 12 | +use Activitypub\Collection\Extra_Fields; | |
| 11 | 13 | |
| 12 | 14 | /** |
| 13 | 15 | * Returns the ActivityPub default JSON-context |
| 14 | 16 | * |
| @@ -14,9 +16,9 @@ | ||
| 14 | 16 | * |
| 15 | 17 | * @return array the activitypub context |
| 16 | 18 | */ |
| 17 | 19 | function get_context() { |
| 18 | - $context = Activity::CONTEXT; | |
| 20 | + $context = Activity::JSON_LD_CONTEXT; | |
| 19 | 21 | |
| 20 | 22 | return \apply_filters( 'activitypub_json_context', $context ); |
| 21 | 23 | } |
| 22 | 24 | |
| @@ -51,14 +53,33 @@ | ||
| 51 | 53 | $pre = apply_filters( 'pre_get_remote_metadata_by_actor', false, $actor ); |
| 52 | 54 | if ( $pre ) { |
| 53 | 55 | return $pre; |
| 54 | 56 | } |
| 57 | + | |
| 58 | + if ( is_array( $actor ) ) { | |
| 59 | + if ( array_key_exists( 'id', $actor ) ) { | |
| 60 | + $actor = $actor['id']; | |
| 61 | + } elseif ( array_key_exists( 'url', $actor ) ) { | |
| 62 | + $actor = $actor['url']; | |
| 63 | + } else { | |
| 64 | + return new WP_Error( | |
| 65 | + 'activitypub_no_valid_actor_identifier', | |
| 66 | + \__( 'The "actor" identifier is not valid', 'activitypub' ), | |
| 67 | + array( 'status' => 404, 'actor' => $actor ) | |
| 68 | + ); | |
| 69 | + } | |
| 70 | + } | |
| 71 | + | |
| 55 | 72 | if ( preg_match( '/^@?' . ACTIVITYPUB_USERNAME_REGEXP . '$/i', $actor ) ) { |
| 56 | 73 | $actor = Webfinger::resolve( $actor ); |
| 57 | 74 | } |
| 58 | 75 | |
| 59 | 76 | if ( ! $actor ) { |
| 60 | - return new WP_Error( 'activitypub_no_valid_actor_identifier', \__( 'The "actor" identifier is not valid', 'activitypub' ), array( 'status' => 404, 'actor' => $actor ) ); | |
| 77 | + return new WP_Error( | |
| 78 | + 'activitypub_no_valid_actor_identifier', | |
| 79 | + \__( 'The "actor" identifier is not valid', 'activitypub' ), | |
| 80 | + array( 'status' => 404, 'actor' => $actor ) | |
| 81 | + ); | |
| 61 | 82 | } |
| 62 | 83 | |
| 63 | 84 | if ( is_wp_error( $actor ) ) { |
| 64 | 85 | return $actor; |
| @@ -75,9 +96,13 @@ | ||
| 75 | 96 | } |
| 76 | 97 | } |
| 77 | 98 | |
| 78 | 99 | if ( ! \wp_http_validate_url( $actor ) ) { |
| 79 | - $metadata = new WP_Error( 'activitypub_no_valid_actor_url', \__( 'The "actor" is no valid URL', 'activitypub' ), array( 'status' => 400, 'actor' => $actor ) ); | |
| 100 | + $metadata = new WP_Error( | |
| 101 | + 'activitypub_no_valid_actor_url', | |
| 102 | + \__( 'The "actor" is no valid URL', 'activitypub' ), | |
| 103 | + array( 'status' => 400, 'actor' => $actor ) | |
| 104 | + ); | |
| 80 | 105 | return $metadata; |
| 81 | 106 | } |
| 82 | 107 | |
| 83 | 108 | $response = Http::get( $actor ); |
| @@ -89,9 +114,13 @@ | ||
| 89 | 114 | $metadata = \wp_remote_retrieve_body( $response ); |
| 90 | 115 | $metadata = \json_decode( $metadata, true ); |
| 91 | 116 | |
| 92 | 117 | if ( ! $metadata ) { |
| 93 | - $metadata = new WP_Error( 'activitypub_invalid_json', \__( 'No valid JSON data', 'activitypub' ), array( 'status' => 400, 'actor' => $actor ) ); | |
| 118 | + $metadata = new WP_Error( | |
| 119 | + 'activitypub_invalid_json', | |
| 120 | + \__( 'No valid JSON data', 'activitypub' ), | |
| 121 | + array( 'status' => 400, 'actor' => $actor ) | |
| 122 | + ); | |
| 94 | 123 | return $metadata; |
| 95 | 124 | } |
| 96 | 125 | |
| 97 | 126 | \set_transient( $transient_key, $metadata, WEEK_IN_SECONDS ); |
| @@ -133,9 +162,9 @@ | ||
| 133 | 162 | function url_to_authorid( $url ) { |
| 134 | 163 | global $wp_rewrite; |
| 135 | 164 | |
| 136 | 165 | // check if url hase the same host |
| 137 | - if ( \wp_parse_url( \site_url(), \PHP_URL_HOST ) !== \wp_parse_url( $url, \PHP_URL_HOST ) ) { | |
| 166 | + if ( \wp_parse_url( \home_url(), \PHP_URL_HOST ) !== \wp_parse_url( $url, \PHP_URL_HOST ) ) { | |
| 138 | 167 | return 0; |
| 139 | 168 | } |
| 140 | 169 | |
| 141 | 170 | // first, check to see if there is a 'author=N' to match against |
| @@ -180,10 +209,9 @@ | ||
| 180 | 209 | |
| 181 | 210 | if ( ! is_null( $comment_id ) ) { |
| 182 | 211 | $comment = \get_comment( $comment_id ); |
| 183 | 212 | |
| 184 | - // Only return local origin comments | |
| 185 | - if ( $comment && $comment->user_id ) { | |
| 213 | + if ( $comment ) { | |
| 186 | 214 | return $comment_id; |
| 187 | 215 | } |
| 188 | 216 | } |
| 189 | 217 | |
| @@ -311,8 +339,14 @@ | ||
| 311 | 339 | return false; |
| 312 | 340 | } |
| 313 | 341 | } |
| 314 | 342 | |
| 343 | + // Check if header already sent. | |
| 344 | + if ( ! \headers_sent() && ACTIVITYPUB_SEND_VARY_HEADER ) { | |
| 345 | + // Send Vary header for Accept header. | |
| 346 | + \header( 'Vary: Accept' ); | |
| 347 | + } | |
| 348 | + | |
| 315 | 349 | // One can trigger an ActivityPub request by adding ?activitypub to the URL. |
| 316 | 350 | // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.VariableRedeclaration |
| 317 | 351 | global $wp_query; |
| 318 | 352 | if ( isset( $wp_query->query_vars['activitypub'] ) ) { |
| @@ -377,9 +411,9 @@ | ||
| 377 | 411 | $return = true; |
| 378 | 412 | break; |
| 379 | 413 | } |
| 380 | 414 | |
| 381 | - if ( ! \user_can( $user_id, 'publish_posts' ) ) { | |
| 415 | + if ( ! \user_can( $user_id, 'activitypub' ) ) { | |
| 382 | 416 | $return = true; |
| 383 | 417 | break; |
| 384 | 418 | } |
| 385 | 419 | |
| @@ -442,9 +476,13 @@ | ||
| 442 | 476 | |
| 443 | 477 | $return = false; |
| 444 | 478 | break; |
| 445 | 479 | default: |
| 446 | - $return = new WP_Error( 'activitypub_wrong_user_type', __( 'Wrong user type', 'activitypub' ), array( 'status' => 400 ) ); | |
| 480 | + $return = new WP_Error( | |
| 481 | + 'activitypub_wrong_user_type', | |
| 482 | + __( 'Wrong user type', 'activitypub' ), | |
| 483 | + array( 'status' => 400 ) | |
| 484 | + ); | |
| 447 | 485 | break; |
| 448 | 486 | } |
| 449 | 487 | |
| 450 | 488 | return apply_filters( 'activitypub_is_user_type_disabled', $return, $type ); |
| @@ -617,13 +655,13 @@ | ||
| 617 | 655 | } |
| 618 | 656 | |
| 619 | 657 | // if blog user is disabled |
| 620 | 658 | if ( is_user_disabled( Users::BLOG_USER_ID ) ) { |
| 621 | - return $count; | |
| 659 | + return (int) $count; | |
| 622 | 660 | } |
| 623 | 661 | |
| 624 | 662 | // also count blog user |
| 625 | - return $count + 1; | |
| 663 | + return (int) $count + 1; | |
| 626 | 664 | } |
| 627 | 665 | |
| 628 | 666 | /** |
| 629 | 667 | * Get the total number of users |
| @@ -637,9 +675,9 @@ | ||
| 637 | 675 | } |
| 638 | 676 | |
| 639 | 677 | $users = \get_users( |
| 640 | 678 | array( |
| 641 | - 'capability__in' => array( 'publish_posts' ), | |
| 679 | + 'capability__in' => array( 'activitypub' ), | |
| 642 | 680 | ) |
| 643 | 681 | ); |
| 644 | 682 | |
| 645 | 683 | if ( is_array( $users ) ) { |
| @@ -649,12 +687,12 @@ | ||
| 649 | 687 | } |
| 650 | 688 | |
| 651 | 689 | // if blog user is disabled |
| 652 | 690 | if ( is_user_disabled( Users::BLOG_USER_ID ) ) { |
| 653 | - return $users; | |
| 691 | + return (int) $users; | |
| 654 | 692 | } |
| 655 | 693 | |
| 656 | - return $users + 1; | |
| 694 | + return (int) $users + 1; | |
| 657 | 695 | } |
| 658 | 696 | |
| 659 | 697 | /** |
| 660 | 698 | * Examine a comment ID and look up an existing comment it represents. |
| @@ -663,24 +701,9 @@ | ||
| 663 | 701 | * |
| 664 | 702 | * @return int|boolean Comment ID, or false on failure. |
| 665 | 703 | */ |
| 666 | 704 | function object_id_to_comment( $id ) { |
| 667 | - $comment_query = new WP_Comment_Query( | |
| 668 | - array( | |
| 669 | - 'meta_key' => 'source_id', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key | |
| 670 | - 'meta_value' => $id, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value | |
| 671 | - ) | |
| 672 | - ); | |
| 673 | - | |
| 674 | - if ( ! $comment_query->comments ) { | |
| 675 | - return false; | |
| 676 | - } | |
| 677 | - | |
| 678 | - if ( count( $comment_query->comments ) > 1 ) { | |
| 679 | - return false; | |
| 680 | - } | |
| 681 | - | |
| 682 | - return $comment_query->comments[0]; | |
| 705 | + return Comment::object_id_to_comment( $id ); | |
| 683 | 706 | } |
| 684 | 707 | |
| 685 | 708 | /** |
| 686 | 709 | * Verify if URL is a local comment, |
| @@ -691,52 +714,9 @@ | ||
| 691 | 714 | * |
| 692 | 715 | * @return int comment_ID or null if not found |
| 693 | 716 | */ |
| 694 | 717 | function url_to_commentid( $url ) { |
| 695 | - if ( ! $url || ! filter_var( $url, FILTER_VALIDATE_URL ) ) { | |
| 696 | - return null; | |
| 697 | - } | |
| 698 | - | |
| 699 | - // check for local comment | |
| 700 | - if ( \wp_parse_url( \site_url(), \PHP_URL_HOST ) === \wp_parse_url( $url, \PHP_URL_HOST ) ) { | |
| 701 | - $query = \wp_parse_url( $url, PHP_URL_QUERY ); | |
| 702 | - | |
| 703 | - if ( $query ) { | |
| 704 | - parse_str( $query, $params ); | |
| 705 | - | |
| 706 | - if ( ! empty( $params['c'] ) ) { | |
| 707 | - $comment = \get_comment( $params['c'] ); | |
| 708 | - | |
| 709 | - if ( $comment ) { | |
| 710 | - return $comment->comment_ID; | |
| 711 | - } | |
| 712 | - } | |
| 713 | - } | |
| 714 | - } | |
| 715 | - | |
| 716 | - $args = array( | |
| 717 | - // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query | |
| 718 | - 'meta_query' => array( | |
| 719 | - 'relation' => 'OR', | |
| 720 | - array( | |
| 721 | - 'key' => 'source_url', | |
| 722 | - 'value' => $url, | |
| 723 | - ), | |
| 724 | - array( | |
| 725 | - 'key' => 'source_id', | |
| 726 | - 'value' => $url, | |
| 727 | - ), | |
| 728 | - ), | |
| 729 | - ); | |
| 730 | - | |
| 731 | - $query = new \WP_Comment_Query(); | |
| 732 | - $comments = $query->query( $args ); | |
| 733 | - | |
| 734 | - if ( $comments && is_array( $comments ) ) { | |
| 735 | - return $comments[0]->comment_ID; | |
| 736 | - } | |
| 737 | - | |
| 738 | - return null; | |
| 718 | + return Comment::url_to_commentid( $url ); | |
| 739 | 719 | } |
| 740 | 720 | |
| 741 | 721 | /** |
| 742 | 722 | * Get the URI of an ActivityPub object |
| @@ -744,9 +724,9 @@ | ||
| 744 | 724 | * @param array $object The ActivityPub object |
| 745 | 725 | * |
| 746 | 726 | * @return string The URI of the ActivityPub object |
| 747 | 727 | */ |
| 748 | -function object_to_uri( $object ) { | |
| 728 | +function object_to_uri( $object ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.objectFound | |
| 749 | 729 | // check if it is already simple |
| 750 | 730 | if ( ! $object || is_string( $object ) ) { |
| 751 | 731 | return $object; |
| 752 | 732 | } |
| @@ -761,10 +741,15 @@ | ||
| 761 | 741 | if ( is_string( $object ) ) { |
| 762 | 742 | return $object; |
| 763 | 743 | } |
| 764 | 744 | |
| 745 | + $type = 'Object'; | |
| 746 | + if ( isset( $object['type'] ) ) { | |
| 747 | + $type = $object['type']; | |
| 748 | + } | |
| 749 | + | |
| 765 | 750 | // return part of Object that makes most sense |
| 766 | - switch ( $object['type'] ) { | |
| 751 | + switch ( $type ) { | |
| 767 | 752 | case 'Link': |
| 768 | 753 | $object = $object['href']; |
| 769 | 754 | break; |
| 770 | 755 | default: |
| @@ -772,5 +757,461 @@ | ||
| 772 | 757 | break; |
| 773 | 758 | } |
| 774 | 759 | |
| 775 | 760 | return $object; |
| 761 | +} | |
| 762 | + | |
| 763 | +/** | |
| 764 | + * Check if a comment should be federated. | |
| 765 | + * | |
| 766 | + * We consider a comment should be federated if it is authored by a user that is | |
| 767 | + * not disabled for federation and if it is a reply directly to the post or to a | |
| 768 | + * federated comment. | |
| 769 | + * | |
| 770 | + * @param mixed $comment Comment object or ID. | |
| 771 | + * | |
| 772 | + * @return boolean True if the comment should be federated, false otherwise. | |
| 773 | + */ | |
| 774 | +function should_comment_be_federated( $comment ) { | |
| 775 | + return Comment::should_be_federated( $comment ); | |
| 776 | +} | |
| 777 | + | |
| 778 | +/** | |
| 779 | + * Check if a comment was federated. | |
| 780 | + * | |
| 781 | + * This function checks if a comment was federated via ActivityPub. | |
| 782 | + * | |
| 783 | + * @param mixed $comment Comment object or ID. | |
| 784 | + * | |
| 785 | + * @return boolean True if the comment was federated, false otherwise. | |
| 786 | + */ | |
| 787 | +function was_comment_sent( $comment ) { | |
| 788 | + return Comment::was_sent( $comment ); | |
| 789 | +} | |
| 790 | + | |
| 791 | +/** | |
| 792 | + * Check if a comment is federated. | |
| 793 | + * | |
| 794 | + * We consider a comment federated if comment was received via ActivityPub. | |
| 795 | + * | |
| 796 | + * Use this function to check if it is comment that was received via ActivityPub. | |
| 797 | + * | |
| 798 | + * @param mixed $comment Comment object or ID. | |
| 799 | + * | |
| 800 | + * @return boolean True if the comment is federated, false otherwise. | |
| 801 | + */ | |
| 802 | +function was_comment_received( $comment ) { | |
| 803 | + return Comment::was_received( $comment ); | |
| 804 | +} | |
| 805 | + | |
| 806 | +/** | |
| 807 | + * Check if a comment is local only. | |
| 808 | + * | |
| 809 | + * This function checks if a comment is local only and was not sent or received via ActivityPub. | |
| 810 | + * | |
| 811 | + * @param mixed $comment Comment object or ID. | |
| 812 | + * | |
| 813 | + * @return boolean True if the comment is local only, false otherwise. | |
| 814 | + */ | |
| 815 | +function is_local_comment( $comment ) { | |
| 816 | + return Comment::is_local( $comment ); | |
| 817 | +} | |
| 818 | + | |
| 819 | +/** | |
| 820 | + * Mark a WordPress object as federated. | |
| 821 | + * | |
| 822 | + * @param WP_Comment|WP_Post|mixed $wp_object | |
| 823 | + * | |
| 824 | + * @return void | |
| 825 | + */ | |
| 826 | +function set_wp_object_state( $wp_object, $state ) { | |
| 827 | + $meta_key = 'activitypub_status'; | |
| 828 | + | |
| 829 | + if ( $wp_object instanceof \WP_Post ) { | |
| 830 | + \update_post_meta( $wp_object->ID, $meta_key, $state ); | |
| 831 | + } elseif ( $wp_object instanceof \WP_Comment ) { | |
| 832 | + \update_comment_meta( $wp_object->comment_ID, $meta_key, $state ); | |
| 833 | + } else { | |
| 834 | + \apply_filters( 'activitypub_mark_wp_object_as_federated', $wp_object ); | |
| 835 | + } | |
| 836 | +} | |
| 837 | + | |
| 838 | +/** | |
| 839 | + * Get the federation state of a WordPress object. | |
| 840 | + * | |
| 841 | + * @param WP_Comment|WP_Post|mixed $wp_object | |
| 842 | + * | |
| 843 | + * @return string|false The state of the object or false if not found. | |
| 844 | + */ | |
| 845 | +function get_wp_object_state( $wp_object ) { | |
| 846 | + $meta_key = 'activitypub_status'; | |
| 847 | + | |
| 848 | + if ( $wp_object instanceof \WP_Post ) { | |
| 849 | + return \get_post_meta( $wp_object->ID, $meta_key, true ); | |
| 850 | + } elseif ( $wp_object instanceof \WP_Comment ) { | |
| 851 | + return \get_comment_meta( $wp_object->comment_ID, $meta_key, true ); | |
| 852 | + } else { | |
| 853 | + return \apply_filters( 'activitypub_get_wp_object_state', false, $wp_object ); | |
| 854 | + } | |
| 855 | +} | |
| 856 | + | |
| 857 | +/** | |
| 858 | + * Get the description of a post type. | |
| 859 | + * | |
| 860 | + * Set some default descriptions for the default post types. | |
| 861 | + * | |
| 862 | + * @param WP_Post_Type $post_type The post type object. | |
| 863 | + * | |
| 864 | + * @return string The description of the post type. | |
| 865 | + */ | |
| 866 | +function get_post_type_description( $post_type ) { | |
| 867 | + $description = ''; | |
| 868 | + | |
| 869 | + switch ( $post_type->name ) { | |
| 870 | + case 'post': | |
| 871 | + $description = ''; | |
| 872 | + break; | |
| 873 | + case 'page': | |
| 874 | + $description = ''; | |
| 875 | + break; | |
| 876 | + case 'attachment': | |
| 877 | + $description = ' - ' . __( 'The attachments that you have uploaded to a post (images, videos, documents or other files).', 'activitypub' ); | |
| 878 | + break; | |
| 879 | + default: | |
| 880 | + if ( ! empty( $post_type->description ) ) { | |
| 881 | + $description = ' - ' . $post_type->description; | |
| 882 | + } | |
| 883 | + } | |
| 884 | + | |
| 885 | + return apply_filters( 'activitypub_post_type_description', $description, $post_type->name, $post_type ); | |
| 886 | +} | |
| 887 | + | |
| 888 | +/** | |
| 889 | + * Get the masked WordPress version to only show the major and minor version. | |
| 890 | + * | |
| 891 | + * @return string The masked version. | |
| 892 | + */ | |
| 893 | +function get_masked_wp_version() { | |
| 894 | + // only show the major and minor version | |
| 895 | + $version = get_bloginfo( 'version' ); | |
| 896 | + // strip the RC or beta part | |
| 897 | + $version = preg_replace( '/-.*$/', '', $version ); | |
| 898 | + $version = explode( '.', $version ); | |
| 899 | + $version = array_slice( $version, 0, 2 ); | |
| 900 | + | |
| 901 | + return implode( '.', $version ); | |
| 902 | +} | |
| 903 | + | |
| 904 | +/** | |
| 905 | + * Get the enclosures of a post. | |
| 906 | + * | |
| 907 | + * @param int $post_id The post ID. | |
| 908 | + * | |
| 909 | + * @return array The enclosures. | |
| 910 | + */ | |
| 911 | +function get_enclosures( $post_id ) { | |
| 912 | + $enclosures = get_post_meta( $post_id, 'enclosure' ); | |
| 913 | + | |
| 914 | + if ( ! $enclosures ) { | |
| 915 | + return array(); | |
| 916 | + } | |
| 917 | + | |
| 918 | + $enclosures = array_map( | |
| 919 | + function ( $enclosure ) { | |
| 920 | + $attributes = explode( "\n", $enclosure ); | |
| 921 | + | |
| 922 | + if ( ! isset( $attributes[0] ) || ! \wp_http_validate_url( $attributes[0] ) ) { | |
| 923 | + return false; | |
| 924 | + } | |
| 925 | + | |
| 926 | + return array( | |
| 927 | + 'url' => $attributes[0], | |
| 928 | + 'length' => isset( $attributes[1] ) ? trim( $attributes[1] ) : null, | |
| 929 | + 'mediaType' => isset( $attributes[2] ) ? trim( $attributes[2] ) : null, | |
| 930 | + ); | |
| 931 | + }, | |
| 932 | + $enclosures | |
| 933 | + ); | |
| 934 | + | |
| 935 | + return array_filter( $enclosures ); | |
| 936 | +} | |
| 937 | + | |
| 938 | +/** | |
| 939 | + * Retrieves the IDs of the ancestors of a comment. | |
| 940 | + * | |
| 941 | + * Adaption of `get_post_ancestors` from WordPress core. | |
| 942 | + * | |
| 943 | + * @see https://developer.wordpress.org/reference/functions/get_post_ancestors/ | |
| 944 | + * | |
| 945 | + * @param int|WP_Comment $comment Comment ID or comment object. | |
| 946 | + * | |
| 947 | + * @return WP_Comment[] Array of ancestor comments or empty array if there are none. | |
| 948 | + */ | |
| 949 | +function get_comment_ancestors( $comment ) { | |
| 950 | + $comment = \get_comment( $comment ); | |
| 951 | + | |
| 952 | + // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual | |
| 953 | + if ( ! $comment || empty( $comment->comment_parent ) || $comment->comment_parent == $comment->comment_ID ) { | |
| 954 | + return array(); | |
| 955 | + } | |
| 956 | + | |
| 957 | + $ancestors = array(); | |
| 958 | + | |
| 959 | + $id = (int) $comment->comment_parent; | |
| 960 | + $ancestors[] = $id; | |
| 961 | + | |
| 962 | + // phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition | |
| 963 | + while ( $id > 0 ) { | |
| 964 | + $ancestor = \get_comment( $id ); | |
| 965 | + $parent_id = (int) $ancestor->comment_parent; | |
| 966 | + | |
| 967 | + // Loop detection: If the ancestor has been seen before, break. | |
| 968 | + if ( empty( $parent_id ) || ( $parent_id === (int) $comment->comment_ID ) || in_array( $parent_id, $ancestors, true ) ) { | |
| 969 | + break; | |
| 970 | + } | |
| 971 | + | |
| 972 | + $id = $parent_id; | |
| 973 | + $ancestors[] = $id; | |
| 974 | + } | |
| 975 | + | |
| 976 | + return $ancestors; | |
| 977 | +} | |
| 978 | + | |
| 979 | +/** | |
| 980 | + * Change the display of large numbers on the site. | |
| 981 | + * | |
| 982 | + * @author Jeremy Herve | |
| 983 | + * | |
| 984 | + * @see https://wordpress.org/support/topic/abbreviate-numbers-with-k/ | |
| 985 | + * | |
| 986 | + * @param string $formatted Converted number in string format. | |
| 987 | + * @param float $number The number to convert based on locale. | |
| 988 | + * @param int $decimals Precision of the number of decimal places. | |
| 989 | + * | |
| 990 | + * @return string Converted number in string format. | |
| 991 | + */ | |
| 992 | +function custom_large_numbers( $formatted, $number, $decimals ) { | |
| 993 | + global $wp_locale; | |
| 994 | + | |
| 995 | + $decimals = 0; | |
| 996 | + $decimal_point = '.'; | |
| 997 | + $thousands_sep = ','; | |
| 998 | + | |
| 999 | + if ( isset( $wp_locale ) ) { | |
| 1000 | + $decimals = (int) $wp_locale->number_format['decimal_point']; | |
| 1001 | + $decimal_point = $wp_locale->number_format['decimal_point']; | |
| 1002 | + $thousands_sep = $wp_locale->number_format['thousands_sep']; | |
| 1003 | + } | |
| 1004 | + | |
| 1005 | + if ( $number < 1000 ) { // any number less than a Thousand. | |
| 1006 | + return \number_format( $number, $decimals, $decimal_point, $thousands_sep ); | |
| 1007 | + } elseif ( $number < 1000000 ) { // any number less than a million | |
| 1008 | + return \number_format( $number / 1000, $decimals, $decimal_point, $thousands_sep ) . 'K'; | |
| 1009 | + } elseif ( $number < 1000000000 ) { // any number less than a billion | |
| 1010 | + return \number_format( $number / 1000000, $decimals, $decimal_point, $thousands_sep ) . 'M'; | |
| 1011 | + } else { // at least a billion | |
| 1012 | + return \number_format( $number / 1000000000, $decimals, $decimal_point, $thousands_sep ) . 'B'; | |
| 1013 | + } | |
| 1014 | + | |
| 1015 | + // Default fallback. We should not get here. | |
| 1016 | + return $formatted; | |
| 1017 | +} | |
| 1018 | + | |
| 1019 | +/** | |
| 1020 | + * Registers a ActivityPub comment type. | |
| 1021 | + * | |
| 1022 | + * | |
| 1023 | + * @param string $comment_type Key for comment type. | |
| 1024 | + * @param array $args Arguments. | |
| 1025 | + * | |
| 1026 | + * @return array The registered Activitypub comment type. | |
| 1027 | + */ | |
| 1028 | +function register_comment_type( $comment_type, $args = array() ) { | |
| 1029 | + global $activitypub_comment_types; | |
| 1030 | + | |
| 1031 | + if ( ! is_array( $activitypub_comment_types ) ) { | |
| 1032 | + $activitypub_comment_types = array(); | |
| 1033 | + } | |
| 1034 | + | |
| 1035 | + // Sanitize comment type name. | |
| 1036 | + $comment_type = sanitize_key( $comment_type ); | |
| 1037 | + | |
| 1038 | + $activitypub_comment_types[ $comment_type ] = $args; | |
| 1039 | + | |
| 1040 | + /** | |
| 1041 | + * Fires after a ActivityPub comment type is registered. | |
| 1042 | + * | |
| 1043 | + * | |
| 1044 | + * @param string $comment_type Comment type. | |
| 1045 | + * @param array $args Arguments used to register the comment type. | |
| 1046 | + */ | |
| 1047 | + do_action( 'activitypub_registered_comment_type', $comment_type, $args ); | |
| 1048 | + | |
| 1049 | + return $args; | |
| 1050 | +} | |
| 1051 | + | |
| 1052 | +/** | |
| 1053 | + * Normalize a URL. | |
| 1054 | + * | |
| 1055 | + * @param string $url The URL. | |
| 1056 | + * | |
| 1057 | + * @return string The normalized URL. | |
| 1058 | + */ | |
| 1059 | +function normalize_url( $url ) { | |
| 1060 | + $url = \untrailingslashit( $url ); | |
| 1061 | + $url = \str_replace( 'https://', '', $url ); | |
| 1062 | + $url = \str_replace( 'http://', '', $url ); | |
| 1063 | + $url = \str_replace( 'www.', '', $url ); | |
| 1064 | + | |
| 1065 | + return $url; | |
| 1066 | +} | |
| 1067 | + | |
| 1068 | +/** | |
| 1069 | + * Normalize a host. | |
| 1070 | + * | |
| 1071 | + * @param string $host The host. | |
| 1072 | + * | |
| 1073 | + * @return string The normalized host. | |
| 1074 | + */ | |
| 1075 | +function normalize_host( $host ) { | |
| 1076 | + return \str_replace( 'www.', '', $host ); | |
| 1077 | +} | |
| 1078 | + | |
| 1079 | +/** | |
| 1080 | + * Get the reply intent URI. | |
| 1081 | + * | |
| 1082 | + * @return string The reply intent URI. | |
| 1083 | + */ | |
| 1084 | +function get_reply_intent_uri() { | |
| 1085 | + return sprintf( | |
| 1086 | + 'javascript:(()=>{window.open(\'%s\'+encodeURIComponent(window.location.href));})();', | |
| 1087 | + esc_url( \admin_url( 'post-new.php?in_reply_to=' ) ) | |
| 1088 | + ); | |
| 1089 | +} | |
| 1090 | + | |
| 1091 | +/** | |
| 1092 | + * Replace content with links, mentions or hashtags by Regex callback and not affect protected tags. | |
| 1093 | + * | |
| 1094 | + * @param $content string The content that should be changed | |
| 1095 | + * @param $regex string The regex to use | |
| 1096 | + * @param $regex_callback callable Callback for replacement logic | |
| 1097 | + * | |
| 1098 | + * @return string The content with links, mentions, hashtags, etc. | |
| 1099 | + */ | |
| 1100 | +function enrich_content_data( $content, $regex, $regex_callback ) { | |
| 1101 | + // small protection against execution timeouts: limit to 1 MB | |
| 1102 | + if ( mb_strlen( $content ) > MB_IN_BYTES ) { | |
| 1103 | + return $content; | |
| 1104 | + } | |
| 1105 | + $tag_stack = array(); | |
| 1106 | + $protected_tags = array( | |
| 1107 | + 'pre', | |
| 1108 | + 'code', | |
| 1109 | + 'textarea', | |
| 1110 | + 'style', | |
| 1111 | + 'a', | |
| 1112 | + ); | |
| 1113 | + $content_with_links = ''; | |
| 1114 | + $in_protected_tag = false; | |
| 1115 | + foreach ( wp_html_split( $content ) as $chunk ) { | |
| 1116 | + if ( preg_match( '#^<!--[\s\S]*-->$#i', $chunk, $m ) ) { | |
| 1117 | + $content_with_links .= $chunk; | |
| 1118 | + continue; | |
| 1119 | + } | |
| 1120 | + | |
| 1121 | + if ( preg_match( '#^<(/)?([a-z-]+)\b[^>]*>$#i', $chunk, $m ) ) { | |
| 1122 | + $tag = strtolower( $m[2] ); | |
| 1123 | + if ( '/' === $m[1] ) { | |
| 1124 | + // Closing tag. | |
| 1125 | + $i = array_search( $tag, $tag_stack, true ); | |
| 1126 | + // We can only remove the tag from the stack if it is in the stack. | |
| 1127 | + if ( false !== $i ) { | |
| 1128 | + $tag_stack = array_slice( $tag_stack, 0, $i ); | |
| 1129 | + } | |
| 1130 | + } else { | |
| 1131 | + // Opening tag, add it to the stack. | |
| 1132 | + $tag_stack[] = $tag; | |
| 1133 | + } | |
| 1134 | + | |
| 1135 | + // If we're in a protected tag, the tag_stack contains at least one protected tag string. | |
| 1136 | + // The protected tag state can only change when we encounter a start or end tag. | |
| 1137 | + $in_protected_tag = array_intersect( $tag_stack, $protected_tags ); | |
| 1138 | + | |
| 1139 | + // Never inspect tags. | |
| 1140 | + $content_with_links .= $chunk; | |
| 1141 | + continue; | |
| 1142 | + } | |
| 1143 | + | |
| 1144 | + if ( $in_protected_tag ) { | |
| 1145 | + // Don't inspect a chunk inside an inspected tag. | |
| 1146 | + $content_with_links .= $chunk; | |
| 1147 | + continue; | |
| 1148 | + } | |
| 1149 | + | |
| 1150 | + // Only reachable when there is no protected tag in the stack. | |
| 1151 | + $content_with_links .= \preg_replace_callback( $regex, $regex_callback, $chunk ); | |
| 1152 | + } | |
| 1153 | + | |
| 1154 | + return $content_with_links; | |
| 1155 | +} | |
| 1156 | + | |
| 1157 | +/** | |
| 1158 | + * Generate a summary of a post. | |
| 1159 | + * | |
| 1160 | + * This function generates a summary of a post by extracting: | |
| 1161 | + * | |
| 1162 | + * 1. The post excerpt if it exists. | |
| 1163 | + * 2. The first part of the post content if it contains the <!--more--> tag. | |
| 1164 | + * 3. An excerpt of the post content if it is longer than the specified length. | |
| 1165 | + * | |
| 1166 | + * @param int|WP_Post $post The post ID or post object. | |
| 1167 | + * @param integer $length The maximum length of the summary. | |
| 1168 | + * Default is 500. It will ne ignored if the post excerpt | |
| 1169 | + * and the content above the <!--more--> tag. | |
| 1170 | + * | |
| 1171 | + * @return string The generated post summary. | |
| 1172 | + */ | |
| 1173 | +function generate_post_summary( $post, $length = 500 ) { | |
| 1174 | + $post = get_post( $post ); | |
| 1175 | + | |
| 1176 | + if ( ! $post ) { | |
| 1177 | + return ''; | |
| 1178 | + } | |
| 1179 | + | |
| 1180 | + $content = \sanitize_post_field( 'post_excerpt', $post->post_excerpt, $post->ID ); | |
| 1181 | + | |
| 1182 | + if ( $content ) { | |
| 1183 | + return \apply_filters( 'the_excerpt', $content ); | |
| 1184 | + } | |
| 1185 | + | |
| 1186 | + $content = \sanitize_post_field( 'post_content', $post->post_content, $post->ID ); | |
| 1187 | + $content_parts = \get_extended( $content ); | |
| 1188 | + | |
| 1189 | + $excerpt_more = \apply_filters( 'activitypub_excerpt_more', '[…]' ); | |
| 1190 | + $length = $length - strlen( $excerpt_more ); | |
| 1191 | + | |
| 1192 | + // Check for the <!--more--> tag. | |
| 1193 | + if ( | |
| 1194 | + ! empty( $content_parts['extended'] ) && | |
| 1195 | + ! empty( $content_parts['main'] ) | |
| 1196 | + ) { | |
| 1197 | + $content = $content_parts['main'] . ' ' . $excerpt_more; | |
| 1198 | + $length = null; | |
| 1199 | + } | |
| 1200 | + | |
| 1201 | + $content = \html_entity_decode( $content ); | |
| 1202 | + $content = \wp_strip_all_tags( $content ); | |
| 1203 | + $content = \trim( $content ); | |
| 1204 | + $content = \preg_replace( '/\R+/m', "\n\n", $content ); | |
| 1205 | + $content = \preg_replace( '/[\r\t]/', '', $content ); | |
| 1206 | + | |
| 1207 | + if ( $length && \strlen( $content ) > $length ) { | |
| 1208 | + $content = \wordwrap( $content, $length, '</activitypub-summary>' ); | |
| 1209 | + $content = \explode( '</activitypub-summary>', $content, 2 ); | |
| 1210 | + $content = $content[0] . ' ' . $excerpt_more; | |
| 1211 | + } | |
| 1212 | + | |
| 1213 | + /* Removed until this is merged: https://github.com/mastodon/mastodon/pull/28629 | |
| 1214 | + return \apply_filters( 'the_excerpt', $content ); | |
| 1215 | + */ | |
| 1216 | + return $content; | |
| 776 | 1217 | } |
