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

411 lines
12 KiB
PHP
Raw Normal View History

2018-09-30 22:51:22 +02:00
<?php
2019-11-18 20:57:00 +01:00
namespace Activitypub\Model;
2018-09-30 22:51:22 +02:00
/**
* ActivityPub Post Class
*
* @author Matthias Pfefferle
*/
class Post {
2018-09-30 22:51:22 +02:00
private $post;
2020-05-14 21:37:59 +02:00
private $post_author;
private $id;
2020-05-14 21:37:59 +02:00
private $summary;
private $content;
private $attachments;
private $tags;
2020-05-14 21:37:59 +02:00
private $object_type;
2018-09-30 22:51:22 +02:00
public function __construct( $post = null ) {
2019-09-27 10:12:59 +02:00
$this->post = \get_post( $post );
2018-09-30 22:51:22 +02:00
$this->post_author = $this->post->post_author;
$this->id = $this->generate_id();
2020-05-14 21:37:59 +02:00
$this->summary = $this->generate_the_title();
$this->content = $this->generate_the_content();
$this->attachments = $this->generate_attachments();
$this->tags = $this->generate_tags();
$this->object_type = $this->generate_object_type();
}
2018-09-30 22:51:22 +02:00
2020-05-14 21:37:59 +02:00
public function __call( $method, $params ) {
$var = \strtolower( \substr( $method, 4 ) );
if ( \strncasecmp( $method, 'get', 3 ) === 0 ) {
return $this->$var;
}
if ( \strncasecmp( $method, 'set', 3 ) === 0 ) {
$this->$var = $params[0];
}
}
2018-09-30 22:51:22 +02:00
public function to_array() {
$post = $this->post;
2018-09-30 22:51:22 +02:00
$array = array(
'id' => $this->id,
2020-05-14 21:37:59 +02:00
'type' => $this->object_type,
2022-01-27 13:09:11 +01:00
'published' => \gmdate( 'Y-m-d\TH:i:s\Z', \strtotime( $post->post_date_gmt ) ),
2019-09-27 10:12:59 +02:00
'attributedTo' => \get_author_posts_url( $post->post_author ),
2020-05-14 21:37:59 +02:00
'summary' => $this->summary,
2018-09-30 22:51:22 +02:00
'inReplyTo' => null,
2020-05-14 21:37:59 +02:00
'content' => $this->content,
2018-09-30 22:51:22 +02:00
'contentMap' => array(
2020-05-14 21:37:59 +02:00
\strstr( \get_locale(), '_', true ) => $this->content,
2018-09-30 22:51:22 +02:00
),
'to' => array( 'https://www.w3.org/ns/activitystreams#Public' ),
'cc' => array( 'https://www.w3.org/ns/activitystreams#Public' ),
2020-05-14 21:37:59 +02:00
'attachment' => $this->attachments,
'tag' => $this->tags,
2018-09-30 22:51:22 +02:00
);
2019-09-27 10:12:59 +02:00
return \apply_filters( 'activitypub_post', $array );
}
public function to_json() {
return \wp_json_encode( $this->to_array(), \JSON_HEX_TAG | \JSON_HEX_AMP | \JSON_HEX_QUOT );
}
public function generate_id() {
$post = $this->post;
$permalink = \get_permalink( $post );
2020-05-14 18:02:49 +02:00
// replace 'trashed' for delete activity
return \str_replace( '__trashed', '', $permalink );
}
2020-05-14 21:37:59 +02:00
public function generate_attachments() {
2019-09-27 10:12:59 +02:00
$max_images = \apply_filters( 'activitypub_max_images', 3 );
$images = array();
// max images can't be negative or zero
if ( $max_images <= 0 ) {
$max_images = 1;
}
$id = $this->post->ID;
$image_ids = array();
// 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--;
}
// 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 ) {
2019-09-27 10:12:59 +02:00
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 ) {
$alt = \get_post_meta( $id, '_wp_attachment_image_alt', true );
2019-09-27 10:12:59 +02:00
$thumbnail = \wp_get_attachment_image_src( $id, 'full' );
$mimetype = \get_post_mime_type( $id );
if ( $thumbnail ) {
$image = array(
'type' => 'Image',
'url' => $thumbnail[0],
2020-05-14 21:37:59 +02:00
'mediaType' => $mimetype,
);
if ( $alt ) {
$image['name'] = $alt;
}
$images[] = $image;
}
}
return $images;
}
2020-05-14 21:37:59 +02:00
public function generate_tags() {
$tags = array();
2019-09-27 10:12:59 +02:00
$post_tags = \get_the_tags( $this->post->ID );
if ( $post_tags ) {
2019-03-02 21:10:42 +01:00
foreach ( $post_tags as $post_tag ) {
$tag = array(
'type' => 'Hashtag',
2019-09-27 10:12:59 +02:00
'href' => \get_tag_link( $post_tag->term_id ),
'name' => '#' . $post_tag->slug,
);
$tags[] = $tag;
}
}
return $tags;
2018-09-30 22:51:22 +02:00
}
/**
* Returns the as2 object-type for a given post
*
* @param string $type the object-type
* @param Object $post the post-object
*
* @return string the object-type
*/
2020-05-14 21:37:59 +02:00
public function generate_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
}
2019-09-27 10:12:59 +02:00
$post_type = \get_post_type( $this->post );
2018-09-30 22:51:22 +02:00
switch ( $post_type ) {
case 'post':
2019-09-27 10:12:59 +02:00
$post_format = \get_post_format( $this->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;
}
2020-05-14 21:37:59 +02:00
public function generate_the_content() {
$post = $this->post;
$content = $this->get_post_content_template();
$content = \str_replace( '%title%', \get_the_title( $post->ID ), $content );
$content = \str_replace( '%excerpt%', $this->get_the_post_excerpt(), $content );
$content = \str_replace( '%content%', $this->get_the_post_content(), $content );
$content = \str_replace( '%permalink%', $this->get_the_post_link( 'permalink' ), $content );
$content = \str_replace( '%shortlink%', $this->get_the_post_link( 'shortlink' ), $content );
2020-12-17 18:24:30 +01:00
$content = \str_replace( '%hashtags%', $this->get_the_post_hashtags(), $content );
2020-12-17 22:21:41 +01:00
// backwards compatibility
$content = \str_replace( '%tags%', $this->get_the_post_hashtags(), $content );
$content = \trim( \preg_replace( '/[\r\n]{2,}/', '', $content ) );
$filtered_content = \apply_filters( 'activitypub_the_content', $content, $this->post );
$decoded_content = \html_entity_decode( $filtered_content, \ENT_QUOTES, 'UTF-8' );
$allowed_html = \apply_filters( 'activitypub_allowed_html', \get_option( 'activitypub_allowed_html', ACTIVITYPUB_ALLOWED_HTML ) );
if ( $allowed_html ) {
return \strip_tags( $decoded_content, $allowed_html );
}
return $decoded_content;
}
public function get_post_content_template() {
if ( 'excerpt' === \get_option( 'activitypub_post_content_type', 'content' ) ) {
return "%excerpt%\n\n<p>%permalink%</p>";
}
if ( 'title' === \get_option( 'activitypub_post_content_type', 'content' ) ) {
return "<p><strong>%title%</strong></p>\n\n<p>%permalink%</p>";
2019-02-02 23:56:05 +01:00
}
if ( 'content' === \get_option( 'activitypub_post_content_type', 'content' ) ) {
2020-12-17 22:21:41 +01:00
return "%content%\n\n<p>%hashtags%</p>\n\n<p>%permalink%</p>";
}
return \get_option( 'activitypub_custom_post_content', ACTIVITYPUB_CUSTOM_POST_CONTENT );
2019-02-02 23:56:05 +01:00
}
/**
* Get the excerpt for a post for use outside of the loop.
*
* @param int Optional excerpt length.
*
* @return string The excerpt.
*/
public function get_the_post_excerpt( $excerpt_length = 400 ) {
$post = $this->post;
2019-09-27 10:12:59 +02:00
$excerpt = \get_post_field( 'post_excerpt', $post );
if ( '' === $excerpt ) {
2019-09-27 10:12:59 +02:00
$content = \get_post_field( 'post_content', $post );
// An empty string will make wp_trim_excerpt do stuff we do not want.
if ( '' !== $content ) {
2019-09-27 10:12:59 +02:00
$excerpt = \strip_shortcodes( $content );
/** This filter is documented in wp-includes/post-template.php */
2019-09-27 10:12:59 +02:00
$excerpt = \apply_filters( 'the_content', $excerpt );
$excerpt = \str_replace( ']]>', ']]>', $excerpt );
}
}
// Strip out any remaining tags.
$excerpt = \wp_strip_all_tags( $excerpt );
/** This filter is documented in wp-includes/formatting.php */
$excerpt_more = \apply_filters( 'excerpt_more', ' [...]' );
$excerpt_more_len = strlen( $excerpt_more );
// We now have a excerpt, but we need to check it's length, it may be longer than we want for two reasons:
//
// * The user has entered a manual excerpt which is longer that what we want.
// * No manual excerpt exists so we've used the content which might be longer than we want.
//
// Either way, let's trim it up if we need too. Also, don't forget to take into account the more indicator
// as part of the total length.
//
// Setup a variable to hold the current excerpts length.
$current_excerpt_length = strlen( $excerpt );
// Setup a variable to keep track of our target length.
$target_excerpt_length = $current_excerpt_length - $excerpt_more_len;
// Setup a variable to keep track of the current max length.
$current_expcerpt_max = $target_excerpt_length;
// This is a loop since we can't calculate word break the string after 'the_excpert' filter has run (we would break
// all kinds of html tags), so we have to cut the excerpt down a bit at a time until we hit our target length.
while( $current_excerpt_length > $target_excerpt_length && $current_expcerpt_max > 0 ) {
// Trim the excerpt based on wordwrap() positioning.
// Note: we're using <br> as the linebreak just in case there are any newlines existing in the excerpt from the user.
// There won't be any <br> left after we've run wp_strip_all_tags() in the code above, so they're
// safe to use here. It won't be included in the final excerpt as the substr() will trim it off.
$excerpt = substr( $excerpt, 0, strpos( wordwrap( $excerpt, $current_expcerpt_max, '<br>' ), '<br>' ) );
// If something went wrong, or we're in a language that wordwrap() doesn't understand,
// just chop it off and don't worry about breaking in the middle of a word.
if( strlen( $excerpt ) > $excerpt_length - $excerpt_more_len ) {
$excerpt = substr( $excerpt, 0, $current_expcerpt_max );
}
// Add in the more indicator.
$excerpt = $excerpt . $excerpt_more;
// Run it through the excerpt filter which will add some html tags back in.
$excerpt_filtered = apply_filters( 'the_excerpt', $excerpt );
// Now set the current excerpt length to this new filtered length.
$current_excerpt_length = strlen( $excerpt_filtered );
// Check to see if we're over the target length.
if( $current_excerpt_length > $target_excerpt_length ) {
// If so, remove 20 characters from the current max and run the loop again.
$current_expcerpt_max = $current_expcerpt_max - 20;
}
}
return \apply_filters( 'the_excerpt', $excerpt );
}
/**
* Get the content for a post for use outside of the loop.
*
* @return string The content.
*/
public function get_the_post_content() {
$post = $this->post;
2019-09-27 10:12:59 +02:00
$content = \get_post_field( 'post_content', $post );
return \apply_filters( 'the_content', $content );
2019-02-02 23:56:05 +01:00
}
/**
* Adds a backlink to the post/summary content
2019-02-02 23:56:05 +01:00
*
* @param string $content
* @param WP_Post $post
2019-02-02 23:56:05 +01:00
*
* @return string
2019-02-02 23:56:05 +01:00
*/
public function get_the_post_link( $type = 'permalink' ) {
$post = $this->post;
if ( 'shortlink' === $type ) {
$link = \esc_url( \wp_get_shortlink( $post->ID ) );
} elseif ( 'permalink' === $type ) {
$link = \esc_url( \get_permalink( $post->ID ) );
} else {
return '';
}
return \sprintf( '<a href="%1$s">%1$s</a>', $link );
2019-02-02 23:56:05 +01:00
}
2019-03-02 21:10:42 +01:00
/**
* Adds all tags as hashtags to the post/summary content
2019-03-02 21:10:42 +01:00
*
* @param string $content
* @param WP_Post $post
*
* @return string
*/
public function get_the_post_hashtags() {
$post = $this->post;
$tags = \get_the_tags( $post->ID );
2019-02-02 23:56:05 +01:00
if ( ! $tags ) {
return '';
}
$hash_tags = array();
foreach ( $tags as $tag ) {
$hash_tags[] = \sprintf( '<a rel="tag" class="u-tag u-category" href="%s">#%s</a>', \get_tag_link( $tag ), $tag->slug );
2019-02-02 23:56:05 +01:00
}
return \implode( ' ', $hash_tags );
}
2018-09-30 22:51:22 +02:00
}