Event-Federation/wordpress-activitypub
Event-Federation/wordpress-activitypub
7
1
Fork 0
Code Issues 3 Pull requests Projects Releases Wiki Activity Actions

Merge pull request #355 from Automattic/rewrite-user-management

Browse source 
Rewrite user management
This commit is contained in:
Matthias Pfefferle 2023-07-03 18:06:40 +02:00 committed by GitHub
commit d4fb683965
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
36 changed files with 450 additions and 680 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

203
includes/activity/class-activity.php Normal file
View file

@ -0,0 +1,203 @@
<?php
/**
* Inspired by the PHP ActivityPub Library by @Landrok
*
* @link https://github.com/landrok/activitypub
*/
namespace Activitypub\Activity;
use Activitypub\Activity\Base_Object;
/**
* \Activitypub\Activity\Activity implements the common
* attributes of an Activity.
*
* @see https://www.w3.org/TR/activitystreams-core/#activities
* @see https://www.w3.org/TR/activitystreams-core/#intransitiveactivities
*/
class Activity extends Base_Object {
const CONTEXT = array(
'https://www.w3.org/ns/activitystreams',
'https://w3id.org/security/v1',
array(
'manuallyApprovesFollowers' => 'as:manuallyApprovesFollowers',
'PropertyValue' => 'schema:PropertyValue',
'schema' => 'http://schema.org#',
'pt' => 'https://joinpeertube.org/ns#',
'toot' => 'http://joinmastodon.org/ns#',
'value' => 'schema:value',
'Hashtag' => 'as:Hashtag',
'featured' => array(
'@id' => 'toot:featured',
'@type' => '@id',
),
'featuredTags' => array(
'@id' => 'toot:featuredTags',
'@type' => '@id',
),
),
);
/**
* The object's unique global identifier
*
* @see https://www.w3.org/TR/activitypub/#obj-id
*
* @var string
*/
protected $id;
/**
* @var string
*/
protected $type = 'Activity';
/**
* The context within which the object exists or an activity was
* performed.
* The notion of "context" used is intentionally vague.
* The intended function is to serve as a means of grouping objects
* and activities that share a common originating context or
* purpose. An example could be all activities relating to a common
* project or event.
*
* @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-context
*
* @var string
* | ObjectType
* | Link
* | null
*/
protected $context = self::CONTEXT;
/**
* Describes the direct object of the activity.
* For instance, in the activity "John added a movie to his
* wishlist", the object of the activity is the movie added.
*
* @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object-term
*
* @var string
* | ObjectType
* | Link
* | null
*/
protected $object;
/**
* Describes one or more entities that either performed or are
* expected to perform the activity.
* Any single activity can have multiple actors.
* The actor MAY be specified using an indirect Link.
*
* @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-actor
*
* @var string
* | \ActivityPhp\Type\Extended\AbstractActor
* | array<Actor>
* | array<Link>
* | Link
*/
protected $actor;
/**
* The indirect object, or target, of the activity.
* The precise meaning of the target is largely dependent on the
* type of action being described but will often be the object of
* the English preposition "to".
* For instance, in the activity "John added a movie to his
* wishlist", the target of the activity is John's wishlist.
* An activity can have more than one target.
*
* @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target
*
* @var string
* | ObjectType
* | array<ObjectType>
* | Link
* | array<Link>
*/
protected $target;
/**
* Describes the result of the activity.
* For instance, if a particular action results in the creation of
* a new resource, the result property can be used to describe
* that new resource.
*
* @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-result
*
* @var string
* | ObjectType
* | Link
* | null
*/
protected $result;
/**
* An indirect object of the activity from which the
* activity is directed.
* The precise meaning of the origin is the object of the English
* preposition "from".
* For instance, in the activity "John moved an item to List B
* from List A", the origin of the activity is "List A".
*
* @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-origin
*
* @var string
* | ObjectType
* | Link
* | null
*/
protected $origin;
/**
* One or more objects used (or to be used) in the completion of an
* Activity.
*
* @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-instrument
*
* @var string
* | ObjectType
* | Link
* | null
*/
protected $instrument;
/**
* Set the object and copy Object properties to the Activity.
*
* Any to, bto, cc, bcc, and audience properties specified on the object
* MUST be copied over to the new Create activity by the server.
*
* @see https://www.w3.org/TR/activitypub/#object-without-create
*
* @param \Activitypub\Activity\Base_Object $object
*
* @return void
*/
public function set_object( Base_Object $object ) {
parent::set_object( $object );
foreach ( array( 'to', 'bto', 'cc', 'bcc', 'audience' ) as $i ) {
$this->set( $i, $object->get( $i ) );
}
if ( $object->get_published() && ! $this->get_published() ) {
$this->set( 'published', $object->get_published() );
}
if ( $object->get_updated() && ! $this->get_updated() ) {
$this->set( 'updated', $object->get_updated() );
}
if ( $object->attributed_to() && ! $this->get_actor() ) {
$this->set( 'actor', $object->attributed_to() );
}
if ( $object->get_id() && ! $this->get_id() ) {
$this->set( 'id', $object->get_id() . '#activity' );
}
}
}

8
includes/activity/class-actor.php
View file

@ -7,6 +7,14 @@
namespace Activitypub\Activity;
/**
* \Activitypub\Activity\Actor is an implementation of
* one an Activity Streams Actor.
*
* Represents an individual actor.
*
* @see https://www.w3.org/TR/activitystreams-vocabulary/#actor-types
*/
class Actor extends Base_Object {
/**
* @var string

15
includes/activity/class-base-object.php
View file

@ -604,6 +604,10 @@ class Base_Object {
$value = call_user_func( array( $this, 'get_' . $key ) );
}
if ( is_object( $value ) ) {
$value = $value->to_array();
}
// if value is still empty, ignore it for the array and continue.
if ( isset( $value ) ) {
$array[ snake_to_camel_case( $key ) ] = $value;
@ -625,4 +629,15 @@ class Base_Object {
return $array;
}
/**
* Convert Object to JSON.
*
* @return string The JSON string.
*/
public function to_json() {
$array = $this->to_array();
return \wp_json_encode( $array );
}
}

19
includes/class-activity-dispatcher.php
View file

@ -2,11 +2,10 @@
namespace Activitypub;
use WP_Post;
use Activitypub\User_Factory;
use Activitypub\Model\Post;
use Activitypub\Model\Activity;
use Activitypub\Activity\Activity;
use Activitypub\Collection\Users;
use Activitypub\Collection\Followers;
use Activitypub\Transformer\Post;
use function Activitypub\is_user_disabled;
use function Activitypub\safe_remote_post;
@ -55,10 +54,10 @@ class Activity_Dispatcher {
$inboxes = array_merge( $follower_inboxes, $mentioned_inboxes );
$inboxes = array_unique( $inboxes );
foreach ( $inboxes as $inbox ) {
$activity = $activitypub_activity->to_json();
$array = $activity->to_json();
safe_remote_post( $inbox, $activity, $user_id );
foreach ( $inboxes as $inbox ) {
safe_remote_post( $inbox, $array, $user_id );
}
}
@ -90,10 +89,10 @@ class Activity_Dispatcher {
$inboxes = array_merge( $follower_inboxes, $mentioned_inboxes );
$inboxes = array_unique( $inboxes );
foreach ( $inboxes as $inbox ) {
$activity = $activitypub_activity->to_json();
$array = $activity->to_json();
safe_remote_post( $inbox, $activity, $user_id );
foreach ( $inboxes as $inbox ) {
safe_remote_post( $inbox, $array, $user_id );
}
}
}

3
includes/class-activitypub.php
View file

@ -2,6 +2,7 @@
namespace Activitypub;
use Activitypub\Signature;
use Activitypub\Collection\Users;
/**
* ActivityPub Class
@ -82,7 +83,7 @@ class Activitypub {
$json_template = false;
// check if user can publish posts
if ( \is_author() && ! User_Factory::get_by_id( \get_the_author_meta( 'ID' ) ) ) {
if ( \is_author() && ! Users::get_by_id( \get_the_author_meta( 'ID' ) ) ) {
return $template;
}

2
includes/class-admin.php
View file

@ -1,8 +1,6 @@
<?php
namespace Activitypub;
use Activitypub\Model\Post;
/**
* ActivityPub Admin Class
*

4
includes/class-http.php
View file

@ -2,7 +2,7 @@
namespace Activitypub;
use WP_Error;
use Activitypub\User_Factory;
use Activitypub\Collection\Users;
/**
* ActivityPub HTTP Class
@ -63,7 +63,7 @@ class Http {
*/
public static function get( $url ) {
$date = \gmdate( 'D, d M Y H:i:s T' );
$signature = Signature::generate_signature( User_Factory::APPLICATION_USER_ID, 'get', $url, $date );
$signature = Signature::generate_signature( Users::APPLICATION_USER_ID, 'get', $url, $date );
$wp_version = \get_bloginfo( 'version' );
$user_agent = \apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . \get_bloginfo( 'url' ) );

4
includes/class-scheduler.php
View file

@ -2,9 +2,9 @@
namespace Activitypub;
use Activitypub\Model\Post;
use Activitypub\User_Factory;
use Activitypub\Collection\Users;
use Activitypub\Collection\Followers;
use \Activitypub\Transformer\Post;
/**
* ActivityPub Scheduler Class

6
includes/class-signature.php
View file

@ -5,7 +5,7 @@ use WP_Error;
use DateTime;
use DateTimeZone;
use Activitypub\Model\User;
use Activitypub\User_Factory;
use Activitypub\Collection\Users;
/**
* ActivityPub Signature Class
@ -106,7 +106,7 @@ class Signature {
* @return string The signature.
*/
public static function generate_signature( $user_id, $http_method, $url, $date, $digest = null ) {
$user = User_Factory::get_by_id( $user_id );
$user = Users::get_by_id( $user_id );
$key = $user->get__private_key();
$url_parts = \wp_parse_url( $url );
@ -136,7 +136,7 @@ class Signature {
\openssl_sign( $signed_string, $signature, $key, \OPENSSL_ALGO_SHA256 );
$signature = \base64_encode( $signature ); // phpcs:ignore
$user = User_Factory::get_by_id( $user_id );
$user = Users::get_by_id( $user_id );
$key_id = $user->get_url() . '#main-key';
if ( ! empty( $digest ) ) {

2
includes/class-webfinger.php
View file

@ -24,7 +24,7 @@ class Webfinger {
return \get_webfinger_resource( $user_id, false );
}
$user = User_Factory::get_by_id( $user_id );
$user = Users::get_by_id( $user_id );
if ( ! $user ) {
return '';
}

2
includes/collection/class-followers.php
View file

@ -6,8 +6,8 @@ use Exception;
use WP_Query;
use Activitypub\Http;
use Activitypub\Webfinger;
use Activitypub\Model\Activity;
use Activitypub\Model\Follower;
use Activitypub\Activity\Activity;
use function Activitypub\is_tombstone;
use function Activitypub\get_remote_metadata_by_actor;

4
includes/class-user-factory.php → includes/collection/class-users.php
View file

@ -1,5 +1,5 @@
<?php
namespace Activitypub;
namespace Activitypub\Collection;
use WP_Error;
use WP_User_Query;
@ -7,7 +7,7 @@ use Activitypub\Model\User;
use Activitypub\Model\Blog_User;
use Activitypub\Model\Application_User;
class User_Factory {
class Users {
/**
* The ID of the Blog User
*

4
includes/functions.php
View file

@ -279,10 +279,10 @@ function is_activitypub_request() {
function is_user_disabled( $user_id ) {
switch ( $user_id ) {
// if the user is the application user, it's always enabled.
case \Activitypub\User_Factory::APPLICATION_USER_ID:
case \Activitypub\Collection\Users::APPLICATION_USER_ID:
return false;
// if the user is the blog user, it's only enabled in single-user mode.
case \Activitypub\User_Factory::BLOG_USER_ID:
case \Activitypub\Collection\Users::BLOG_USER_ID:
if ( defined( 'ACTIVITYPUB_DISABLE_BLOG_USER' ) ) {
return ACTIVITYPUB_DISABLE_BLOG_USER;
}

244
includes/model/class-activity.php
View file

@ -1,244 +0,0 @@
<?php
namespace Activitypub\Model;
use function Activitypub\get_rest_url_by_path;
/**
* ActivityPub Post Class
*
* @author Matthias Pfefferle
*
* @see https://www.w3.org/TR/activitypub/
*/
class Activity {
const CONTEXT = array(
'https://www.w3.org/ns/activitystreams',
'https://w3id.org/security/v1',
array(
'manuallyApprovesFollowers' => 'as:manuallyApprovesFollowers',
'PropertyValue' => 'schema:PropertyValue',
'schema' => 'http://schema.org#',
'pt' => 'https://joinpeertube.org/ns#',
'toot' => 'http://joinmastodon.org/ns#',
'value' => 'schema:value',
'Hashtag' => 'as:Hashtag',
'featured' => array(
'@id' => 'toot:featured',
'@type' => '@id',
),
'featuredTags' => array(
'@id' => 'toot:featuredTags',
'@type' => '@id',
),
),
);
/**
* The JSON-LD context.
*
* @var array
*/
private $context = self::CONTEXT;
/**
* The published date.
*
* @var string
*/
private $published = '';
/**
* The Activity-ID.
*
* @var string
*/
private $id = '';
/**
* The Activity-Type.
*
* @var string
*/
private $type = 'Create';
/**
* The Activity-Actor.
*
* @var string
*/
private $actor = '';
/**
* The Audience.
*
* @var array
*/
private $to = array( 'https://www.w3.org/ns/activitystreams#Public' );
/**
* The CC.
*
* @var array
*/
private $cc = array();
/**
* The Activity-Object.
*
* @var array
*/
private $object = null;
/**
* The Class-Constructor.
*
* @param string $type The Activity-Type.
* @param boolean $context The JSON-LD context.
*/
public function __construct( $type = 'Create', $context = true ) {
if ( true !== $context ) {
$this->context = null;
}
$this->type = \ucfirst( $type );
$this->published = \gmdate( 'Y-m-d\TH:i:s\Z', \time() );
}
/**
* Magic Getter/Setter
*
* @param string $method The method name.
* @param string $params The method params.
*
* @return mixed The value.
*/
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];
}
if ( \strncasecmp( $method, 'add', 3 ) === 0 ) {
if ( ! is_array( $this->$var ) ) {
$this->$var = $params[0];
}
if ( is_array( $params[0] ) ) {
$this->$var = array_merge( $this->$var, $params[0] );
} else {
array_push( $this->$var, $params[0] );
}
$this->$var = array_unique( $this->$var );
}
}
/**
* Convert from a Post-Object.
*
* @param Post $post The Post-Object.
*
* @return void
*/
public function from_post( Post $post ) {
$this->object = $post->to_array();
if ( isset( $object['published'] ) ) {
$this->published = $object['published'];
}
$path = sprintf( 'users/%d/followers', intval( $post->get_post_author() ) );
$this->add_to( get_rest_url_by_path( $path ) );
if ( isset( $this->object['attributedTo'] ) ) {
$this->actor = $this->object['attributedTo'];
}
foreach ( $post->get_tags() as $tag ) {
if ( 'Mention' === $tag['type'] ) {
$this->add_cc( $tag['href'] );
}
}
$type = \strtolower( $this->type );
if ( isset( $this->object['id'] ) ) {
$this->id = add_query_arg( 'activity', $type, $this->object['id'] );
}
}
public function from_comment( $object ) {
}
public function to_comment() {
}
public function from_remote_array( $array ) {
}
/**
* Convert to an Array.
*
* @return array The Array.
*/
public function to_array() {
$array = array_filter( \get_object_vars( $this ) );
if ( $this->context ) {
$array = array( '@context' => $this->context ) + $array;
}
unset( $array['context'] );
return $array;
}
/**
* Convert to JSON
*
* @return string The JSON.
*/
public function to_json() {
return \wp_json_encode( $this->to_array(), \JSON_HEX_TAG | \JSON_HEX_AMP | \JSON_HEX_QUOT );
}
/**
* Convert to a Simple Array.
*
* @return string The array.
*/
public function to_simple_array() {
$activity = array(
'@context' => $this->context,
'type' => $this->type,
'actor' => $this->actor,
'object' => $this->object,
'to' => $this->to,
'cc' => $this->cc,
);
if ( $this->id ) {
$activity['id'] = $this->id;
}
return $activity;
}
/**
* Convert to a Simple JSON.
*
* @return string The JSON.
*/
public function to_simple_json() {
return \wp_json_encode( $this->to_simple_array(), \JSON_HEX_TAG | \JSON_HEX_AMP | \JSON_HEX_QUOT );
}
}

4
includes/model/class-application-user.php
View file

@ -3,7 +3,7 @@ namespace Activitypub\Model;
use WP_Query;
use Activitypub\Signature;
use Activitypub\User_Factory;
use Activitypub\Collection\Users;
use function Activitypub\get_rest_url_by_path;
@ -13,7 +13,7 @@ class Application_User extends Blog_User {
*
* @var int
*/
protected $_id = User_Factory::APPLICATION_USER_ID; // phpcs:ignore PSR2.Classes.PropertyDeclaration.Underscore
protected $_id = Users::APPLICATION_USER_ID; // phpcs:ignore PSR2.Classes.PropertyDeclaration.Underscore
/**
* The User-Type

4
includes/model/class-blog-user.php
View file

@ -3,7 +3,7 @@ namespace Activitypub\Model;
use WP_Query;
use Activitypub\Signature;
use Activitypub\User_Factory;
use Activitypub\Collection\Users;
use function Activitypub\is_user_disabled;
@ -13,7 +13,7 @@ class Blog_User extends User {
*
* @var int
*/
protected $_id = User_Factory::BLOG_USER_ID; // phpcs:ignore PSR2.Classes.PropertyDeclaration.Underscore
protected $_id = Users::BLOG_USER_ID; // phpcs:ignore PSR2.Classes.PropertyDeclaration.Underscore
/**
* The User-Type

5
includes/model/class-user.php
View file

@ -4,8 +4,7 @@ namespace Activitypub\Model;
use WP_Query;
use WP_Error;
use Activitypub\Signature;
use Activitypub\Model\User;
use Activitypub\User_Factory;
use Activitypub\Collection\Users;
use Activitypub\Activity\Actor;
use function Activitypub\is_user_disabled;
@ -13,7 +12,7 @@ use function Activitypub\get_rest_url_by_path;
class User extends Actor {
/**
* The User-ID
* The local User-ID (WP_User).
*
* @var int
*/

67
includes/peer/class-users.php
View file

@ -1,67 +0,0 @@
<?php
namespace Activitypub\Peer;
/**
* ActivityPub Users DB-Class
*
* @author Matthias Pfefferle
*/
class Users {
/**
* Undocumented function
*
* @return void
*/
public static function get_user_by_various( $data ) {
}
/**
* Examine a url and try to determine the author ID it represents.
*
* Checks are supposedly from the hosted site blog.
*
* @param string $url Permalink to check.
*
* @return int User ID, or 0 on failure.
*/
public static function url_to_authorid( $url ) {
global $wp_rewrite;
// check if url hase the same host
if ( \wp_parse_url( \site_url(), \PHP_URL_HOST ) !== \wp_parse_url( $url, \PHP_URL_HOST ) ) {
return 0;
}
// first, check to see if there is a 'author=N' to match against
if ( \preg_match( '/[?&]author=(\d+)/i', $url, $values ) ) {
$id = \absint( $values[1] );
if ( $id ) {
return $id;
}
}
// check to see if we are using rewrite rules
$rewrite = $wp_rewrite->wp_rewrite_rules();
// not using rewrite rules, and 'author=N' method failed, so we're out of options
if ( empty( $rewrite ) ) {
return 0;
}
// generate rewrite rule for the author url
$author_rewrite = $wp_rewrite->get_author_permastruct();
$author_regexp = \str_replace( '%author%', '', $author_rewrite );
// match the rewrite rule with the passed url
if ( \preg_match( '/https?:\/\/(.+)' . \preg_quote( $author_regexp, '/' ) . '([^\/]+)/i', $url, $match ) ) {
$user = \get_user_by( 'slug', $match[2] );
if ( $user ) {
return $user->ID;
}
}
return 0;
}
}

4
includes/rest/class-followers.php
View file

@ -5,7 +5,7 @@ use WP_Error;
use stdClass;
use WP_REST_Server;
use WP_REST_Response;
use Activitypub\User_Factory;
use Activitypub\Collection\Users;
use Activitypub\Collection\Followers as FollowerCollection;
use function Activitypub\get_rest_url_by_path;
@ -52,7 +52,7 @@ class Followers {
*/
public static function get( $request ) {
$user_id = $request->get_param( 'user_id' );
$user = User_Factory::get_by_various( $user_id );
$user = Users::get_by_various( $user_id );
if ( is_wp_error( $user ) ) {
return $user;

4
includes/rest/class-following.php
View file

@ -1,7 +1,7 @@
<?php
namespace Activitypub\Rest;
use Activitypub\User_Factory;
use Activitypub\Collection\Users;
use function Activitypub\get_rest_url_by_path;
@ -47,7 +47,7 @@ class Following {
*/
public static function get( $request ) {
$user_id = $request->get_param( 'user_id' );
$user = User_Factory::get_by_various( $user_id );
$user = Users::get_by_various( $user_id );
if ( is_wp_error( $user ) ) {
return $user;

8
includes/rest/class-inbox.php
View file

@ -4,8 +4,8 @@ namespace Activitypub\Rest;
use WP_Error;
use WP_REST_Server;
use WP_REST_Response;
use Activitypub\User_Factory;
use Activitypub\Model\Activity;
use Activitypub\Collection\Users;
use Activitypub\Activity\Activity;
use function Activitypub\get_context;
use function Activitypub\url_to_authorid;
@ -74,7 +74,7 @@ class Inbox {
*/
public static function user_inbox_get( $request ) {
$user_id = $request->get_param( 'user_id' );
$user = User_Factory::get_by_various( $user_id );
$user = Users::get_by_various( $user_id );
if ( is_wp_error( $user ) ) {
return $user;
@ -126,7 +126,7 @@ class Inbox {
public static function user_inbox_post( $request ) {
$user_id = $request->get_param( 'user_id' );
$user = User_Factory::get_by_various( $user_id );
$user = Users::get_by_various( $user_id );
if ( is_wp_error( $user ) ) {
return $user;

24
includes/rest/class-outbox.php
View file

@ -5,9 +5,9 @@ use stdClass;
use WP_Error;
use WP_REST_Server;
use WP_REST_Response;
use Activitypub\User_Factory;
use Activitypub\Model\Post;
use Activitypub\Model\Activity;
use Activitypub\Activity\Activity;
use Activitypub\Collection\Users;
use Activitypub\Transformer\Post;
use function Activitypub\get_context;
use function Activitypub\get_rest_url_by_path;
@ -53,7 +53,7 @@ class Outbox {
*/
public static function user_outbox_get( $request ) {
$user_id = $request->get_param( 'user_id' );
$user = User_Factory::get_by_various( $user_id );
$user = Users::get_by_various( $user_id );
if ( is_wp_error( $user ) ) {
return $user;
@ -73,9 +73,9 @@ class Outbox {
$json->{'@context'} = get_context();
$json->id = \home_url( \add_query_arg( null, null ) );
$json->generator = 'http://wordpress.org/?v=' . \get_bloginfo_rss( 'version' );
$json->actor = $user->get_id();
//$json->actor = $user->get_id();
$json->type = 'OrderedCollectionPage';
$json->partOf = get_rest_url_by_path( sprintf( 'users/%d/outbox', $user->get__id() ) ); // phpcs:ignore
$json->partOf = get_rest_url_by_path( sprintf( 'users/%d/outbox', $user_id ) ); // phpcs:ignore
$json->totalItems = 0; // phpcs:ignore
// phpcs:ignore
@ -97,18 +97,20 @@ class Outbox {
$posts = \get_posts(
array(
'posts_per_page' => 10,
'author' => $user->get__id(),
'author' => $user_id,
'offset' => ( $page - 1 ) * 10,
'post_type' => $post_types,
)
);
foreach ( $posts as $post ) {
$activitypub_post = new Post( $post );
$activitypub_activity = new Activity( 'Create', false );
$post = Post::transform( $post )->to_object();
$activity = new Activity();
$activity->set_type( 'Create' );
$activity->set_context( null );
$activity->set_object( $post );
$activitypub_activity->from_post( $activitypub_post );
$json->orderedItems[] = $activitypub_activity->to_array(); // phpcs:ignore
$json->orderedItems[] = $activity->to_array(); // phpcs:ignore
}
}

7
includes/rest/class-users.php
View file

@ -4,7 +4,8 @@ namespace Activitypub\Rest;
use WP_Error;
use WP_REST_Server;
use WP_REST_Response;
use Activitypub\User_Factory;
use \Activitypub\Activity\Activity;
use Activitypub\Collection\Users as User_Collection;
use function Activitypub\is_activitypub_request;
@ -50,7 +51,7 @@ class Users {
*/
public static function get( $request ) {
$user_id = $request->get_param( 'user_id' );
$user = User_Factory::get_by_various( $user_id );
$user = User_Collection::get_by_various( $user_id );
if ( is_wp_error( $user ) ) {
return $user;
@ -68,7 +69,7 @@ class Users {
\do_action( 'activitypub_outbox_pre' );
$user->set_context(
\Activitypub\Model\Activity::CONTEXT
Activity::CONTEXT
);
$json = $user->to_array();

4
includes/rest/class-webfinger.php
View file

@ -3,7 +3,7 @@ namespace Activitypub\Rest;
use WP_Error;
use WP_REST_Response;
use Activitypub\User_Factory;
use Activitypub\Collection\Users;
/**
* ActivityPub WebFinger REST-Class
@ -47,7 +47,7 @@ class Webfinger {
*/
public static function webfinger( $request ) {
$resource = $request->get_param( 'resource' );
$user = User_Factory::get_by_resource( $resource );
$user = Users::get_by_resource( $resource );
if ( is_wp_error( $user ) ) {
return $user;

4
includes/table/class-followers.php
View file

@ -2,7 +2,7 @@
namespace Activitypub\Table;
use WP_List_Table;
use Activitypub\User_Factory;
use Activitypub\Collection\Users;
use Activitypub\Collection\Followers as FollowerCollection;
if ( ! \class_exists( '\WP_List_Table' ) ) {
@ -14,7 +14,7 @@ class Followers extends WP_List_Table {
public function __construct() {
if ( get_current_screen()->id === 'settings_page_activitypub' ) {
$this->user_id = User_Factory::BLOG_USER_ID;
$this->user_id = Users::BLOG_USER_ID;
} else {
$this->user_id = \get_current_user_id();
}

420
includes/model/class-post.php → includes/transformer/class-post.php
View file

@ -1,84 +1,37 @@
<?php
namespace Activitypub\Model;
namespace Activitypub\Transformer;
use WP_Post;
use \Activitypub\Activity\Base_Object;
use \Activitypub\Collection\Users;
use Activitypub\User_Factory;
use function Activitypub\get_rest_url_by_path;
/**
* ActivityPub Post Class
* WordPress Post Transformer
*
* @author Matthias Pfefferle
* The Post Transformer is responsible for transforming a WP_Post object into different othe
* Object-Types.
*
* Currently supported are:
*
* - Activitypub\Activity\Base_Object
*/
class Post {
/**
* The WordPress Post Object.
* The WP_Post object.
*
* @var WP_Post
*/
private $post;
/**
* The Post Author.
*
* @var string
*/
private $post_author;
/**
* The Object ID.
*
* @var string
*/
private $id;
/**
* The Object URL.
*
* @var string
*/
private $url;
/**
* The Object Summary.
*
* @var string
*/
private $summary;
/**
* The Object Summary
*
* @var string
*/
private $content;
/**
* The Object Attachments. This is usually a list of Images.
*
* @var array
*/
private $attachments;
/**
* The Object Tags. This is usually the list of used Hashtags.
*
* @var array
*/
private $tags;
/**
* The Onject Type
*
* @var string
*/
private $object_type;
protected $wp_post;
/**
* The Allowed Tags, used in the content.
*
* @var array
*/
private $allowed_tags = array(
protected $allowed_tags = array(
'a' => array(
'href' => array(),
'title' => array(),
@ -126,185 +79,70 @@ class Post {
);
/**
* List of audience
* Static function to Transform a WP_Post Object.
*
* Also used for visibility
* This helps to chain the output of the Transformer.
*
* @var array
*/
private $to = array( 'https://www.w3.org/ns/activitystreams#Public' );
/**
* List of audience
*
* Also used for visibility
*
* @var array
*/
private $cc = array();
/**
* Constructor
*
* @param WP_Post $post
* @param int $post_author
*/
public function __construct( $post, $post_author = null ) {
$this->post = \get_post( $post );
if ( $post_author ) {
$this->post_author = $post_author;
} else {
$this->post_author = $this->post->post_author;
}
$path = sprintf( 'users/%d/followers', intval( $this->get_post_author() ) );
$this->add_to( get_rest_url_by_path( $path ) );
}
/**
* Magic function to implement getter and setter
*
* @param string $method
* @param string $params
* @param WP_Post $wp_post The WP_Post object
*
* @return void
*/
public function __call( $method, $params ) {
$var = \strtolower( \substr( $method, 4 ) );
if ( \strncasecmp( $method, 'get', 3 ) === 0 ) {
if ( empty( $this->$var ) && ! empty( $this->post->$var ) ) {
return $this->post->$var;
}
return $this->$var;
}
if ( \strncasecmp( $method, 'set', 3 ) === 0 ) {
$this->$var = $params[0];
}
if ( \strncasecmp( $method, 'add', 3 ) === 0 ) {
if ( ! is_array( $this->$var ) ) {
$this->$var = $params[0];
}
if ( is_array( $params[0] ) ) {
$this->$var = array_merge( $this->$var, $params[0] );
} else {
array_push( $this->$var, $params[0] );
}
$this->$var = array_unique( $this->$var );
}
public static function transform( WP_Post $wp_post ) {
return new self( $wp_post );
}
/**
* Returns the User ID.
*
* @return int the User ID.
*
* @param WP_Post $wp_post
*/
public function get_user_id() {
return apply_filters( 'activitypub_post_user_id', $this->get_post_author(), $this->post );
public function __construct( WP_Post $wp_post ) {
$this->wp_post = $wp_post;
}
/**
* Converts this Object into an Array.
* Transforms the WP_Post object to an ActivityPub Object
*
* @return array the array representation of a Post.
* @see \Activitypub\Activity\Base_Object
*
* @return \Activitypub\Activity\Base_Object The ActivityPub Object
*/
public function to_array() {
$post = $this->post;
public function to_object() {
$wp_post = $this->wp_post;
$object = new Base_Object();
$array = array(
'id' => $this->get_id(),
'url' => $this->get_url(),
'type' => $this->get_object_type(),
'published' => \gmdate( 'Y-m-d\TH:i:s\Z', \strtotime( $post->post_date_gmt ) ),
'attributedTo' => $this->get_actor(),
'summary' => $this->get_summary(),
'inReplyTo' => null,
'content' => $this->get_content(),
'contentMap' => array(
$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() );
$object->set_published( \gmdate( 'Y-m-d\TH:i:s\Z', \strtotime( $wp_post->post_date_gmt ) ) );
$object->attributed_to( Users::get_by_id( $wp_post->post_author )->get_url() );
$object->set_content( $this->get_content() );
$object->set_content_map(
array(
\strstr( \get_locale(), '_', true ) => $this->get_content(),
),
'to' => $this->get_to(),
'cc' => $this->get_cc(),
'attachment' => $this->get_attachments(),
'tag' => $this->get_tags(),
)
);
$path = sprintf( 'users/%d/followers', intval( $wp_post->post_author ) );
return \apply_filters( 'activitypub_post', $array, $this->post );
$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() );
return $object;
}
/**
* Returns the Actor of this Object.
* Generates all Image Attachments for a Post.
*
* @return string The URL of the Actor.
* @return array The Image Attachments.
*/
public function get_actor() {
$user = User_Factory::get_by_id( $this->get_user_id() );
return $user->get_url();
}
/**
* Converts this Object into a JSON String
*
* @return string
*/
public function to_json() {
return \wp_json_encode( $this->to_array(), \JSON_HEX_TAG | \JSON_HEX_AMP | \JSON_HEX_QUOT );
}
/**
* Returns the URL of an Activity Object
*
* @return string
*/
public function get_url() {
if ( $this->url ) {
return $this->url;
}
$post = $this->post;
if ( 'trash' === get_post_status( $post ) ) {
$permalink = \get_post_meta( $post->ID, 'activitypub_canonical_url', true );
} else {
$permalink = \get_permalink( $post );
}
$this->url = $permalink;
return $permalink;
}
/**
* Returns the ID of an Activity Object
*
* @return string
*/
public function get_id() {
if ( $this->id ) {
return $this->id;
}
$this->id = $this->get_url();
return $this->id;
}
/**
* Returns a list of Image Attachments
*
* @return array
*/
public function get_attachments() {
if ( $this->attachments ) {
return $this->attachments;
}
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();
@ -314,7 +152,7 @@ class Post {
return $images;
}
$id = $this->post->ID;
$id = $this->wp_post->ID;
$image_ids = array();
@ -393,7 +231,7 @@ class Post {
*
* @return array|false Array of image data, or boolean false if no image is available.
*/
public function get_image( $id, $image_size = 'full' ) {
protected function get_image( $id, $image_size = 'full' ) {
/**
* Hook into the image retrieval process. Before image retrieval.
*
@ -416,64 +254,22 @@ class Post {
}
/**
* Returns a list of Tags, used in the Post
* Returns the ActivityStreams 2.0 Object-Type for a Post based on the
* settings and the Post-Type.
*
* @return array
*/
public function get_tags() {
if ( $this->tags ) {
return $this->tags;
}
$tags = array();
$post_tags = \get_the_tags( $this->post->ID );
if ( $post_tags ) {
foreach ( $post_tags as $post_tag ) {
$tag = array(
'type' => 'Hashtag',
'href' => \get_tag_link( $post_tag->term_id ),
'name' => '#' . $post_tag->slug,
);
$tags[] = $tag;
}
}
$mentions = apply_filters( 'activitypub_extract_mentions', array(), $this->post->post_content, $this );
if ( $mentions ) {
foreach ( $mentions as $mention => $url ) {
$tag = array(
'type' => 'Mention',
'href' => $url,
'name' => $mention,
);
$tags[] = $tag;
}
}
$this->tags = $tags;
return $tags;
}
/**
* Returns the as2 object-type for a given post
* @see https://www.w3.org/TR/activitystreams-vocabulary/#activity-types
*
* @return string the object-type
* @return string The Object-Type.
*/
public function get_object_type() {
if ( $this->object_type ) {
return $this->object_type;
}
protected function get_object_type() {
if ( 'wordpress-post-format' !== \get_option( 'activitypub_object_type', 'note' ) ) {
return \ucfirst( \get_option( 'activitypub_object_type', 'note' ) );
}
$post_type = \get_post_type( $this->post );
$post_type = \get_post_type( $this->wp_post );
switch ( $post_type ) {
case 'post':
$post_format = \get_post_format( $this->post );
$post_format = \get_post_format( $this->wp_post );
switch ( $post_format ) {
case 'aside':
case 'status':
@ -519,25 +315,78 @@ class Post {
break;
}
$this->object_type = $object_type;
return $object_type;
}
/**
* Returns a list of Mentions, used in the Post.
*
* @see https://docs.joinmastodon.org/spec/activitypub/#Mention
*
* @return array The list of Mentions.
*/
protected function get_cc() {
$cc = array();
$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;
}
}
return $tags;
}
/**
* Returns the content for the ActivityPub Item.
*
* @return string the content
* The content will be generated based on the user settings.
*
* @return string The content.
*/
public function get_content() {
protected function get_content() {
global $post;
if ( $this->content ) {
return $this->content;
}
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
$post = $this->post;
$post = $this->wp_post;
$content = $this->get_post_content_template();
// Fill in the shortcodes.
@ -553,17 +402,15 @@ class Post {
$content = \apply_filters( 'activitypub_the_content', $content, $post );
$content = \html_entity_decode( $content, \ENT_QUOTES, 'UTF-8' );
$this->content = $content;
return $content;
}
/**
* Gets the template to use to generate the content of the activitypub item.
*
* @return string the template
* @return string The Template.
*/
public function get_post_content_template() {
protected function get_post_content_template() {
if ( 'excerpt' === \get_option( 'activitypub_post_content_type', 'content' ) ) {
return "[ap_excerpt]\n\n[ap_permalink type=\"html\"]";
}
@ -578,4 +425,13 @@ class Post {
return \get_option( 'activitypub_custom_post_content', ACTIVITYPUB_CUSTOM_POST_CONTENT );
}
/**
* 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 );
}
}

2
templates/admin-header.php
View file

@ -12,7 +12,7 @@
<?php \esc_html_e( 'Settings', 'activitypub' ); ?>
</a>
<?php if ( ! \Activitypub\is_user_disabled( \ActivityPub\User_Factory::BLOG_USER_ID ) ) : ?>
<?php if ( ! \Activitypub\is_user_disabled( \Activitypub\Collection\Users::BLOG_USER_ID ) ) : ?>
<a href="<?php echo \esc_url_raw( admin_url( 'options-general.php?page=activitypub&tab=followers' ) ); ?>" class="activitypub-settings-tab <?php echo \esc_attr( $args['followers'] ); ?>">
<?php \esc_html_e( 'Followers', 'activitypub' ); ?>

4
templates/author-json.php
View file

@ -1,8 +1,8 @@
<?php
$user = \Activitypub\User_Factory::get_by_id( \get_the_author_meta( 'ID' ) );
$user = \Activitypub\Collection\Users::get_by_id( \get_the_author_meta( 'ID' ) );
$user->set_context(
\Activitypub\Model\Activity::CONTEXT
\Activitypub\Activity\Activity::CONTEXT
);
/*

2
templates/blog-json.php
View file

@ -2,7 +2,7 @@
$user = new \Activitypub\Model\Blog_User();
$user->set_context(
\Activitypub\Model\Activity::CONTEXT
\Activitypub\Activity\Activity::CONTEXT
);
/*

4
templates/post-json.php
View file

@ -2,8 +2,8 @@
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
$post = \get_post();
$activitypub_post = new \Activitypub\Model\Post( $post );
$json = \array_merge( array( '@context' => \Activitypub\get_context() ), $activitypub_post->to_array() );
$object = new \Activitypub\Transformer\Post( $post );
$json = \array_merge( array( '@context' => \Activitypub\get_context() ), $object->to_object()->to_array() );
// filter output
$json = \apply_filters( 'activitypub_json_post_array', $json );

2
templates/settings.php
View file

@ -31,7 +31,7 @@
<form method="post" action="options.php">
<?php \settings_fields( 'activitypub' ); ?>
<?php if ( ! \Activitypub\is_user_disabled( \ActivityPub\User_Factory::BLOG_USER_ID ) ) : ?>
<?php if ( ! \Activitypub\is_user_disabled( \Activitypub\Collection\Users::BLOG_USER_ID ) ) : ?>
<h3><?php \esc_html_e( 'Blog-User', 'activitypub' ); ?></h3>

4
templates/welcome.php
View file

@ -15,7 +15,7 @@
<p><?php \esc_html_e( 'With ActivityPub your blog becomes part of a federated social network. This means you can share and talk to everyone using the ActivityPub protocol, including users of Friendica, Pleroma and Mastodon.', 'activitypub' ); ?></p>
<?php if ( ! \Activitypub\is_user_disabled( \ActivityPub\User_Factory::BLOG_USER_ID ) ) : ?>
<?php if ( ! \Activitypub\is_user_disabled( \Activitypub\Collection\Users::BLOG_USER_ID ) ) : ?>
<h3><?php \esc_html_e( 'Blog Account', 'activitypub' ); ?></h3>
<p>
@ -44,7 +44,7 @@
<h3><?php \esc_html_e( 'Personal Account', 'activitypub' ); ?></h3>
<p>
<?php
$user = \Activitypub\User_Factory::get_by_id( wp_get_current_user()->ID );
$user = \Activitypub\Collection\Users::get_by_id( wp_get_current_user()->ID );
echo wp_kses(
\sprintf(
// translators:

8
tests/test-class-activitypub-activity-dispatcher.php
View file

@ -34,9 +34,7 @@ class Test_Activitypub_Activity_Dispatcher extends ActivityPub_TestCase_Cache_HT
$pre_http_request = new MockAction();
add_filter( 'pre_http_request', array( $pre_http_request, 'filter' ), 10, 3 );
$post = get_post( $post );
\Activitypub\Activity_Dispatcher::send_user_activity( $post, 'Create' );
\Activitypub\Activity_Dispatcher::send_user_activity( get_post( $post ), 'Create' );
$this->assertSame( 2, $pre_http_request->get_call_count() );
$all_args = $pre_http_request->get_args();
@ -76,9 +74,7 @@ class Test_Activitypub_Activity_Dispatcher extends ActivityPub_TestCase_Cache_HT
$pre_http_request = new MockAction();
add_filter( 'pre_http_request', array( $pre_http_request, 'filter' ), 10, 3 );
$post = get_post( $post );
\Activitypub\Activity_Dispatcher::send_user_activity( $post, 'Create' );
\Activitypub\Activity_Dispatcher::send_user_activity( get_post( $post ), 'Create' );
$this->assertSame( 1, $pre_http_request->get_call_count() );
$all_args = $pre_http_request->get_args();

7
tests/test-class-activitypub-activity.php
View file

@ -17,10 +17,11 @@ class Test_Activitypub_Activity extends WP_UnitTestCase {
10
);
$activitypub_post = new \Activitypub\Model\Post( $post );
$activitypub_post = \Activitypub\Transformer\Post::transform( get_post( $post ) )->to_object();
$activitypub_activity = new \Activitypub\Model\Activity( 'Create' );
$activitypub_activity->from_post( $activitypub_post );
$activitypub_activity = new \Activitypub\Activity\Activity();
$activitypub_activity->set_type( 'Create' );
$activitypub_activity->set_object( $activitypub_post );
$this->assertContains( \Activitypub\get_rest_url_by_path( 'users/1/followers' ), $activitypub_activity->get_to() );
$this->assertContains( 'https://example.com/alex', $activitypub_activity->get_cc() );

4
tests/test-class-activitypub-post.php
View file

@ -10,13 +10,13 @@ class Test_Activitypub_Post extends WP_UnitTestCase {
$permalink = \get_permalink( $post );
$activitypub_post = new \Activitypub\Model\Post( $post );
$activitypub_post = \Activitypub\Transformer\Post::transform( get_post( $post ) )->to_object();
$this->assertEquals( $permalink, $activitypub_post->get_id() );
\wp_trash_post( $post );
$activitypub_post = new \Activitypub\Model\Post( $post );
$activitypub_post = \Activitypub\Transformer\Post::transform( get_post( $post ) )->to_object();
$this->assertEquals( $permalink, $activitypub_post->get_id() );
}

18
tests/test-class-activitypub-rest-post-signature-verification.php
View file

@ -10,9 +10,10 @@ class Test_Activitypub_Signature_Verification extends WP_UnitTestCase {
)
);
$remote_actor = \get_author_posts_url( 2 );
$activitypub_post = new \Activitypub\Model\Post( $post );
$activitypub_activity = new Activitypub\Model\Activity( 'Create' );
$activitypub_activity->from_post( $activitypub_post );
$activitypub_post = \Activitypub\Transformer\Post::transform( get_post( $post ) )->to_object();
$activitypub_activity = new Activitypub\Activity\Activity( 'Create' );
$activitypub_activity->set_type( 'Create' );
$activitypub_activity->set_object( $activitypub_post );
$activitypub_activity->add_cc( $remote_actor );
$activity = $activitypub_activity->to_json();
@ -42,7 +43,7 @@ class Test_Activitypub_Signature_Verification extends WP_UnitTestCase {
$signed_headers = $signature_block['headers'];
$signed_data = Activitypub\Signature::get_signed_data( $signed_headers, $signature_block, $headers );
$user = Activitypub\User_Factory::get_by_id( 1 );
$user = Activitypub\Collection\Users::get_by_id( 1 );
$public_key = $user->get__public_key();
@ -55,7 +56,7 @@ class Test_Activitypub_Signature_Verification extends WP_UnitTestCase {
add_filter(
'pre_get_remote_metadata_by_actor',
function( $json, $actor ) {
$user = Activitypub\User_Factory::get_by_id( 1 );
$user = Activitypub\Collection\Users::get_by_id( 1 );
$public_key = $user->get__public_key();
// return ActivityPub Profile with signature
return array(
@ -81,9 +82,10 @@ class Test_Activitypub_Signature_Verification extends WP_UnitTestCase {
);
$remote_actor = \get_author_posts_url( 2 );
$remote_actor_inbox = Activitypub\get_rest_url_by_path( '/inbox' );
$activitypub_post = new \Activitypub\Model\Post( $post );
$activitypub_activity = new Activitypub\Model\Activity( 'Create' );
$activitypub_activity->from_post( $activitypub_post );
$activitypub_post = \Activitypub\Transformer\Post::transform( \get_post( $post ) )->to_object();
$activitypub_activity = new Activitypub\Activity\Activity();
$activitypub_activity->set_type( 'Create' );
$activitypub_activity->set_object( $activitypub_post );
$activitypub_activity->add_cc( $remote_actor_inbox );
$activity = $activitypub_activity->to_json();