-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce Query Singleton, to store/query all ActivityPub related inf…
…ormations based on the $wp_query (#1148) * Improve Extensibility: Better custom support for conneg and authorized fetch This came up in a discussion with @Menrath to better support custom endpoints/uris with content negotiation and authorized fetch. * added missing changelog * simplify `is_activitypub_request` props @Menrath * simplify header method and use transformer for all queried objects except users * fix number of params * introduce query singleton * fix phpcs * fix phpcs * Add WP_User transformer * add PHP doc * fix phpcs * re-add preview support * fix PHPCS * check if objects are enabled for ActivityPub * add comment to fall through to default * store is_activitypub_request value on init * support virtual users like the blog and application users * I don't know why this breaks * fix header code * class-query.php aktualisieren Co-authored-by: Konstantin Obenland <[email protected]> * functions.php aktualisieren Co-authored-by: Konstantin Obenland <[email protected]> * functions.php aktualisieren Co-authored-by: Konstantin Obenland <[email protected]> * Update CHANGELOG.md Co-authored-by: Konstantin Obenland <[email protected]> * move `is_activitypub_request` logic to query * simplify check * added unittests * fix phpcs * updated changelog * add more specific unit tests * use home_url instead of site_url * add more doc * run and store `is_activitypub_request` on first call instead of on `construct` * transform an object to an ID * optimize code to only load ids/objects if needed * test for `activitypub_status` in comment-meta * add missing user-id * remove unused function * Update phpdoc * fix readme * Align asterisks in block comments * rename local var to match latest changes props @obenland * avoid fall-through props @obenland --------- Co-authored-by: Konstantin Obenland <[email protected]>
- Loading branch information
Showing
14 changed files
with
684 additions
and
178 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,263 @@ | ||
| <?php | ||
| /** | ||
| * Query class. | ||
| * | ||
| * @package Activitypub | ||
| */ | ||
|
|
||
| namespace Activitypub; | ||
|
|
||
| use Activitypub\Collection\Actors; | ||
| 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; | ||
|
|
||
| /** | ||
| * 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; | ||
| } | ||
|
|
||
| $queried_object = $this->get_queried_object(); | ||
|
|
||
| if ( ! $queried_object ) { | ||
| // If the object is not a valid ActivityPub object, try to get a virtual object. | ||
| $this->activitypub_object = $this->maybe_get_virtual_object(); | ||
| return $this->activitypub_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 int The ActivityPub object ID. | ||
| */ | ||
| public function get_activitypub_object_id() { | ||
| if ( $this->activitypub_object_id ) { | ||
| return $this->activitypub_object_id; | ||
| } | ||
|
|
||
| $queried_object = $this->get_queried_object(); | ||
| $this->activitypub_object_id = null; | ||
|
|
||
| if ( ! $queried_object ) { | ||
| // If the object is not a valid ActivityPub object, try to get a virtual object. | ||
| $virtual_object = $this->maybe_get_virtual_object(); | ||
|
|
||
| if ( $virtual_object ) { | ||
| $this->activitypub_object_id = $virtual_object->get_id(); | ||
|
|
||
| return $this->activitypub_object_id; | ||
| } | ||
| } | ||
|
|
||
| $transformer = Factory::get_transformer( $queried_object ); | ||
|
|
||
| if ( $transformer && ! is_wp_error( $transformer ) ) { | ||
| $this->activitypub_object_id = $transformer->to_id(); | ||
| } | ||
|
|
||
| return $this->activitypub_object_id; | ||
| } | ||
|
|
||
| /** | ||
| * 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(); | ||
|
|
||
| if ( $queried_object ) { | ||
| return $queried_object; | ||
| } | ||
|
|
||
| // Check Comment by ID. | ||
| $comment_id = \get_query_var( 'c' ); | ||
| if ( $comment_id ) { | ||
| return \get_comment( $comment_id ); | ||
| } | ||
|
|
||
| // Try to get Author by ID. | ||
| $url = $this->get_request_url(); | ||
| $author_id = url_to_authorid( $url ); | ||
| if ( $author_id ) { | ||
| return \get_user_by( 'id', $author_id ); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * 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\Blog | ||
| * @see \Activitypub\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 ) ) { | ||
| return null; | ||
| } | ||
|
|
||
| $user = Actors::get_by_id( $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'] ) ) { | ||
| $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 ) ) { | ||
| $this->is_activitypub_request = true; | ||
|
|
||
| return true; | ||
| } | ||
| } | ||
|
|
||
| $this->is_activitypub_request = false; | ||
|
|
||
| return false; | ||
| } | ||
| } |
Oops, something went wrong.