wordpress-activitypub/includes/transformer/class-post.php

466 lines
11 KiB
PHP
Raw Normal View History

2018-09-30 22:51:22 +02:00
<?php
2023-07-03 17:59:42 +02:00
namespace Activitypub\Transformer;
use WP_Post;
2023-07-03 19:25:49 +02:00
use Activitypub\Collection\Users;
2023-07-10 15:14:37 +02:00
use Activitypub\Model\Blog_User;
2023-07-03 19:25:49 +02:00
use Activitypub\Activity\Base_Object;
2023-07-10 10:57:06 +02:00
use function Activitypub\is_single_user;
2023-05-12 22:31:53 +02:00
use function Activitypub\get_rest_url_by_path;
2018-09-30 22:51:22 +02:00
/**
2023-07-03 17:59:42 +02:00
* WordPress Post Transformer
*
* The Post Transformer is responsible for transforming a WP_Post object into different othe
* Object-Types.
*
* Currently supported are:
2018-09-30 22:51:22 +02:00
*
2023-07-03 17:59:42 +02:00
* - Activitypub\Activity\Base_Object
2018-09-30 22:51:22 +02:00
*/
class Post {
/**
2023-07-03 17:59:42 +02:00
* The WP_Post object.
*
2023-07-03 17:59:42 +02:00
* @var WP_Post
*/
2023-07-03 17:59:42 +02:00
protected $wp_post;
/**
* The Allowed Tags, used in the content.
*
* @var array
*/
2023-07-03 17:59:42 +02:00
protected $allowed_tags = array(
'a' => array(
'href' => array(),
'title' => array(),
'class' => array(),
'rel' => array(),
),
'br' => array(),
'p' => array(
'class' => array(),
),
'span' => array(
'class' => array(),
),
'div' => array(
'class' => array(),
),
2023-03-03 08:56:15 +01:00
'ul' => array(),
2023-05-23 12:28:57 +02:00
'ol' => array(
'reversed' => array(),
'start' => array(),
),
'li' => array(
'value' => array(),
),
2023-03-03 08:56:15 +01:00
'strong' => array(
'class' => array(),
),
'b' => array(
'class' => array(),
),
'i' => array(
'class' => array(),
),
'em' => array(
'class' => array(),
),
'blockquote' => array(),
'cite' => array(),
2023-05-05 14:40:17 +02:00
'code' => array(
'class' => array(),
),
'pre' => array(
'class' => array(),
),
);
2023-02-02 07:24:27 +01:00
/**
2023-07-03 17:59:42 +02:00
* Static function to Transform a WP_Post Object.
2023-02-02 07:24:27 +01:00
*
2023-07-03 17:59:42 +02:00
* This helps to chain the output of the Transformer.
2023-02-02 07:24:27 +01:00
*
2023-07-03 17:59:42 +02:00
* @param WP_Post $wp_post The WP_Post object
*
2023-07-03 17:59:42 +02:00
* @return void
*/
2023-07-03 17:59:42 +02:00
public static function transform( WP_Post $wp_post ) {
2023-07-05 15:33:16 +02:00
return new static( $wp_post );
}
2018-09-30 22:51:22 +02:00
/**
*
*
2023-07-03 17:59:42 +02:00
* @param WP_Post $wp_post
*/
2023-07-03 17:59:42 +02:00
public function __construct( WP_Post $wp_post ) {
$this->wp_post = $wp_post;
}
2018-09-30 22:51:22 +02:00
/**
2023-07-03 17:59:42 +02:00
* Transforms the WP_Post object to an ActivityPub Object
*
2023-07-03 17:59:42 +02:00
* @see \Activitypub\Activity\Base_Object
*
2023-07-03 17:59:42 +02:00
* @return \Activitypub\Activity\Base_Object The ActivityPub Object
*/
2023-07-03 17:59:42 +02:00
public function to_object() {
$wp_post = $this->wp_post;
$object = new Base_Object();
$object->set_id( \esc_url( \get_permalink( $wp_post->ID ) ) );
$object->set_url( \esc_url( \get_permalink( $wp_post->ID ) ) );
$object->set_type( $this->get_object_type() );
2023-07-11 14:48:49 +02:00
$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 ) );
}
2023-07-10 10:57:06 +02:00
$object->set_attributed_to( $this->get_attributed_to() );
2023-07-03 17:59:42 +02:00
$object->set_content( $this->get_content() );
$object->set_content_map(
array(
\strstr( \get_locale(), '_', true ) => $this->get_content(),
2023-07-03 17:59:42 +02:00
)
2018-09-30 22:51:22 +02:00
);
2023-07-03 17:59:42 +02:00
$path = sprintf( 'users/%d/followers', intval( $wp_post->post_author ) );
2018-09-30 22:51:22 +02:00
2023-07-03 17:59:42 +02:00
$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() );
2023-04-23 22:56:45 +02:00
2023-07-03 17:59:42 +02:00
return $object;
2023-04-23 22:56:45 +02:00
}
2023-07-10 10:57:06 +02:00
/**
* 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();
}
2023-07-10 11:49:43 +02:00
return Users::get_by_id( $this->wp_post->post_author )->get_url();
2023-07-10 10:57:06 +02:00
}
/**
2023-07-03 17:59:42 +02:00
* Generates all Image Attachments for a Post.
*
2023-07-03 17:59:42 +02:00
* @return array The Image Attachments.
*/
2023-07-03 17:59:42 +02:00
protected function get_attachments() {
$max_images = intval( \apply_filters( 'activitypub_max_image_attachments', \get_option( 'activitypub_max_image_attachments', ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS ) ) );
$images = array();
// max images can't be negative or zero
if ( $max_images <= 0 ) {
return $images;
}
2023-07-03 17:59:42 +02:00
$id = $this->wp_post->ID;
$image_ids = array();
2023-01-12 22:21:48 +01:00
// list post thumbnail first if this post has one
2019-09-27 10:12:59 +02:00
if ( \function_exists( 'has_post_thumbnail' ) && \has_post_thumbnail( $id ) ) {
$image_ids[] = \get_post_thumbnail_id( $id );
$max_images--;
}
2023-01-12 22:21:48 +01:00
if ( $max_images > 0 ) {
// then list any image attachments
$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;
}
}
}
2019-09-27 11:37:15 +02:00
$image_ids = \array_unique( $image_ids );
// get URLs for each image
foreach ( $image_ids as $id ) {
$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',
$this->get_image( $id, $image_size ),
$id,
$image_size
);
if ( $thumbnail ) {
$mimetype = \get_post_mime_type( $id );
$alt = \get_post_meta( $id, '_wp_attachment_image_alt', true );
$image = array(
'type' => 'Image',
'url' => $thumbnail[0],
2020-05-14 21:37:59 +02:00
'mediaType' => $mimetype,
);
if ( $alt ) {
$image['name'] = $alt;
}
$images[] = $image;
}
}
$this->attachments = $images;
return $images;
}
/**
* 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.
*/
2023-07-03 17:59:42 +02:00
protected 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 );
$thumbnail = \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_pre', $id, $image_size );
return $thumbnail;
}
/**
2023-07-03 17:59:42 +02:00
* Returns the ActivityStreams 2.0 Object-Type for a Post based on the
* settings and the Post-Type.
*
2023-07-03 17:59:42 +02:00
* @see https://www.w3.org/TR/activitystreams-vocabulary/#activity-types
2018-09-30 22:51:22 +02:00
*
2023-07-03 17:59:42 +02:00
* @return string The Object-Type.
2018-09-30 22:51:22 +02:00
*/
2023-07-03 17:59:42 +02:00
protected function get_object_type() {
2019-09-27 10:12:59 +02:00
if ( 'wordpress-post-format' !== \get_option( 'activitypub_object_type', 'note' ) ) {
return \ucfirst( \get_option( 'activitypub_object_type', 'note' ) );
2018-12-28 22:40:57 +01:00
}
2023-07-03 17:59:42 +02:00
$post_type = \get_post_type( $this->wp_post );
2018-09-30 22:51:22 +02:00
switch ( $post_type ) {
case 'post':
2023-07-03 17:59:42 +02:00
$post_format = \get_post_format( $this->wp_post );
2018-09-30 22:51:22 +02:00
switch ( $post_format ) {
case 'aside':
case 'status':
case 'quote':
case 'note':
$object_type = 'Note';
break;
case 'gallery':
case 'image':
$object_type = 'Image';
break;
case 'video':
$object_type = 'Video';
break;
case 'audio':
$object_type = 'Audio';
break;
default:
$object_type = 'Article';
break;
}
break;
case 'page':
$object_type = 'Page';
break;
case 'attachment':
2019-09-27 10:12:59 +02:00
$mime_type = \get_post_mime_type();
$media_type = \preg_replace( '/(\/[a-zA-Z]+)/i', '', $mime_type );
2018-09-30 22:51:22 +02:00
switch ( $media_type ) {
case 'audio':
$object_type = 'Audio';
break;
case 'video':
$object_type = 'Video';
break;
case 'image':
$object_type = 'Image';
break;
}
break;
default:
$object_type = 'Article';
break;
}
return $object_type;
}
/**
2023-07-03 17:59:42 +02:00
* Returns a list of Mentions, used in the Post.
*
* @see https://docs.joinmastodon.org/spec/activitypub/#Mention
*
2023-07-03 17:59:42 +02:00
* @return array The list of Mentions.
*/
2023-07-03 17:59:42 +02:00
protected function get_cc() {
$cc = array();
2023-02-02 08:18:10 +01:00
2023-07-03 17:59:42 +02:00
$mentions = $this->get_mentions();
if ( $mentions ) {
foreach ( $mentions as $mention => $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_attr( $post_tag->slug ),
);
$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;
}
}
2023-07-03 17:59:42 +02:00
return $tags;
}
/**
* 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;
2023-02-02 08:18:10 +01:00
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
2023-07-03 17:59:42 +02:00
$post = $this->wp_post;
$content = $this->get_post_content_template();
// Fill in the shortcodes.
setup_postdata( $post );
$content = do_shortcode( $content );
wp_reset_postdata();
$content = \wp_kses( $content, $this->allowed_tags );
$content = \wpautop( $content );
$content = \preg_replace( '/[\n\r\t]/', '', $content );
$content = \trim( $content );
2023-02-20 18:17:02 +01:00
$content = \apply_filters( 'activitypub_the_content', $content, $post );
$content = \html_entity_decode( $content, \ENT_QUOTES, 'UTF-8' );
return $content;
}
/**
* Gets the template to use to generate the content of the activitypub item.
*
2023-07-03 17:59:42 +02:00
* @return string The Template.
*/
2023-07-03 17:59:42 +02:00
protected function get_post_content_template() {
if ( 'excerpt' === \get_option( 'activitypub_post_content_type', 'content' ) ) {
2023-02-08 10:06:22 +01:00
return "[ap_excerpt]\n\n[ap_permalink type=\"html\"]";
}
if ( 'title' === \get_option( 'activitypub_post_content_type', 'content' ) ) {
2023-02-08 10:06:22 +01:00
return "[ap_title]\n\n[ap_permalink type=\"html\"]";
2019-02-02 23:56:05 +01:00
}
if ( 'content' === \get_option( 'activitypub_post_content_type', 'content' ) ) {
2023-02-08 10:06:22 +01:00
return "[ap_content]\n\n[ap_hashtags]\n\n[ap_permalink type=\"html\"]";
}
2023-05-15 10:55:07 +02:00
return \get_option( 'activitypub_custom_post_content', ACTIVITYPUB_CUSTOM_POST_CONTENT );
2019-02-02 23:56:05 +01:00
}
2023-07-03 17:59:42 +02:00
/**
* 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 );
}
2018-09-30 22:51:22 +02:00
}