| @@ -1,256 +1,277 @@ | ||
| 1 | 1 | <?php |
| 2 | +/** | |
| 3 | + * Functions file. | |
| 4 | + * | |
| 5 | + * General utility functions for the ActivityPub plugin. | |
| 6 | + * | |
| 7 | + * @package Activitypub | |
| 8 | + */ | |
| 9 | + | |
| 2 | 10 | namespace Activitypub; |
| 3 | 11 | |
| 4 | -use WP_Error; | |
| 5 | -use Activitypub\Http; | |
| 6 | -use Activitypub\Activity\Activity; | |
| 7 | -use Activitypub\Collection\Followers; | |
| 8 | -use Activitypub\Collection\Users; | |
| 9 | - | |
| 10 | 12 | /** |
| 11 | - * Returns the ActivityPub default JSON-context | |
| 13 | + * Get the ActivityPub ID for a WordPress object. | |
| 12 | 14 | * |
| 13 | - * @return array the activitypub context | |
| 15 | + * Returns the canonical ActivityPub URI for a WP_Post or WP_Comment. | |
| 16 | + * | |
| 17 | + * @param \WP_Post|\WP_Comment $wp_object The WordPress post or comment. | |
| 18 | + * | |
| 19 | + * @return string|null The ActivityPub ID (a URL), or null if unsupported type. | |
| 14 | 20 | */ |
| 15 | -function get_context() { | |
| 16 | - $context = Activity::CONTEXT; | |
| 21 | +function get_object_id( $wp_object ) { | |
| 22 | + if ( $wp_object instanceof \WP_Post ) { | |
| 23 | + return get_post_id( $wp_object->ID ); | |
| 24 | + } | |
| 17 | 25 | |
| 18 | - return \apply_filters( 'activitypub_json_context', $context ); | |
| 19 | -} | |
| 26 | + if ( $wp_object instanceof \WP_Comment ) { | |
| 27 | + return get_comment_id( $wp_object ); | |
| 28 | + } | |
| 20 | 29 | |
| 21 | -function safe_remote_post( $url, $body, $user_id ) { | |
| 22 | - return Http::post( $url, $body, $user_id ); | |
| 30 | + return null; | |
| 23 | 31 | } |
| 24 | 32 | |
| 25 | -function safe_remote_get( $url ) { | |
| 26 | - return Http::get( $url ); | |
| 33 | +/** | |
| 34 | + * Convert a string from camelCase to snake_case. | |
| 35 | + * | |
| 36 | + * @param string $input The string to convert. | |
| 37 | + * | |
| 38 | + * @return string The converted string. | |
| 39 | + */ | |
| 40 | +function camel_to_snake_case( $input ) { | |
| 41 | + return \strtolower( \preg_replace( '/(?<!^)[A-Z]/', '_$0', $input ) ); | |
| 27 | 42 | } |
| 28 | 43 | |
| 29 | 44 | /** |
| 30 | - * Returns a users WebFinger "resource" | |
| 45 | + * Convert a string from snake_case to camelCase. | |
| 31 | 46 | * |
| 32 | - * @param int $user_id The User-ID. | |
| 47 | + * @param string $input The string to convert. | |
| 33 | 48 | * |
| 34 | - * @return string The User-Resource. | |
| 49 | + * @return string The converted string. | |
| 35 | 50 | */ |
| 36 | -function get_webfinger_resource( $user_id ) { | |
| 37 | - return Webfinger::get_user_resource( $user_id ); | |
| 51 | +function snake_to_camel_case( $input ) { | |
| 52 | + return \lcfirst( \str_replace( '_', '', \ucwords( $input, '_' ) ) ); | |
| 38 | 53 | } |
| 39 | 54 | |
| 40 | 55 | /** |
| 41 | - * Requests the Meta-Data from the Actors profile | |
| 56 | + * Convert seconds to ISO 8601 duration format. | |
| 42 | 57 | * |
| 43 | - * @param string $actor The Actor URL. | |
| 44 | - * @param bool $cached If the result should be cached. | |
| 58 | + * @param int $seconds The duration in seconds. | |
| 45 | 59 | * |
| 46 | - * @return array|WP_Error The Actor profile as array or WP_Error on failure. | |
| 60 | + * @return string The duration in ISO 8601 format (e.g., "PT1H23M45S"). | |
| 47 | 61 | */ |
| 48 | -function get_remote_metadata_by_actor( $actor, $cached = true ) { | |
| 49 | - $pre = apply_filters( 'pre_get_remote_metadata_by_actor', false, $actor ); | |
| 50 | - if ( $pre ) { | |
| 51 | - return $pre; | |
| 52 | - } | |
| 53 | - if ( preg_match( '/^@?' . ACTIVITYPUB_USERNAME_REGEXP . '$/i', $actor ) ) { | |
| 54 | - $actor = Webfinger::resolve( $actor ); | |
| 55 | - } | |
| 62 | +function seconds_to_iso8601( $seconds ) { | |
| 63 | + $seconds = (int) $seconds; | |
| 56 | 64 | |
| 57 | - if ( ! $actor ) { | |
| 58 | - return new WP_Error( 'activitypub_no_valid_actor_identifier', \__( 'The "actor" identifier is not valid', 'activitypub' ), array( 'status' => 404, 'actor' => $actor ) ); | |
| 65 | + if ( $seconds <= 0 ) { | |
| 66 | + return 'PT0S'; | |
| 59 | 67 | } |
| 60 | 68 | |
| 61 | - if ( is_wp_error( $actor ) ) { | |
| 62 | - return $actor; | |
| 63 | - } | |
| 69 | + $hours = \floor( $seconds / 3600 ); | |
| 70 | + $minutes = \floor( ( $seconds % 3600 ) / 60 ); | |
| 71 | + $secs = $seconds % 60; | |
| 64 | 72 | |
| 65 | - $transient_key = 'activitypub_' . $actor; | |
| 73 | + $duration = 'PT'; | |
| 66 | 74 | |
| 67 | - // only check the cache if needed. | |
| 68 | - if ( $cached ) { | |
| 69 | - $metadata = \get_transient( $transient_key ); | |
| 70 | - | |
| 71 | - if ( $metadata ) { | |
| 72 | - return $metadata; | |
| 73 | - } | |
| 75 | + if ( $hours > 0 ) { | |
| 76 | + $duration .= $hours . 'H'; | |
| 74 | 77 | } |
| 75 | 78 | |
| 76 | - if ( ! \wp_http_validate_url( $actor ) ) { | |
| 77 | - $metadata = new WP_Error( 'activitypub_no_valid_actor_url', \__( 'The "actor" is no valid URL', 'activitypub' ), array( 'status' => 400, 'actor' => $actor ) ); | |
| 78 | - return $metadata; | |
| 79 | + if ( $minutes > 0 ) { | |
| 80 | + $duration .= $minutes . 'M'; | |
| 79 | 81 | } |
| 80 | 82 | |
| 81 | - $response = Http::get( $actor ); | |
| 82 | - | |
| 83 | - if ( \is_wp_error( $response ) ) { | |
| 84 | - return $response; | |
| 83 | + if ( $secs > 0 || ( 0 === $hours && 0 === $minutes ) ) { | |
| 84 | + $duration .= $secs . 'S'; | |
| 85 | 85 | } |
| 86 | 86 | |
| 87 | - $metadata = \wp_remote_retrieve_body( $response ); | |
| 88 | - $metadata = \json_decode( $metadata, true ); | |
| 89 | - | |
| 90 | - if ( ! $metadata ) { | |
| 91 | - $metadata = new WP_Error( 'activitypub_invalid_json', \__( 'No valid JSON data', 'activitypub' ), array( 'status' => 400, 'actor' => $actor ) ); | |
| 92 | - return $metadata; | |
| 93 | - } | |
| 94 | - | |
| 95 | - \set_transient( $transient_key, $metadata, WEEK_IN_SECONDS ); | |
| 96 | - | |
| 97 | - return $metadata; | |
| 87 | + return $duration; | |
| 98 | 88 | } |
| 99 | 89 | |
| 100 | 90 | /** |
| 101 | - * Returns the followers of a given user. | |
| 91 | + * Check if a site supports the block editor. | |
| 102 | 92 | * |
| 103 | - * @param int $user_id The User-ID. | |
| 104 | - * | |
| 105 | - * @return array The followers. | |
| 93 | + * @return boolean True if the site supports the block editor, false otherwise. | |
| 106 | 94 | */ |
| 107 | -function get_followers( $user_id ) { | |
| 108 | - return Followers::get_followers( $user_id ); | |
| 95 | +function site_supports_blocks() { | |
| 96 | + /** | |
| 97 | + * Allow plugins to disable block editor support, | |
| 98 | + * thus disabling blocks registered by the ActivityPub plugin. | |
| 99 | + * | |
| 100 | + * @param boolean $supports_blocks True if the site supports the block editor, false otherwise. | |
| 101 | + */ | |
| 102 | + return \apply_filters( 'activitypub_site_supports_blocks', true ); | |
| 109 | 103 | } |
| 110 | 104 | |
| 111 | 105 | /** |
| 112 | - * Count the number of followers for a given user. | |
| 106 | + * Get the icon Image object for site-wide ActivityPub actors. | |
| 113 | 107 | * |
| 114 | - * @param int $user_id The User-ID. | |
| 108 | + * Tries the site icon first, then the custom logo, and falls back to the | |
| 109 | + * bundled WordPress logo. | |
| 115 | 110 | * |
| 116 | - * @return int The number of followers. | |
| 117 | - */ | |
| 118 | -function count_followers( $user_id ) { | |
| 119 | - return Followers::count_followers( $user_id ); | |
| 120 | -} | |
| 121 | - | |
| 122 | -/** | |
| 123 | - * Examine a url and try to determine the author ID it represents. | |
| 111 | + * @since 9.1.0 | |
| 124 | 112 | * |
| 125 | - * Checks are supposedly from the hosted site blog. | |
| 126 | - * | |
| 127 | - * @param string $url Permalink to check. | |
| 128 | - * | |
| 129 | - * @return int User ID, or 0 on failure. | |
| 113 | + * @return array The icon array with 'type' and 'url'. | |
| 130 | 114 | */ |
| 131 | -function url_to_authorid( $url ) { | |
| 132 | - global $wp_rewrite; | |
| 115 | +function site_icon() { | |
| 116 | + // Try site icon first. | |
| 117 | + $icon_id = \get_option( 'site_icon' ); | |
| 133 | 118 | |
| 134 | - // check if url hase the same host | |
| 135 | - if ( \wp_parse_url( \site_url(), \PHP_URL_HOST ) !== \wp_parse_url( $url, \PHP_URL_HOST ) ) { | |
| 136 | - return 0; | |
| 119 | + // Try custom logo second. | |
| 120 | + if ( ! $icon_id ) { | |
| 121 | + $icon_id = \get_theme_mod( 'custom_logo' ); | |
| 137 | 122 | } |
| 138 | 123 | |
| 139 | - // first, check to see if there is a 'author=N' to match against | |
| 140 | - if ( \preg_match( '/[?&]author=(\d+)/i', $url, $values ) ) { | |
| 141 | - $id = \absint( $values[1] ); | |
| 142 | - if ( $id ) { | |
| 143 | - return $id; | |
| 124 | + $icon_url = false; | |
| 125 | + | |
| 126 | + if ( $icon_id ) { | |
| 127 | + $icon = \wp_get_attachment_image_src( $icon_id, 'full' ); | |
| 128 | + if ( $icon ) { | |
| 129 | + $icon_url = $icon[0]; | |
| 144 | 130 | } |
| 145 | 131 | } |
| 146 | 132 | |
| 147 | - // check to see if we are using rewrite rules | |
| 148 | - $rewrite = $wp_rewrite->wp_rewrite_rules(); | |
| 133 | + if ( ! $icon_url ) { | |
| 134 | + // Fallback to default icon. | |
| 135 | + $icon_url = \plugins_url( '/assets/img/wp-logo.png', ACTIVITYPUB_PLUGIN_FILE ); | |
| 136 | + } | |
| 149 | 137 | |
| 150 | - // not using rewrite rules, and 'author=N' method failed, so we're out of options | |
| 151 | - if ( empty( $rewrite ) ) { | |
| 152 | - return 0; | |
| 153 | - } | |
| 138 | + return array( | |
| 139 | + 'type' => 'Image', | |
| 140 | + 'url' => \esc_url_raw( $icon_url ), | |
| 141 | + ); | |
| 142 | +} | |
| 154 | 143 | |
| 155 | - // generate rewrite rule for the author url | |
| 156 | - $author_rewrite = $wp_rewrite->get_author_permastruct(); | |
| 157 | - $author_regexp = \str_replace( '%author%', '', $author_rewrite ); | |
| 144 | +/** | |
| 145 | + * Check whether a blog is public based on the `blog_public` option. | |
| 146 | + * | |
| 147 | + * @return bool True if public, false if not | |
| 148 | + */ | |
| 149 | +function is_blog_public() { | |
| 150 | + /** | |
| 151 | + * Filter whether the blog is public. | |
| 152 | + * | |
| 153 | + * @param bool $public Whether the blog is public. | |
| 154 | + */ | |
| 155 | + return (bool) \apply_filters( 'activitypub_is_blog_public', \get_option( 'blog_public', 1 ) ); | |
| 156 | +} | |
| 158 | 157 | |
| 159 | - // match the rewrite rule with the passed url | |
| 160 | - if ( \preg_match( '/https?:\/\/(.+)' . \preg_quote( $author_regexp, '/' ) . '([^\/]+)/i', $url, $match ) ) { | |
| 161 | - $user = \get_user_by( 'slug', $match[2] ); | |
| 162 | - if ( $user ) { | |
| 163 | - return $user->ID; | |
| 164 | - } | |
| 165 | - } | |
| 158 | +/** | |
| 159 | + * Get the masked WordPress version to only show the major and minor version. | |
| 160 | + * | |
| 161 | + * @return string The masked version. | |
| 162 | + */ | |
| 163 | +function get_masked_wp_version() { | |
| 164 | + // Only show the major and minor version. | |
| 165 | + $version = \get_bloginfo( 'version' ); | |
| 166 | + // Strip the RC or beta part. | |
| 167 | + $version = \preg_replace( '/-.*$/', '', $version ); | |
| 168 | + $version = \explode( '.', $version ); | |
| 169 | + $version = \array_slice( $version, 0, 2 ); | |
| 166 | 170 | |
| 167 | - return 0; | |
| 171 | + return \implode( '.', $version ); | |
| 168 | 172 | } |
| 169 | 173 | |
| 170 | 174 | /** |
| 171 | - * Check for Tombstone Objects | |
| 175 | + * Check if a plugin is active, loading plugin.php if necessary. | |
| 172 | 176 | * |
| 173 | - * @see https://www.w3.org/TR/activitypub/#delete-activity-outbox | |
| 177 | + * This is a wrapper around the core is_plugin_active() function that ensures | |
| 178 | + * the function is available by loading wp-admin/includes/plugin.php if needed. | |
| 179 | + * This is useful when checking plugin status outside of the admin context. | |
| 174 | 180 | * |
| 175 | - * @param WP_Error $wp_error A WP_Error-Response of an HTTP-Request | |
| 181 | + * @param string $plugin Plugin basename (e.g., 'plugin-folder/plugin-file.php'). | |
| 176 | 182 | * |
| 177 | - * @return boolean true if HTTP-Code is 410 or 404 | |
| 183 | + * @return bool True if the plugin is active, false otherwise. | |
| 178 | 184 | */ |
| 179 | -function is_tombstone( $wp_error ) { | |
| 180 | - if ( ! is_wp_error( $wp_error ) ) { | |
| 181 | - return false; | |
| 185 | +function is_plugin_active( $plugin ) { | |
| 186 | + // Include plugin.php if not already loaded (needed for core is_plugin_active). | |
| 187 | + if ( ! \function_exists( 'is_plugin_active' ) ) { | |
| 188 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; | |
| 182 | 189 | } |
| 183 | 190 | |
| 184 | - if ( in_array( (int) $wp_error->get_error_code(), array( 404, 410 ), true ) ) { | |
| 185 | - return true; | |
| 186 | - } | |
| 187 | - | |
| 188 | - return false; | |
| 191 | + return \is_plugin_active( $plugin ); | |
| 189 | 192 | } |
| 190 | 193 | |
| 191 | 194 | /** |
| 192 | - * Get the REST URL relative to this plugin's namespace. | |
| 195 | + * Returns the website hosts allowed to credit this blog. | |
| 193 | 196 | * |
| 194 | - * @param string $path Optional. REST route path. Otherwise this plugin's namespaced root. | |
| 195 | - * | |
| 196 | - * @return string REST URL relative to this plugin's namespace. | |
| 197 | + * @return array|null The attribution domains or null if not found. | |
| 197 | 198 | */ |
| 198 | -function get_rest_url_by_path( $path = '' ) { | |
| 199 | - // we'll handle the leading slash. | |
| 200 | - $path = ltrim( $path, '/' ); | |
| 201 | - $namespaced_path = sprintf( '/%s/%s', ACTIVITYPUB_REST_NAMESPACE, $path ); | |
| 202 | - return \get_rest_url( null, $namespaced_path ); | |
| 199 | +function get_attribution_domains() { | |
| 200 | + if ( '1' !== \get_option( 'activitypub_use_opengraph', '1' ) ) { | |
| 201 | + return null; | |
| 202 | + } | |
| 203 | + | |
| 204 | + $domains = \get_option( 'activitypub_attribution_domains', home_host() ); | |
| 205 | + $domains = \explode( PHP_EOL, $domains ); | |
| 206 | + | |
| 207 | + if ( ! $domains ) { | |
| 208 | + $domains = null; | |
| 209 | + } | |
| 210 | + | |
| 211 | + return $domains; | |
| 203 | 212 | } |
| 204 | 213 | |
| 205 | 214 | /** |
| 206 | - * Convert a string from camelCase to snake_case. | |
| 215 | + * Change the display of large numbers on the site. | |
| 207 | 216 | * |
| 208 | - * @param string $string The string to convert. | |
| 217 | + * @author Jeremy Herve | |
| 209 | 218 | * |
| 210 | - * @return string The converted string. | |
| 211 | - */ | |
| 212 | -// phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound | |
| 213 | -function camel_to_snake_case( $string ) { | |
| 214 | - return strtolower( preg_replace( '/(?<!^)[A-Z]/', '_$0', $string ) ); | |
| 215 | -} | |
| 216 | - | |
| 217 | -/** | |
| 218 | - * Convert a string from snake_case to camelCase. | |
| 219 | + * @see https://wordpress.org/support/topic/abbreviate-numbers-with-k/ | |
| 219 | 220 | * |
| 220 | - * @param string $string The string to convert. | |
| 221 | + * @param string $formatted Converted number in string format. | |
| 222 | + * @param float $number The number to convert based on locale. | |
| 221 | 223 | * |
| 222 | - * @return string The converted string. | |
| 224 | + * @return string Converted number in string format. | |
| 223 | 225 | */ |
| 224 | -// phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound | |
| 225 | -function snake_to_camel_case( $string ) { | |
| 226 | - return lcfirst( str_replace( '_', '', ucwords( $string, '_' ) ) ); | |
| 226 | +function custom_large_numbers( $formatted, $number ) { | |
| 227 | + global $wp_locale; | |
| 228 | + | |
| 229 | + $decimals = 0; | |
| 230 | + $decimal_point = '.'; | |
| 231 | + $thousands_sep = ','; | |
| 232 | + | |
| 233 | + if ( isset( $wp_locale ) ) { | |
| 234 | + $decimals = (int) $wp_locale->number_format['decimal_point']; | |
| 235 | + $decimal_point = $wp_locale->number_format['decimal_point']; | |
| 236 | + $thousands_sep = $wp_locale->number_format['thousands_sep']; | |
| 237 | + } | |
| 238 | + | |
| 239 | + if ( $number < 1000 ) { // Any number less than a Thousand. | |
| 240 | + return \number_format( $number, $decimals, $decimal_point, $thousands_sep ); | |
| 241 | + } elseif ( $number < 1000000 ) { // Any number less than a million. | |
| 242 | + return \number_format( $number / 1000, $decimals, $decimal_point, $thousands_sep ) . 'K'; | |
| 243 | + } elseif ( $number < 1000000000 ) { // Any number less than a billion. | |
| 244 | + return \number_format( $number / 1000000, $decimals, $decimal_point, $thousands_sep ) . 'M'; | |
| 245 | + } else { // At least a billion. | |
| 246 | + return \number_format( $number / 1000000000, $decimals, $decimal_point, $thousands_sep ) . 'B'; | |
| 247 | + } | |
| 227 | 248 | } |
| 228 | 249 | |
| 229 | 250 | /** |
| 230 | 251 | * Escapes a Tag, to be used as a hashtag. |
| 231 | 252 | * |
| 232 | - * @param string $string The string to escape. | |
| 253 | + * @param string $input The string to escape. | |
| 233 | 254 | * |
| 234 | - * @return string The escaped hastag. | |
| 255 | + * @return string The escaped hashtag. | |
| 235 | 256 | */ |
| 236 | -function esc_hashtag( $string ) { | |
| 257 | +function esc_hashtag( $input ) { | |
| 258 | + $hashtag = \wp_specialchars_decode( $input, ENT_QUOTES ); | |
| 259 | + // Remove all characters that are not letters, numbers, or hyphens. | |
| 260 | + $hashtag = \preg_replace( '/[^\p{L}\p{Nd}-]+/u', '-', $hashtag ); | |
| 237 | 261 | |
| 238 | - $hashtag = \wp_specialchars_decode( $string, ENT_QUOTES ); | |
| 239 | - // Remove all characters that are not letters, numbers, or underscores. | |
| 240 | - $hashtag = \preg_replace( '/emoji-regex(*SKIP)(?!)|[^\p{L}\p{Nd}_]+/u', '_', $hashtag ); | |
| 241 | - | |
| 242 | - // Capitalize every letter that is preceded by an underscore. | |
| 243 | - $hashtag = preg_replace_callback( | |
| 244 | - '/_(.)/', | |
| 245 | - function ( $matches ) { | |
| 246 | - return '' . strtoupper( $matches[1] ); | |
| 262 | + // Capitalize every letter that is preceded by a hyphen. | |
| 263 | + $hashtag = \preg_replace_callback( | |
| 264 | + '/-+(.)/', | |
| 265 | + static function ( $matches ) { | |
| 266 | + return \strtoupper( $matches[1] ); | |
| 247 | 267 | }, |
| 248 | 268 | $hashtag |
| 249 | 269 | ); |
| 250 | 270 | |
| 251 | 271 | // Add a hashtag to the beginning of the string. |
| 252 | - $hashtag = ltrim( $hashtag, '#' ); | |
| 272 | + $hashtag = \ltrim( $hashtag, '#' ); | |
| 273 | + $hashtag = \trim( $hashtag, '-' ); | |
| 253 | 274 | $hashtag = '#' . $hashtag; |
| 254 | 275 | |
| 255 | 276 | /** |
| 256 | 277 | * Allow defining your own custom hashtag generation rules. |
| @@ -255,295 +276,182 @@ | ||
| 255 | 276 | /** |
| 256 | 277 | * Allow defining your own custom hashtag generation rules. |
| 257 | 278 | * |
| 258 | 279 | * @param string $hashtag The hashtag to be returned. |
| 259 | - * @param string $string The original string. | |
| 280 | + * @param string $input The original string. | |
| 260 | 281 | */ |
| 261 | - $hashtag = apply_filters( 'activitypub_esc_hashtag', $hashtag, $string ); | |
| 282 | + $hashtag = \apply_filters( 'activitypub_esc_hashtag', $hashtag, $input ); | |
| 262 | 283 | |
| 263 | - return esc_html( $hashtag ); | |
| 284 | + return \esc_html( $hashtag ); | |
| 264 | 285 | } |
| 265 | 286 | |
| 266 | 287 | /** |
| 267 | - * Check if a request is for an ActivityPub request. | |
| 288 | + * Replace content with links, mentions or hashtags by Regex callback and not affect protected tags. | |
| 268 | 289 | * |
| 269 | - * @return bool False by default. | |
| 290 | + * @param string $content The content that should be changed. | |
| 291 | + * @param string $regex The regex to use. | |
| 292 | + * @param callable $regex_callback Callback for replacement logic. | |
| 293 | + * | |
| 294 | + * @return string The content with links, mentions, hashtags, etc. | |
| 270 | 295 | */ |
| 271 | -function is_activitypub_request() { | |
| 272 | - global $wp_query; | |
| 273 | - | |
| 274 | - /* | |
| 275 | - * ActivityPub requests are currently only made for | |
| 276 | - * author archives, singular posts, and the homepage. | |
| 277 | - */ | |
| 278 | - if ( ! \is_author() && ! \is_singular() && ! \is_home() && ! defined( '\REST_REQUEST' ) ) { | |
| 279 | - return false; | |
| 296 | +function enrich_content_data( $content, $regex, $regex_callback ) { | |
| 297 | + // Small protection against execution timeouts: limit to 1 MB. | |
| 298 | + if ( \mb_strlen( $content ) > MB_IN_BYTES ) { | |
| 299 | + return $content; | |
| 280 | 300 | } |
| 281 | - | |
| 282 | - // One can trigger an ActivityPub request by adding ?activitypub to the URL. | |
| 283 | - // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.VariableRedeclaration | |
| 284 | - global $wp_query; | |
| 285 | - if ( isset( $wp_query->query_vars['activitypub'] ) ) { | |
| 286 | - return true; | |
| 287 | - } | |
| 288 | - | |
| 289 | - /* | |
| 290 | - * The other (more common) option to make an ActivityPub request | |
| 291 | - * is to send an Accept header. | |
| 292 | - */ | |
| 293 | - if ( isset( $_SERVER['HTTP_ACCEPT'] ) ) { | |
| 294 | - $accept = sanitize_text_field( wp_unslash( $_SERVER['HTTP_ACCEPT'] ) ); | |
| 295 | - | |
| 296 | - /* | |
| 297 | - * $accept can be a single value, or a comma separated list of values. | |
| 298 | - * We want to support both scenarios, | |
| 299 | - * and return true when the header includes at least one of the following: | |
| 300 | - * - application/activity+json | |
| 301 | - * - application/ld+json | |
| 302 | - * - application/json | |
| 303 | - */ | |
| 304 | - if ( preg_match( '/(application\/(ld\+json|activity\+json|json))/i', $accept ) ) { | |
| 305 | - return true; | |
| 301 | + $tag_stack = array(); | |
| 302 | + $protected_tags = array( | |
| 303 | + 'pre', | |
| 304 | + 'code', | |
| 305 | + 'textarea', | |
| 306 | + 'style', | |
| 307 | + 'a', | |
| 308 | + ); | |
| 309 | + $content_with_links = ''; | |
| 310 | + $in_protected_tag = false; | |
| 311 | + foreach ( \wp_html_split( $content ) as $chunk ) { | |
| 312 | + if ( \preg_match( '#^<!--[\s\S]*-->$#i', $chunk, $m ) ) { | |
| 313 | + $content_with_links .= $chunk; | |
| 314 | + continue; | |
| 306 | 315 | } |
| 307 | - } | |
| 308 | 316 | |
| 309 | - return false; | |
| 310 | -} | |
| 311 | - | |
| 312 | -/** | |
| 313 | - * This function checks if a user is disabled for ActivityPub. | |
| 314 | - * | |
| 315 | - * @param int $user_id The User-ID. | |
| 316 | - * | |
| 317 | - * @return boolean True if the user is disabled, false otherwise. | |
| 318 | - */ | |
| 319 | -function is_user_disabled( $user_id ) { | |
| 320 | - $return = false; | |
| 321 | - | |
| 322 | - switch ( $user_id ) { | |
| 323 | - // if the user is the application user, it's always enabled. | |
| 324 | - case \Activitypub\Collection\Users::APPLICATION_USER_ID: | |
| 325 | - $return = false; | |
| 326 | - break; | |
| 327 | - // if the user is the blog user, it's only enabled in single-user mode. | |
| 328 | - case \Activitypub\Collection\Users::BLOG_USER_ID: | |
| 329 | - if ( is_user_type_disabled( 'blog' ) ) { | |
| 330 | - $return = true; | |
| 331 | - break; | |
| 332 | - } | |
| 333 | - | |
| 334 | - $return = false; | |
| 335 | - break; | |
| 336 | - // if the user is any other user, it's enabled if it can publish posts. | |
| 337 | - default: | |
| 338 | - if ( ! \get_user_by( 'id', $user_id ) ) { | |
| 339 | - $return = true; | |
| 340 | - break; | |
| 341 | - } | |
| 342 | - | |
| 343 | - if ( is_user_type_disabled( 'user' ) ) { | |
| 344 | - $return = true; | |
| 345 | - break; | |
| 346 | - } | |
| 347 | - | |
| 348 | - if ( ! \user_can( $user_id, 'publish_posts' ) ) { | |
| 349 | - $return = true; | |
| 350 | - break; | |
| 351 | - } | |
| 352 | - | |
| 353 | - $return = false; | |
| 354 | - break; | |
| 355 | - } | |
| 356 | - | |
| 357 | - return apply_filters( 'activitypub_is_user_disabled', $return, $user_id ); | |
| 358 | -} | |
| 359 | - | |
| 360 | -/** | |
| 361 | - * Checks if a User-Type is disabled for ActivityPub. | |
| 362 | - * | |
| 363 | - * This function is used to check if the 'blog' or 'user' | |
| 364 | - * type is disabled for ActivityPub. | |
| 365 | - * | |
| 366 | - * @param enum $type Can be 'blog' or 'user'. | |
| 367 | - * | |
| 368 | - * @return boolean True if the user type is disabled, false otherwise. | |
| 369 | - */ | |
| 370 | -function is_user_type_disabled( $type ) { | |
| 371 | - switch ( $type ) { | |
| 372 | - case 'blog': | |
| 373 | - if ( \defined( 'ACTIVITYPUB_SINGLE_USER_MODE' ) ) { | |
| 374 | - if ( ACTIVITYPUB_SINGLE_USER_MODE ) { | |
| 375 | - $return = false; | |
| 376 | - break; | |
| 317 | + if ( \preg_match( '#^<(/)?([a-z-]+)\b[^>]*>$#i', $chunk, $m ) ) { | |
| 318 | + $tag = \strtolower( $m[2] ); | |
| 319 | + if ( '/' === $m[1] ) { | |
| 320 | + // Closing tag. | |
| 321 | + $i = \array_search( $tag, $tag_stack, true ); | |
| 322 | + // We can only remove the tag from the stack if it is in the stack. | |
| 323 | + if ( false !== $i ) { | |
| 324 | + $tag_stack = \array_slice( $tag_stack, 0, $i ); | |
| 377 | 325 | } |
| 326 | + } else { | |
| 327 | + // Opening tag, add it to the stack. | |
| 328 | + $tag_stack[] = $tag; | |
| 378 | 329 | } |
| 379 | 330 | |
| 380 | - if ( \defined( 'ACTIVITYPUB_DISABLE_BLOG_USER' ) ) { | |
| 381 | - $return = ACTIVITYPUB_DISABLE_BLOG_USER; | |
| 382 | - break; | |
| 383 | - } | |
| 331 | + // If we're in a protected tag, the tag_stack contains at least one protected tag string. | |
| 332 | + // The protected tag state can only change when we encounter a start or end tag. | |
| 333 | + $in_protected_tag = \array_intersect( $tag_stack, $protected_tags ); | |
| 384 | 334 | |
| 385 | - if ( '1' !== \get_option( 'activitypub_enable_blog_user', '0' ) ) { | |
| 386 | - $return = true; | |
| 387 | - break; | |
| 388 | - } | |
| 335 | + // Never inspect tags. | |
| 336 | + $content_with_links .= $chunk; | |
| 337 | + continue; | |
| 338 | + } | |
| 389 | 339 | |
| 390 | - $return = false; | |
| 391 | - break; | |
| 392 | - case 'user': | |
| 393 | - if ( \defined( 'ACTIVITYPUB_SINGLE_USER_MODE' ) ) { | |
| 394 | - if ( ACTIVITYPUB_SINGLE_USER_MODE ) { | |
| 395 | - $return = true; | |
| 396 | - break; | |
| 397 | - } | |
| 398 | - } | |
| 340 | + if ( $in_protected_tag ) { | |
| 341 | + // Don't inspect a chunk inside an inspected tag. | |
| 342 | + $content_with_links .= $chunk; | |
| 343 | + continue; | |
| 344 | + } | |
| 399 | 345 | |
| 400 | - if ( \defined( 'ACTIVITYPUB_DISABLE_USER' ) ) { | |
| 401 | - $return = ACTIVITYPUB_DISABLE_USER; | |
| 402 | - break; | |
| 403 | - } | |
| 404 | - | |
| 405 | - if ( '1' !== \get_option( 'activitypub_enable_users', '1' ) ) { | |
| 406 | - $return = true; | |
| 407 | - break; | |
| 408 | - } | |
| 409 | - | |
| 410 | - $return = false; | |
| 411 | - break; | |
| 412 | - default: | |
| 413 | - $return = new WP_Error( 'activitypub_wrong_user_type', __( 'Wrong user type', 'activitypub' ), array( 'status' => 400 ) ); | |
| 414 | - break; | |
| 346 | + // Only reachable when there is no protected tag in the stack. | |
| 347 | + $content_with_links .= \preg_replace_callback( $regex, $regex_callback, $chunk ); | |
| 415 | 348 | } |
| 416 | 349 | |
| 417 | - return apply_filters( 'activitypub_is_user_type_disabled', $return, $type ); | |
| 350 | + return $content_with_links; | |
| 418 | 351 | } |
| 419 | 352 | |
| 420 | 353 | /** |
| 421 | - * Check if the blog is in single-user mode. | |
| 354 | + * Get an ActivityPub embed HTML for a URL. | |
| 422 | 355 | * |
| 423 | - * @return boolean True if the blog is in single-user mode, false otherwise. | |
| 424 | - */ | |
| 425 | -function is_single_user() { | |
| 426 | - if ( | |
| 427 | - false === is_user_type_disabled( 'blog' ) && | |
| 428 | - true === is_user_type_disabled( 'user' ) | |
| 429 | - ) { | |
| 430 | - return true; | |
| 431 | - } | |
| 432 | - | |
| 433 | - return false; | |
| 434 | -} | |
| 435 | - | |
| 436 | -/** | |
| 437 | - * Check if a site supports the block editor. | |
| 356 | + * @param string $url The URL to get the embed for. | |
| 357 | + * @param boolean $inline_css Whether to inline CSS. Default true. | |
| 438 | 358 | * |
| 439 | - * @return boolean True if the site supports the block editor, false otherwise. | |
| 359 | + * @return string|false The embed HTML or false if not found. | |
| 440 | 360 | */ |
| 441 | -function site_supports_blocks() { | |
| 442 | - if ( \version_compare( \get_bloginfo( 'version' ), '5.9', '<' ) ) { | |
| 443 | - return false; | |
| 444 | - } | |
| 445 | - | |
| 446 | - if ( ! \function_exists( 'register_block_type_from_metadata' ) ) { | |
| 447 | - return false; | |
| 448 | - } | |
| 449 | - | |
| 450 | - /** | |
| 451 | - * Allow plugins to disable block editor support, | |
| 452 | - * thus disabling blocks registered by the ActivityPub plugin. | |
| 453 | - * | |
| 454 | - * @param boolean $supports_blocks True if the site supports the block editor, false otherwise. | |
| 455 | - */ | |
| 456 | - return apply_filters( 'activitypub_site_supports_blocks', true ); | |
| 361 | +function get_embed_html( $url, $inline_css = true ) { | |
| 362 | + return Embed::get_html( $url, $inline_css ); | |
| 457 | 363 | } |
| 458 | 364 | |
| 459 | 365 | /** |
| 460 | - * Check if data is valid JSON. | |
| 366 | + * Get the client IP address for rate-limiting purposes. | |
| 461 | 367 | * |
| 462 | - * @param string $data The data to check. | |
| 368 | + * Walks the ordered list of $_SERVER keys returned by the | |
| 369 | + * `activitypub_client_ip_sources` filter (default: `['REMOTE_ADDR']`) and | |
| 370 | + * returns the first value that parses as a valid IP literal, validated via | |
| 371 | + * `filter_var( ..., FILTER_VALIDATE_IP )`. The result can be overridden | |
| 372 | + * outright via the `activitypub_client_ip` filter; that filter's output is | |
| 373 | + * also validated and replaced with `''` when it isn't a valid IP, so a | |
| 374 | + * misbehaving filter can't collide all callers into the same rate-limit | |
| 375 | + * bucket. | |
| 463 | 376 | * |
| 464 | - * @return boolean True if the data is JSON, false otherwise. | |
| 465 | - */ | |
| 466 | -function is_json( $data ) { | |
| 467 | - return \is_array( \json_decode( $data, true ) ) ? true : false; | |
| 468 | -} | |
| 469 | - | |
| 470 | -/** | |
| 471 | - * Check if a blog is public based on the `blog_public` option | |
| 377 | + * Trusting any source other than `REMOTE_ADDR` is only safe behind a | |
| 378 | + * reverse proxy that sets and overwrites the corresponding header — see | |
| 379 | + * the `activitypub_client_ip_sources` filter docblock for guidance. | |
| 472 | 380 | * |
| 473 | - * @return bollean True if public, false if not | |
| 474 | - */ | |
| 475 | -function is_blog_public() { | |
| 476 | - return (bool) apply_filters( 'activitypub_is_blog_public', \get_option( 'blog_public', 1 ) ); | |
| 477 | -} | |
| 478 | - | |
| 479 | -/** | |
| 480 | - * Get active users based on a given duration | |
| 381 | + * Callers using the return value as a rate-limit key should treat an | |
| 382 | + * empty return as "client unidentifiable" and fail closed rather than | |
| 383 | + * share a single bucket across every such request. | |
| 481 | 384 | * |
| 482 | - * @param int $duration The duration to check in month(s) | |
| 385 | + * @since 8.1.0 | |
| 483 | 386 | * |
| 484 | - * @return int The number of active users | |
| 387 | + * @return string A valid IP address, or '' when no IP could be determined. | |
| 485 | 388 | */ |
| 486 | -function get_active_users( $duration = 1 ) { | |
| 389 | +function get_client_ip() { | |
| 390 | + // phpcs:disable WordPressVIPMinimum.Variables.ServerVariables.UserControlledHeaders | |
| 391 | + $ip = ''; | |
| 487 | 392 | |
| 488 | - $duration = intval( $duration ); | |
| 489 | - $transient_key = sprintf( 'monthly_active_users_%d', $duration ); | |
| 490 | - $count = get_transient( $transient_key ); | |
| 393 | + /** | |
| 394 | + * Filter the ordered list of $_SERVER keys to consult as a source for the | |
| 395 | + * client IP. The first key whose value parses as a valid IP wins. | |
| 396 | + * | |
| 397 | + * Default: array( 'REMOTE_ADDR' ) — the actual TCP peer, the only value | |
| 398 | + * that an HTTP client cannot spoof. Trusting any other $_SERVER key is | |
| 399 | + * only safe when a reverse proxy in front of the site sets that key and | |
| 400 | + * overwrites any client-supplied version; otherwise an attacker can spoof | |
| 401 | + * the value and bypass the per-IP rate limits that depend on it. | |
| 402 | + * | |
| 403 | + * Common operator overrides: | |
| 404 | + * array( 'HTTP_CF_CONNECTING_IP' ) on Cloudflare. | |
| 405 | + * array( 'HTTP_TRUE_CLIENT_IP', 'REMOTE_ADDR' ) Akamai with a fallback. | |
| 406 | + * array( 'HTTP_X_REAL_IP' ) nginx that strips the client copy. | |
| 407 | + * | |
| 408 | + * X-Forwarded-For pitfall: even with a trusted proxy, an attacker can | |
| 409 | + * prepend their own value before the proxy appends the real client IP. | |
| 410 | + * This helper takes the leftmost entry, which is correct only when the | |
| 411 | + * trusted proxy fully overwrites the header. If you trust X-Forwarded-For | |
| 412 | + * end-to-end, prefer to resolve from the right by your known proxy count | |
| 413 | + * via the activitypub_client_ip filter. | |
| 414 | + * | |
| 415 | + * @since 8.2.0 | |
| 416 | + * | |
| 417 | + * @param string[] $sources $_SERVER keys to consult, in priority order. | |
| 418 | + */ | |
| 419 | + $sources = \apply_filters( 'activitypub_client_ip_sources', array( 'REMOTE_ADDR' ) ); | |
| 491 | 420 | |
| 492 | - if ( false === $count ) { | |
| 493 | - global $wpdb; | |
| 494 | - $query = "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 )"; | |
| 495 | - $query = $wpdb->prepare( $query, $duration ); | |
| 496 | - $count = $wpdb->get_var( $query ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery | |
| 497 | - | |
| 498 | - set_transient( $transient_key, $count, DAY_IN_SECONDS ); | |
| 421 | + if ( ! \is_array( $sources ) ) { | |
| 422 | + $sources = array( 'REMOTE_ADDR' ); | |
| 499 | 423 | } |
| 500 | 424 | |
| 501 | - // if 0 authors where active | |
| 502 | - if ( 0 === $count ) { | |
| 503 | - return 0; | |
| 504 | - } | |
| 425 | + foreach ( $sources as $source ) { | |
| 426 | + if ( ! \is_string( $source ) || empty( $_SERVER[ $source ] ) ) { | |
| 427 | + continue; | |
| 428 | + } | |
| 505 | 429 | |
| 506 | - // if single user mode | |
| 507 | - if ( is_single_user() ) { | |
| 508 | - return 1; | |
| 509 | - } | |
| 430 | + // Some headers (e.g. X-Forwarded-For) may contain a comma-separated list; use the first IP. | |
| 431 | + $ip_list = \sanitize_text_field( \wp_unslash( $_SERVER[ $source ] ) ); | |
| 432 | + $candidate = \trim( \explode( ',', $ip_list )[0] ); | |
| 510 | 433 | |
| 511 | - // if blog user is disabled | |
| 512 | - if ( is_user_disabled( Users::BLOG_USER_ID ) ) { | |
| 513 | - return $count; | |
| 434 | + if ( \filter_var( $candidate, FILTER_VALIDATE_IP ) ) { | |
| 435 | + $ip = $candidate; | |
| 436 | + break; | |
| 437 | + } | |
| 514 | 438 | } |
| 439 | + // phpcs:enable WordPressVIPMinimum.Variables.ServerVariables.UserControlledHeaders | |
| 515 | 440 | |
| 516 | - // also count blog user | |
| 517 | - return $count + 1; | |
| 518 | -} | |
| 441 | + /** | |
| 442 | + * Filter the client IP address used for rate limiting. | |
| 443 | + * | |
| 444 | + * @since 8.1.0 | |
| 445 | + * | |
| 446 | + * @param string $ip The detected client IP address (empty when none could be determined). | |
| 447 | + */ | |
| 448 | + $ip = \apply_filters( 'activitypub_client_ip', $ip ); | |
| 519 | 449 | |
| 520 | -/** | |
| 521 | - * Get the total number of users | |
| 522 | - * | |
| 523 | - * @return int The total number of users | |
| 524 | - */ | |
| 525 | -function get_total_users() { | |
| 526 | - // if single user mode | |
| 527 | - if ( is_single_user() ) { | |
| 528 | - return 1; | |
| 450 | + // Tolerate surrounding whitespace from filter callbacks; FILTER_VALIDATE_IP would otherwise reject it. | |
| 451 | + if ( \is_string( $ip ) ) { | |
| 452 | + $ip = \trim( $ip ); | |
| 529 | 453 | } |
| 530 | 454 | |
| 531 | - $users = \get_users( | |
| 532 | - array( | |
| 533 | - 'capability__in' => array( 'publish_posts' ), | |
| 534 | - ) | |
| 535 | - ); | |
| 536 | - | |
| 537 | - if ( is_array( $users ) ) { | |
| 538 | - $users = count( $users ); | |
| 539 | - } else { | |
| 540 | - $users = 1; | |
| 541 | - } | |
| 542 | - | |
| 543 | - // if blog user is disabled | |
| 544 | - if ( is_user_disabled( Users::BLOG_USER_ID ) ) { | |
| 545 | - return $users; | |
| 546 | - } | |
| 547 | - | |
| 548 | - return $users + 1; | |
| 455 | + // Re-validate so a misbehaving filter can't return a sentinel string that would collapse all callers into one bucket. | |
| 456 | + return \is_string( $ip ) && \filter_var( $ip, FILTER_VALIDATE_IP ) ? $ip : ''; | |
| 549 | 457 | } |
