352 lines
8.4 KiB
PHP
352 lines
8.4 KiB
PHP
<?php
|
|
/**
|
|
* Query class.
|
|
*
|
|
* @package Activitypub
|
|
*/
|
|
|
|
namespace Activitypub;
|
|
|
|
use Activitypub\Collection\Actors;
|
|
use Activitypub\Collection\Outbox;
|
|
use Activitypub\Transformer\Factory;
|
|
|
|
/**
|
|
* Singleton class to handle and store the ActivityPub query.
|
|
*/
|
|
class Query {
|
|
|
|
/**
|
|
* The singleton instance.
|
|
*
|
|
* @var Query
|
|
*/
|
|
private static $instance;
|
|
|
|
/**
|
|
* The ActivityPub object.
|
|
*
|
|
* @link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object
|
|
*
|
|
* @var object
|
|
*/
|
|
private $activitypub_object;
|
|
|
|
/**
|
|
* The ActivityPub object ID.
|
|
*
|
|
* @link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-id
|
|
*
|
|
* @var string
|
|
*/
|
|
private $activitypub_object_id;
|
|
|
|
/**
|
|
* Whether the current request is an ActivityPub request.
|
|
*
|
|
* @var bool
|
|
*/
|
|
private $is_activitypub_request;
|
|
|
|
/**
|
|
* Whether the current request is from the old host.
|
|
*
|
|
* @var bool
|
|
*/
|
|
private $is_old_host_request;
|
|
|
|
/**
|
|
* The constructor.
|
|
*/
|
|
private function __construct() {
|
|
// Do nothing.
|
|
}
|
|
|
|
/**
|
|
* The destructor.
|
|
*/
|
|
public function __destruct() {
|
|
self::$instance = null;
|
|
}
|
|
|
|
/**
|
|
* Get the singleton instance.
|
|
*
|
|
* @return Query The singleton instance.
|
|
*/
|
|
public static function get_instance() {
|
|
if ( ! isset( self::$instance ) ) {
|
|
self::$instance = new self();
|
|
}
|
|
|
|
return self::$instance;
|
|
}
|
|
|
|
/**
|
|
* Get the ActivityPub object.
|
|
*
|
|
* @return object The ActivityPub object.
|
|
*/
|
|
public function get_activitypub_object() {
|
|
if ( $this->activitypub_object ) {
|
|
return $this->activitypub_object;
|
|
}
|
|
|
|
if ( $this->prepare_activitypub_data() ) {
|
|
return $this->activitypub_object;
|
|
}
|
|
|
|
$queried_object = $this->get_queried_object();
|
|
$transformer = Factory::get_transformer( $queried_object );
|
|
|
|
if ( $transformer && ! \is_wp_error( $transformer ) ) {
|
|
$this->activitypub_object = $transformer->to_object();
|
|
}
|
|
|
|
return $this->activitypub_object;
|
|
}
|
|
|
|
/**
|
|
* Get the ActivityPub object ID.
|
|
*
|
|
* @return string The ActivityPub object ID.
|
|
*/
|
|
public function get_activitypub_object_id() {
|
|
if ( $this->activitypub_object_id ) {
|
|
return $this->activitypub_object_id;
|
|
}
|
|
|
|
if ( $this->prepare_activitypub_data() ) {
|
|
return $this->activitypub_object_id;
|
|
}
|
|
|
|
$queried_object = $this->get_queried_object();
|
|
$transformer = Factory::get_transformer( $queried_object );
|
|
|
|
if ( $transformer && ! \is_wp_error( $transformer ) ) {
|
|
$this->activitypub_object_id = $transformer->to_id();
|
|
}
|
|
|
|
return $this->activitypub_object_id;
|
|
}
|
|
|
|
/**
|
|
* Prepare and set both ActivityPub object and ID for Outbox activities and virtual objects.
|
|
*
|
|
* @return bool True if an object was found and set, false otherwise.
|
|
*/
|
|
private function prepare_activitypub_data() {
|
|
$queried_object = $this->get_queried_object();
|
|
|
|
// Check for Outbox Activity.
|
|
if (
|
|
$queried_object instanceof \WP_Post &&
|
|
Outbox::POST_TYPE === $queried_object->post_type
|
|
) {
|
|
$activitypub_object = Outbox::maybe_get_activity( $queried_object );
|
|
|
|
// Check if the Outbox Activity is public.
|
|
if ( ! \is_wp_error( $activitypub_object ) ) {
|
|
$this->activitypub_object = $activitypub_object;
|
|
$this->activitypub_object_id = $this->activitypub_object->get_id();
|
|
return true;
|
|
}
|
|
}
|
|
|
|
if ( ! $queried_object ) {
|
|
// If the object is not a valid ActivityPub object, try to get a virtual object.
|
|
$activitypub_object = $this->maybe_get_virtual_object();
|
|
|
|
if ( $activitypub_object ) {
|
|
$this->activitypub_object = $activitypub_object;
|
|
$this->activitypub_object_id = $this->activitypub_object->get_id();
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get the queried object.
|
|
*
|
|
* This adds support for Comments by `?c=123` IDs and Users by `?author=123` and `@username` IDs.
|
|
*
|
|
* @return \WP_Term|\WP_Post_Type|\WP_Post|\WP_User|\WP_Comment|null The queried object.
|
|
*/
|
|
public function get_queried_object() {
|
|
$queried_object = \get_queried_object();
|
|
|
|
// Check Comment by ID.
|
|
if ( ! $queried_object ) {
|
|
$comment_id = \get_query_var( 'c' );
|
|
if ( $comment_id ) {
|
|
$queried_object = \get_comment( $comment_id );
|
|
}
|
|
}
|
|
|
|
// Check Post by ID (works for custom post types).
|
|
if ( ! $queried_object ) {
|
|
$post_id = \get_query_var( 'p' );
|
|
if ( $post_id ) {
|
|
$queried_object = \get_post( $post_id );
|
|
}
|
|
}
|
|
|
|
// Try to get Author by ID.
|
|
if ( ! $queried_object ) {
|
|
$url = $this->get_request_url();
|
|
$author_id = url_to_authorid( $url );
|
|
if ( $author_id ) {
|
|
$queried_object = \get_user_by( 'id', $author_id );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Filters the queried object.
|
|
*
|
|
* @param \WP_Term|\WP_Post_Type|\WP_Post|\WP_User|\WP_Comment|null $queried_object The queried object.
|
|
*/
|
|
return apply_filters( 'activitypub_queried_object', $queried_object );
|
|
}
|
|
|
|
/**
|
|
* Get the virtual object.
|
|
*
|
|
* Virtual objects are objects that are not stored in the database, but are created on the fly.
|
|
* The plugins currently supports two virtual objects: The Blog-Actor and the Application-Actor.
|
|
*
|
|
* @see \Activitypub\Model\Blog
|
|
* @see \Activitypub\Model\Application
|
|
*
|
|
* @return object|null The virtual object.
|
|
*/
|
|
protected function maybe_get_virtual_object() {
|
|
$url = $this->get_request_url();
|
|
|
|
if ( ! $url ) {
|
|
return null;
|
|
}
|
|
|
|
$author_id = url_to_authorid( $url );
|
|
|
|
if ( ! is_numeric( $author_id ) ) {
|
|
$author_id = $url;
|
|
}
|
|
|
|
$user = Actors::get_by_various( $author_id );
|
|
|
|
if ( \is_wp_error( $user ) || ! $user ) {
|
|
return null;
|
|
}
|
|
|
|
return $user;
|
|
}
|
|
|
|
/**
|
|
* Get the request URL.
|
|
*
|
|
* @return string|null The request URL.
|
|
*/
|
|
protected function get_request_url() {
|
|
if ( ! isset( $_SERVER['REQUEST_URI'] ) ) {
|
|
return null;
|
|
}
|
|
|
|
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
|
|
$url = \wp_unslash( $_SERVER['REQUEST_URI'] );
|
|
$url = \WP_Http::make_absolute_url( $url, \home_url() );
|
|
$url = \sanitize_url( $url );
|
|
|
|
return $url;
|
|
}
|
|
|
|
/**
|
|
* Check if the current request is an ActivityPub request.
|
|
*
|
|
* @return bool True if the request is an ActivityPub request, false otherwise.
|
|
*/
|
|
public function is_activitypub_request() {
|
|
if ( isset( $this->is_activitypub_request ) ) {
|
|
return $this->is_activitypub_request;
|
|
}
|
|
|
|
global $wp_query;
|
|
|
|
// One can trigger an ActivityPub request by adding `?activitypub` to the URL.
|
|
if (
|
|
isset( $wp_query->query_vars['activitypub'] ) ||
|
|
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
|
|
isset( $_GET['activitypub'] )
|
|
) {
|
|
\defined( 'ACTIVITYPUB_REQUEST' ) || \define( 'ACTIVITYPUB_REQUEST', true );
|
|
$this->is_activitypub_request = true;
|
|
|
|
return true;
|
|
}
|
|
|
|
/*
|
|
* The other (more common) option to make an ActivityPub request
|
|
* is to send an Accept header.
|
|
*/
|
|
if ( isset( $_SERVER['HTTP_ACCEPT'] ) ) {
|
|
$accept = \sanitize_text_field( \wp_unslash( $_SERVER['HTTP_ACCEPT'] ) );
|
|
|
|
/*
|
|
* $accept can be a single value, or a comma separated list of values.
|
|
* We want to support both scenarios,
|
|
* and return true when the header includes at least one of the following:
|
|
* - application/activity+json
|
|
* - application/ld+json
|
|
* - application/json
|
|
*/
|
|
if ( \preg_match( '/(application\/(ld\+json|activity\+json|json))/i', $accept ) ) {
|
|
\defined( 'ACTIVITYPUB_REQUEST' ) || \define( 'ACTIVITYPUB_REQUEST', true );
|
|
$this->is_activitypub_request = true;
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
$this->is_activitypub_request = false;
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Check if the current request is from the old host.
|
|
*
|
|
* @return bool True if the request is from the old host, false otherwise.
|
|
*/
|
|
public function is_old_host_request() {
|
|
if ( isset( $this->is_old_host_request ) ) {
|
|
return $this->is_old_host_request;
|
|
}
|
|
|
|
$old_host = \get_option( 'activitypub_old_host' );
|
|
|
|
if ( ! $old_host ) {
|
|
$this->is_old_host_request = false;
|
|
return false;
|
|
}
|
|
|
|
$request_host = isset( $_SERVER['HTTP_HOST'] ) ? \sanitize_text_field( \wp_unslash( $_SERVER['HTTP_HOST'] ) ) : '';
|
|
$referer_host = isset( $_SERVER['HTTP_REFERER'] ) ? \wp_parse_url( \sanitize_text_field( \wp_unslash( $_SERVER['HTTP_REFERER'] ) ), PHP_URL_HOST ) : '';
|
|
|
|
// Check if the domain matches either the request domain or referer.
|
|
$check = $old_host === $request_host || $old_host === $referer_host;
|
|
$this->is_old_host_request = $check;
|
|
|
|
return $check;
|
|
}
|
|
|
|
/**
|
|
* Fake an old host request.
|
|
*
|
|
* @param bool $state Optional. The state to set. Default true.
|
|
*/
|
|
public function set_old_host_request( $state = true ) {
|
|
$this->is_old_host_request = $state;
|
|
}
|
|
}
|