supports_post_type( $post_type ) ) { _doing_it_wrong( __METHOD__, /* translators: %s: Block name. */ sprintf( 'The Transformer "%s" does not support the post type "%s".', esc_html( $this->get_label() ), esc_html( $post_type ) ), 'version_number_transformer_management_placeholder' ); } $this->wp_post = $wp_post; } /** * Get the supported WP post types that the transformer can use as an input. * * By default all post types are supported. * You may very likely wish to override this function. * * @since version_number_transformer_management_placeholder * @return string[] An array containing all the supported post types. */ public function get_supported_post_types() { return \get_post_types( array( 'public' => true ), 'names' ); } /** * Get the name of the plugin that registered the transformer. * * @see Forked from the WordPress elementor plugin. * @since version_number_transformer_management_placeholder * @return string Plugin name */ private function get_plugin_name_from_transformer_instance( $transformer ) { $class_reflection = new \ReflectionClass( $transformer ); $plugin_basename = plugin_basename( $class_reflection->getFileName() ); $plugin_directory = strtok( $plugin_basename, '/' ); $plugins_data = get_plugins( '/' . $plugin_directory ); $plugin_data = array_shift( $plugins_data ); if ( isset( $plugin_data['Name'] ) ) { return $plugin_data['Name']; } else { return esc_html__( 'Unknown', 'activitypub' ); } } /** * Return whether the transformer supports a post type. * * @since version_number_transformer_management_placeholder * @return string post_type Post type name. */ final public function supports_post_type( $post_type ) { return in_array( $post_type, $this->get_supported_post_types(), true ); } /** * Get the name used for registering the transformer with the ActivityPub plugin. * * @since version_number_transformer_management_placeholder * @return string name */ abstract public function get_name(); /** * Get the display name for the ActivityPub transformer. * * @since version_number_transformer_management_placeholder * @return string display name */ abstract public function get_label(); /** * Returns the ActivityStreams 2.0 Object-Type for a Post. * * @see https://www.w3.org/TR/activitystreams-vocabulary/#activity-types * * @return string The Object-Type. */ abstract protected function get_object_type(); /** * Returns the content for the ActivityPub Item. * * The content will be generated based on the user settings. * * @return string The content. */ protected function get_content() { global $post; /** * Provides an action hook so plugins can add their own hooks/filters before AP content is generated. * * Example: if a plugin adds a filter to `the_content` to add a button to the end of posts, it can also remove that filter here. * * @param WP_Post $post The post object. */ do_action( 'activitypub_before_get_content', $post ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited $post = $this->wp_post; $content = $this->get_post_content_template(); // Register our shortcodes just in time. Shortcodes::register(); // Fill in the shortcodes. setup_postdata( $post ); $content = do_shortcode( $content ); wp_reset_postdata(); $content = \wpautop( $content ); $content = \preg_replace( '/[\n\r\t]/', '', $content ); $content = \trim( $content ); $content = \apply_filters( 'activitypub_the_content', $content, $post ); // Don't need these any more, should never appear in a post. Shortcodes::unregister(); return $content; } /** * Gets the template to use to generate the content of the activitypub item. * * @return string The Template. */ protected function get_post_content_template() { if ( 'excerpt' === \get_option( 'activitypub_post_content_type', 'content' ) ) { return "[ap_excerpt]\n\n[ap_permalink type=\"html\"]"; } if ( 'title' === \get_option( 'activitypub_post_content_type', 'content' ) ) { return "[ap_title]\n\n[ap_permalink type=\"html\"]"; } if ( 'content' === \get_option( 'activitypub_post_content_type', 'content' ) ) { return "[ap_content]\n\n[ap_permalink type=\"html\"]\n\n[ap_hashtags]"; } return \get_option( 'activitypub_custom_post_content', ACTIVITYPUB_CUSTOM_POST_CONTENT ); } /** * Returns the ID of the Post. * * @return string The Posts ID. */ public function get_id() { return $this->get_url(); } /** * Returns the URL of the Post. * * @return string The Posts URL. */ public function get_url() { $post = $this->wp_post; if ( 'trash' === get_post_status( $post ) ) { $permalink = \get_post_meta( $post->ID, 'activitypub_canonical_url', true ); } else { $permalink = \get_permalink( $post ); } return \esc_url( $permalink ); } /** * Returns the User-URL of the Author of the Post. * * If `single_user` mode is enabled, the URL of the Blog-User is returned. * * @return string The User-URL. */ protected function get_attributed_to() { if ( is_single_user() ) { $user = new Blog_User(); return $user->get_url(); } return Users::get_by_id( $this->wp_post->post_author )->get_url(); } /** * Generates all Media Attachments for a Post. * * @return array The Attachments. */ protected function get_attachments() { // Once upon a time we only supported images, but we now support audio/video as well. // We maintain the image-centric naming for backwards compatibility. $max_media = intval( \apply_filters( 'activitypub_max_image_attachments', \get_option( 'activitypub_max_image_attachments', ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS ) ) ); if ( site_supports_blocks() && \has_blocks( $this->wp_post->post_content ) ) { return $this->get_block_attachments( $max_media ); } return $this->get_classic_editor_images( $max_media ); } /** * Get media attachments from blocks. They will be formatted as ActivityPub attachments, not as WP attachments. * * @param int $max_media The maximum number of attachments to return. * * @return array The attachments. */ protected function get_block_attachments( $max_media ) { // max media can't be negative or zero if ( $max_media <= 0 ) { return array(); } $id = $this->wp_post->ID; $media_ids = array(); // list post thumbnail first if this post has one if ( \function_exists( 'has_post_thumbnail' ) && \has_post_thumbnail( $id ) ) { $media_ids[] = \get_post_thumbnail_id( $id ); } if ( $max_media > 0 ) { $blocks = \parse_blocks( $this->wp_post->post_content ); $media_ids = self::get_media_ids_from_blocks( $blocks, $media_ids, $max_media ); } return \array_filter( \array_map( array( self::class, 'wp_attachment_to_activity_attachment' ), $media_ids ) ); } /** * Get image attachments from the classic editor. * Note that audio/video attachments are only supported in the block editor. * * @param int $max_images The maximum number of images to return. * * @return array The attachments. */ protected function get_classic_editor_images( $max_images ) { // max images can't be negative or zero if ( $max_images <= 0 ) { return array(); } $id = $this->wp_post->ID; $image_ids = array(); // list post thumbnail first if this post has one if ( \function_exists( 'has_post_thumbnail' ) && \has_post_thumbnail( $id ) ) { $image_ids[] = \get_post_thumbnail_id( $id ); --$max_images; } if ( $max_images > 0 ) { $query = new \WP_Query( array( 'post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => 'ASC', 'orderby' => 'menu_order ID', 'posts_per_page' => $max_images, ) ); foreach ( $query->get_posts() as $attachment ) { if ( ! \in_array( $attachment->ID, $image_ids, true ) ) { $image_ids[] = $attachment->ID; } } } $image_ids = \array_unique( $image_ids ); return \array_filter( \array_map( array( self::class, 'wp_attachment_to_activity_attachment' ), $image_ids ) ); } /** * Recursively get media IDs from blocks. * * @param array $blocks The blocks to search for media IDs * @param array $media_ids The media IDs to append new IDs to * @param int $max_media The maximum number of media to return. * * @return array The image IDs. */ protected static function get_media_ids_from_blocks( $blocks, $media_ids, $max_media ) { foreach ( $blocks as $block ) { // recurse into inner blocks if ( ! empty( $block['innerBlocks'] ) ) { $media_ids = self::get_media_ids_from_blocks( $block['innerBlocks'], $media_ids, $max_media ); } switch ( $block['blockName'] ) { case 'core/image': case 'core/cover': case 'core/audio': case 'core/video': case 'videopress/video': if ( ! empty( $block['attrs']['id'] ) ) { $media_ids[] = $block['attrs']['id']; } break; case 'jetpack/slideshow': case 'jetpack/tiled-gallery': if ( ! empty( $block['attrs']['ids'] ) ) { $media_ids = array_merge( $media_ids, $block['attrs']['ids'] ); } break; case 'jetpack/image-compare': if ( ! empty( $block['attrs']['beforeImageId'] ) ) { $media_ids[] = $block['attrs']['beforeImageId']; } if ( ! empty( $block['attrs']['afterImageId'] ) ) { $media_ids[] = $block['attrs']['afterImageId']; } break; } // depupe $media_ids = \array_unique( $media_ids ); // stop doing unneeded work if ( count( $media_ids ) >= $max_media ) { break; } } // still need to slice it because one gallery could knock us over the limit return array_slice( $media_ids, 0, $max_media ); } /** * Converts a WordPress Attachment to an ActivityPub Attachment. * * @param int $id The Attachment ID. * * @return array The ActivityPub Attachment. */ public static function wp_attachment_to_activity_attachment( $id ) { $attachment = array(); $mime_type = \get_post_mime_type( $id ); $mime_type_parts = \explode( '/', $mime_type ); // switching on image/audio/video switch ( $mime_type_parts[0] ) { case 'image': $image_size = 'full'; /** * Filter the image URL returned for each post. * * @param array|false $thumbnail The image URL, or false if no image is available. * @param int $id The attachment ID. * @param string $image_size The image size to retrieve. Set to 'full' by default. */ $thumbnail = apply_filters( 'activitypub_get_image', self::get_image( $id, $image_size ), $id, $image_size ); if ( $thumbnail ) { $alt = \get_post_meta( $id, '_wp_attachment_image_alt', true ); $image = array( 'type' => 'Image', 'url' => $thumbnail[0], 'mediaType' => $mime_type, ); if ( $alt ) { $image['name'] = $alt; } $attachment = $image; } break; case 'audio': case 'video': $attachment = array( 'type' => 'Document', 'mediaType' => $mime_type, 'url' => \wp_get_attachment_url( $id ), 'name' => \get_the_title( $id ), ); $meta = wp_get_attachment_metadata( $id ); // height and width for videos if ( isset( $meta['width'] ) && isset( $meta['height'] ) ) { $attachment['width'] = $meta['width']; $attachment['height'] = $meta['height']; } // @todo: add `icon` support for audio/video attachments. Maybe use post thumbnail? break; } return \apply_filters( 'activitypub_attachment', $attachment, $id ); } /** * Return details about an image attachment. * * @param int $id The attachment ID. * @param string $image_size The image size to retrieve. Set to 'full' by default. * * @return array|false Array of image data, or boolean false if no image is available. */ protected static function get_image( $id, $image_size = 'full' ) { /** * Hook into the image retrieval process. Before image retrieval. * * @param int $id The attachment ID. * @param string $image_size The image size to retrieve. Set to 'full' by default. */ do_action( 'activitypub_get_image_pre', $id, $image_size ); $image = \wp_get_attachment_image_src( $id, $image_size ); /** * Hook into the image retrieval process. After image retrieval. * * @param int $id The attachment ID. * @param string $image_size The image size to retrieve. Set to 'full' by default. */ do_action( 'activitypub_get_image_post', $id, $image_size ); return $image; } /** * Helper function to get the @-Mentions from the post content. * * @return array The list of @-Mentions. */ protected function get_mentions() { return apply_filters( 'activitypub_extract_mentions', array(), $this->wp_post->post_content, $this->wp_post ); } /** * Returns a list of Mentions, used in the Post. * * @see https://docs.joinmastodon.org/spec/activitypub/#Mention * * @return array The list of Mentions. */ protected function get_cc() { $cc = array(); $mentions = $this->get_mentions(); if ( $mentions ) { foreach ( $mentions as $url ) { $cc[] = $url; } } return $cc; } /** * Returns a list of Tags, used in the Post. * * This includes Hash-Tags and Mentions. * * @return array The list of Tags. */ protected function get_tags() { $tags = array(); $post_tags = \get_the_tags( $this->wp_post->ID ); if ( $post_tags ) { foreach ( $post_tags as $post_tag ) { $tag = array( 'type' => 'Hashtag', 'href' => \esc_url( \get_tag_link( $post_tag->term_id ) ), 'name' => esc_hashtag( $post_tag->name ), ); $tags[] = $tag; } } $mentions = $this->get_mentions(); if ( $mentions ) { foreach ( $mentions as $mention => $url ) { $tag = array( 'type' => 'Mention', 'href' => \esc_url( $url ), 'name' => \esc_html( $mention ), ); $tags[] = $tag; } } return $tags; } /** * Returns the locale of the post. * * @return string The locale of the post. */ public function get_locale() { $post_id = $this->wp_post->ID; $lang = \strtolower( \strtok( \get_locale(), '_-' ) ); /** * Filter the locale of the post. * * @param string $lang The locale of the post. * @param int $post_id The post ID. * @param WP_Post $post The post object. * * @return string The filtered locale of the post. */ return apply_filters( 'activitypub_post_locale', $lang, $post_id, $this->wp_post ); } /** * Gets the contentMap * * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-contentmap * * @return array the contenmap */ protected function get_content_map() { return array( $this->get_locale() => $this->get_content(), ); } /** * Transforms the WP_Post object to an ActivityPub Object * * @see \Activitypub\Activity\Base_Object * * @return \Activitypub\Activity\Base_Object The ActivityPub Object */ public function to_object() { $wp_post = $this->wp_post; $object = new Base_Object(); $object->set_id( $this->get_id() ); $object->set_url( $this->get_url() ); $object->set_type( $this->get_object_type() ); $published = \strtotime( $wp_post->post_date_gmt ); $object->set_published( \gmdate( 'Y-m-d\TH:i:s\Z', $published ) ); $updated = \strtotime( $wp_post->post_modified_gmt ); if ( $updated > $published ) { $object->set_updated( \gmdate( 'Y-m-d\TH:i:s\Z', $updated ) ); } $object->set_attributed_to( $this->get_attributed_to() ); $object->set_content( $this->get_content() ); $object->set_content_map( $this->get_content_map ); $path = sprintf( 'users/%d/followers', intval( $wp_post->post_author ) ); $object->set_to( array( 'https://www.w3.org/ns/activitystreams#Public', get_rest_url_by_path( $path ), ) ); $object->set_cc( $this->get_cc() ); $object->set_attachment( $this->get_attachments() ); $object->set_tag( $this->get_tags() ); return $object; } }