mirror of
https://github.com/Automattic/wordpress-activitypub
synced 2024-10-18 16:23:34 +00:00
00a57c39a4
* PHPCS: Enable Commenting sniff * Apply suggestions from code review Co-authored-by: Matthias Pfefferle <pfefferle@users.noreply.github.com> * Fix param alignment. --------- Co-authored-by: Matthias Pfefferle <pfefferle@users.noreply.github.com>
533 lines
10 KiB
PHP
533 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* Blog model file.
|
|
*
|
|
* @package Activitypub
|
|
*/
|
|
|
|
namespace Activitypub\Model;
|
|
|
|
use WP_Query;
|
|
|
|
use Activitypub\Signature;
|
|
use Activitypub\Activity\Actor;
|
|
use Activitypub\Collection\Users;
|
|
use Activitypub\Collection\Extra_Fields;
|
|
|
|
use function Activitypub\esc_hashtag;
|
|
use function Activitypub\is_single_user;
|
|
use function Activitypub\is_blog_public;
|
|
use function Activitypub\get_rest_url_by_path;
|
|
|
|
/**
|
|
* Blog class.
|
|
*/
|
|
class Blog extends Actor {
|
|
/**
|
|
* The Featured-Posts.
|
|
*
|
|
* @see https://docs.joinmastodon.org/spec/activitypub/#featured
|
|
*
|
|
* @context {
|
|
* "@id": "http://joinmastodon.org/ns#featured",
|
|
* "@type": "@id"
|
|
* }
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $featured;
|
|
|
|
/**
|
|
* Moderators endpoint.
|
|
*
|
|
* @see https://join-lemmy.org/docs/contributors/05-federation.html
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $moderators;
|
|
|
|
/**
|
|
* The User-ID
|
|
*
|
|
* @var int
|
|
*/
|
|
protected $_id = Users::BLOG_USER_ID; // phpcs:ignore PSR2.Classes.PropertyDeclaration.Underscore
|
|
|
|
/**
|
|
* If the User is indexable.
|
|
*
|
|
* @context http://joinmastodon.org/ns#indexable
|
|
*
|
|
* @var boolean
|
|
*/
|
|
protected $indexable;
|
|
|
|
/**
|
|
* The WebFinger Resource.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $webfinger;
|
|
|
|
/**
|
|
* Whether the User is discoverable.
|
|
*
|
|
* @see https://docs.joinmastodon.org/spec/activitypub/#discoverable
|
|
*
|
|
* @context http://joinmastodon.org/ns#discoverable
|
|
*
|
|
* @var boolean
|
|
*/
|
|
protected $discoverable;
|
|
|
|
/**
|
|
* Restrict posting to mods.
|
|
*
|
|
* @see https://join-lemmy.org/docs/contributors/05-federation.html
|
|
*
|
|
* @var boolean
|
|
*/
|
|
protected $posting_restricted_to_mods;
|
|
|
|
/**
|
|
* Whether the User manually approves followers.
|
|
*
|
|
* @return false
|
|
*/
|
|
public function get_manually_approves_followers() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Whether the User is discoverable.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function get_discoverable() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get the User ID.
|
|
*
|
|
* @return string The User ID.
|
|
*/
|
|
public function get_id() {
|
|
return $this->get_url();
|
|
}
|
|
|
|
/**
|
|
* Get the type of the object.
|
|
*
|
|
* If the Blog is in "single user" mode, return "Person" insted of "Group".
|
|
*
|
|
* @return string The type of the object.
|
|
*/
|
|
public function get_type() {
|
|
if ( is_single_user() ) {
|
|
return 'Person';
|
|
} else {
|
|
return 'Group';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the Username.
|
|
*
|
|
* @return string The Username.
|
|
*/
|
|
public function get_name() {
|
|
return \wp_strip_all_tags(
|
|
\html_entity_decode(
|
|
\get_bloginfo( 'name' ),
|
|
\ENT_QUOTES,
|
|
'UTF-8'
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get the User description.
|
|
*
|
|
* @return string The User description.
|
|
*/
|
|
public function get_summary() {
|
|
$summary = \get_option( 'activitypub_blog_description', null );
|
|
|
|
if ( ! $summary ) {
|
|
$summary = \get_bloginfo( 'description' );
|
|
}
|
|
|
|
return \wpautop(
|
|
\wp_kses(
|
|
$summary,
|
|
'default'
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get the User url.
|
|
*
|
|
* @return string The User url.
|
|
*/
|
|
public function get_url() {
|
|
return \esc_url( \trailingslashit( get_home_url() ) . '@' . $this->get_preferred_username() );
|
|
}
|
|
|
|
/**
|
|
* Get blog's homepage URL.
|
|
*
|
|
* @return string The User-Url.
|
|
*/
|
|
public function get_alternate_url() {
|
|
return \esc_url( \trailingslashit( get_home_url() ) );
|
|
}
|
|
|
|
/**
|
|
* Generate a default Username.
|
|
*
|
|
* @return string The auto-generated Username.
|
|
*/
|
|
public static function get_default_username() {
|
|
// Check if domain host has a subdomain.
|
|
$host = \wp_parse_url( \get_home_url(), \PHP_URL_HOST );
|
|
$host = \preg_replace( '/^www\./i', '', $host );
|
|
|
|
/**
|
|
* Filters the default blog username.
|
|
*
|
|
* @param string $host The default username.
|
|
*/
|
|
return apply_filters( 'activitypub_default_blog_username', $host );
|
|
}
|
|
|
|
/**
|
|
* Get the preferred Username.
|
|
*
|
|
* @return string The Username.
|
|
*/
|
|
public function get_preferred_username() {
|
|
$username = \get_option( 'activitypub_blog_identifier' );
|
|
|
|
if ( $username ) {
|
|
return $username;
|
|
}
|
|
|
|
return self::get_default_username();
|
|
}
|
|
|
|
/**
|
|
* Get the User icon.
|
|
*
|
|
* @return array The User icon.
|
|
*/
|
|
public function get_icon() {
|
|
// Try site_logo, falling back to site_icon, first.
|
|
$icon_id = get_option( 'site_icon' );
|
|
|
|
// Try custom logo second.
|
|
if ( ! $icon_id ) {
|
|
$icon_id = get_theme_mod( 'custom_logo' );
|
|
}
|
|
|
|
$icon_url = false;
|
|
|
|
if ( $icon_id ) {
|
|
$icon = wp_get_attachment_image_src( $icon_id, 'full' );
|
|
if ( $icon ) {
|
|
$icon_url = $icon[0];
|
|
}
|
|
}
|
|
|
|
if ( ! $icon_url ) {
|
|
// Fallback to default icon.
|
|
$icon_url = plugins_url( '/assets/img/wp-logo.png', ACTIVITYPUB_PLUGIN_FILE );
|
|
}
|
|
|
|
return array(
|
|
'type' => 'Image',
|
|
'url' => esc_url( $icon_url ),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get the User-Header-Image.
|
|
*
|
|
* @return array|null The User-Header-Image.
|
|
*/
|
|
public function get_image() {
|
|
$header_image = get_option( 'activitypub_header_image' );
|
|
$image_url = null;
|
|
|
|
if ( $header_image ) {
|
|
$image_url = \wp_get_attachment_url( $header_image );
|
|
}
|
|
|
|
if ( ! $image_url && \has_header_image() ) {
|
|
$image_url = \get_header_image();
|
|
}
|
|
|
|
if ( $image_url ) {
|
|
return array(
|
|
'type' => 'Image',
|
|
'url' => esc_url( $image_url ),
|
|
);
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the published date.
|
|
*
|
|
* @return string The published date.
|
|
*/
|
|
public function get_published() {
|
|
$first_post = new WP_Query(
|
|
array(
|
|
'orderby' => 'date',
|
|
'order' => 'ASC',
|
|
'number' => 1,
|
|
)
|
|
);
|
|
|
|
if ( ! empty( $first_post->posts[0] ) ) {
|
|
$time = \strtotime( $first_post->posts[0]->post_date_gmt );
|
|
} else {
|
|
$time = \time();
|
|
}
|
|
|
|
return \gmdate( 'Y-m-d\TH:i:s\Z', $time );
|
|
}
|
|
|
|
/**
|
|
* Get the canonical URL.
|
|
*
|
|
* @return string|null The canonical URL.
|
|
*/
|
|
public function get_canonical_url() {
|
|
return \home_url();
|
|
}
|
|
|
|
/**
|
|
* Get the Moderators endpoint.
|
|
*
|
|
* @return string|null The Moderators endpoint.
|
|
*/
|
|
public function get_moderators() {
|
|
if ( is_single_user() || 'Group' !== $this->get_type() ) {
|
|
return null;
|
|
}
|
|
|
|
return get_rest_url_by_path( 'collections/moderators' );
|
|
}
|
|
|
|
/**
|
|
* Get attributedTo value.
|
|
*
|
|
* @return string|null The attributedTo value.
|
|
*/
|
|
public function get_attributed_to() {
|
|
if ( is_single_user() || 'Group' !== $this->get_type() ) {
|
|
return null;
|
|
}
|
|
|
|
return get_rest_url_by_path( 'collections/moderators' );
|
|
}
|
|
|
|
/**
|
|
* Get the public key information.
|
|
*
|
|
* @return array The public key.
|
|
*/
|
|
public function get_public_key() {
|
|
return array(
|
|
'id' => $this->get_id() . '#main-key',
|
|
'owner' => $this->get_id(),
|
|
'publicKeyPem' => Signature::get_public_key_for( $this->get__id() ),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns whether posting is restricted to mods.
|
|
*
|
|
* @return bool|null True if posting is restricted to mods, null if not applicable.
|
|
*/
|
|
public function get_posting_restricted_to_mods() {
|
|
if ( 'Group' === $this->get_type() ) {
|
|
return true;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns the Inbox-API-Endpoint.
|
|
*
|
|
* @return string The Inbox-Endpoint.
|
|
*/
|
|
public function get_inbox() {
|
|
return get_rest_url_by_path( sprintf( 'actors/%d/inbox', $this->get__id() ) );
|
|
}
|
|
|
|
/**
|
|
* Returns the Outbox-API-Endpoint.
|
|
*
|
|
* @return string The Outbox-Endpoint.
|
|
*/
|
|
public function get_outbox() {
|
|
return get_rest_url_by_path( sprintf( 'actors/%d/outbox', $this->get__id() ) );
|
|
}
|
|
|
|
/**
|
|
* Returns the Followers-API-Endpoint.
|
|
*
|
|
* @return string The Followers-Endpoint.
|
|
*/
|
|
public function get_followers() {
|
|
return get_rest_url_by_path( sprintf( 'actors/%d/followers', $this->get__id() ) );
|
|
}
|
|
|
|
/**
|
|
* Returns the Following-API-Endpoint.
|
|
*
|
|
* @return string The Following-Endpoint.
|
|
*/
|
|
public function get_following() {
|
|
return get_rest_url_by_path( sprintf( 'actors/%d/following', $this->get__id() ) );
|
|
}
|
|
|
|
/**
|
|
* Returns endpoints.
|
|
*
|
|
* @return array|null The endpoints.
|
|
*/
|
|
public function get_endpoints() {
|
|
$endpoints = null;
|
|
|
|
if ( ACTIVITYPUB_SHARED_INBOX_FEATURE ) {
|
|
$endpoints = array(
|
|
'sharedInbox' => get_rest_url_by_path( 'inbox' ),
|
|
);
|
|
}
|
|
|
|
return $endpoints;
|
|
}
|
|
|
|
/**
|
|
* Returns a user@domain type of identifier for the user.
|
|
*
|
|
* @return string The Webfinger-Identifier.
|
|
*/
|
|
public function get_webfinger() {
|
|
return $this->get_preferred_username() . '@' . \wp_parse_url( \home_url(), \PHP_URL_HOST );
|
|
}
|
|
|
|
/**
|
|
* Returns the Featured-API-Endpoint.
|
|
*
|
|
* @return string The Featured-Endpoint.
|
|
*/
|
|
public function get_featured() {
|
|
return get_rest_url_by_path( sprintf( 'actors/%d/collections/featured', $this->get__id() ) );
|
|
}
|
|
|
|
/**
|
|
* Returns whether the site is indexable.
|
|
*
|
|
* @return bool Whether the site is indexable.
|
|
*/
|
|
public function get_indexable() {
|
|
if ( is_blog_public() ) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Update the Username.
|
|
*
|
|
* @param mixed $value The new value.
|
|
* @return bool True if the attribute was updated, false otherwise.
|
|
*/
|
|
public function update_name( $value ) {
|
|
return \update_option( 'blogname', $value );
|
|
}
|
|
|
|
/**
|
|
* Update the User description.
|
|
*
|
|
* @param mixed $value The new value.
|
|
* @return bool True if the attribute was updated, false otherwise.
|
|
*/
|
|
public function update_summary( $value ) {
|
|
return \update_option( 'blogdescription', $value );
|
|
}
|
|
|
|
/**
|
|
* Update the User icon.
|
|
*
|
|
* @param mixed $value The new value.
|
|
* @return bool True if the attribute was updated, false otherwise.
|
|
*/
|
|
public function update_icon( $value ) {
|
|
if ( ! wp_attachment_is_image( $value ) ) {
|
|
return false;
|
|
}
|
|
return \update_option( 'site_icon', $value );
|
|
}
|
|
|
|
/**
|
|
* Update the User-Header-Image.
|
|
*
|
|
* @param mixed $value The new value.
|
|
* @return bool True if the attribute was updated, false otherwise.
|
|
*/
|
|
public function update_header( $value ) {
|
|
if ( ! wp_attachment_is_image( $value ) ) {
|
|
return false;
|
|
}
|
|
return \update_option( 'activitypub_header_image', $value );
|
|
}
|
|
|
|
/**
|
|
* Get the User - Hashtags.
|
|
*
|
|
* @see https://docs.joinmastodon.org/spec/activitypub/#Hashtag
|
|
*
|
|
* @return array The User - Hashtags.
|
|
*/
|
|
public function get_tag() {
|
|
$hashtags = array();
|
|
|
|
$args = array(
|
|
'orderby' => 'count',
|
|
'order' => 'DESC',
|
|
'number' => 10,
|
|
);
|
|
|
|
$tags = get_tags( $args );
|
|
|
|
foreach ( $tags as $tag ) {
|
|
$hashtags[] = array(
|
|
'type' => 'Hashtag',
|
|
'href' => \get_tag_link( $tag->term_id ),
|
|
'name' => esc_hashtag( $tag->name ),
|
|
);
|
|
}
|
|
|
|
return $hashtags;
|
|
}
|
|
|
|
/**
|
|
* Extend the User-Output with Attachments.
|
|
*
|
|
* @return array The extended User-Output.
|
|
*/
|
|
public function get_attachment() {
|
|
$extra_fields = Extra_Fields::get_actor_fields( $this->_id );
|
|
return Extra_Fields::fields_to_attachments( $extra_fields );
|
|
}
|
|
}
|