forked from GNUsocial/gnu-social
286 lines
12 KiB
PHP
286 lines
12 KiB
PHP
<?php
|
|
|
|
declare(strict_types = 1);
|
|
|
|
// {{{ License
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
//
|
|
// GNU social is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// GNU social is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
|
|
// }}}
|
|
|
|
/**
|
|
* ActivityPub implementation for GNU social
|
|
*
|
|
* @package GNUsocial
|
|
* @category ActivityPub
|
|
*
|
|
* @author Diogo Peralta Cordeiro <@diogo.site>
|
|
* @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*/
|
|
|
|
namespace Plugin\ActivityPub\Util\Model;
|
|
|
|
use ActivityPhp\Type\AbstractObject;
|
|
use App\Core\ActorLocalRoles;
|
|
use App\Core\DB\DB;
|
|
use App\Core\Event;
|
|
use App\Core\GSFile;
|
|
use App\Core\HTTPClient;
|
|
use App\Core\Log;
|
|
use App\Core\Router\Router;
|
|
use App\Entity\Actor as GSActor;
|
|
use App\Util\Exception\ServerException;
|
|
use App\Util\Formatting;
|
|
use App\Util\TemporaryFile;
|
|
use Component\Avatar\Avatar;
|
|
use Component\Group\Entity\LocalGroup;
|
|
use DateTime;
|
|
use DateTimeInterface;
|
|
use Exception;
|
|
use InvalidArgumentException;
|
|
use Plugin\ActivityPub\Entity\ActivitypubActor;
|
|
use Plugin\ActivityPub\Entity\ActivitypubRsa;
|
|
use Plugin\ActivityPub\Util\Model;
|
|
|
|
/**
|
|
* This class handles translation between JSON and GSActors
|
|
*
|
|
* @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*/
|
|
class Actor extends Model
|
|
{
|
|
private static array $_gs_actor_type_to_as2_actor_type = [
|
|
GSActor::PERSON => 'Person',
|
|
GSActor::GROUP => 'Group',
|
|
GSActor::BOT => 'Application',
|
|
];
|
|
private static array $_as2_actor_type_to_gs_actor_type = [
|
|
'Person' => GSActor::PERSON,
|
|
'Group' => GSActor::GROUP,
|
|
'Organization' => GSActor::GROUP,
|
|
'Application' => GSActor::BOT,
|
|
'Service' => null,
|
|
];
|
|
|
|
/**
|
|
* Create an Entity from an ActivityStreams 2.0 JSON string
|
|
* This will persist a new GSActor, ActivityPubRSA, and ActivityPubActor
|
|
*
|
|
* @throws Exception
|
|
*/
|
|
public static function fromJson(string|AbstractObject $json, array $options = []): ActivitypubActor
|
|
{
|
|
$object = \is_string($json) ? self::jsonToType($json) : $json;
|
|
|
|
switch ($object->get('type')) {
|
|
case 'Application':
|
|
case 'Person':
|
|
// TODO: Operator may prefer users to start with Visitor and then have them being manually promoted
|
|
$roles = ActorLocalRoles::PARTICIPANT | ActorLocalRoles::VISITOR; // Can view and participate
|
|
break;
|
|
case 'Group':
|
|
case 'Organisation':
|
|
$roles = ActorLocalRoles::VISITOR; // Can send direct messages to other actors
|
|
if ($object->get('private')) {
|
|
$roles |= ActorLocalRoles::PRIVATE_GROUP;
|
|
}
|
|
break;
|
|
case 'Service':
|
|
default:
|
|
$roles = ActorLocalRoles::NONE;
|
|
}
|
|
|
|
// Actor
|
|
$actor_map = [
|
|
'nickname' => $object->get('preferredUsername'),
|
|
'fullname' => !empty($object->get('name')) ? $object->get('name') : null,
|
|
'created' => new DateTime($object->get('published') ?? 'now'),
|
|
'bio' => $object->get('summary'),
|
|
'is_local' => false, // duh!
|
|
'type' => self::$_as2_actor_type_to_gs_actor_type[$object->get('type')],
|
|
'roles' => $roles,
|
|
'modified' => new DateTime(),
|
|
];
|
|
|
|
$actor = $options['objects']['Actor'] ?? new GSActor();
|
|
|
|
foreach ($actor_map as $prop => $val) {
|
|
$set = Formatting::snakeCaseToCamelCase("set_{$prop}");
|
|
$actor->{$set}($val);
|
|
}
|
|
|
|
if (!isset($options['objects']['Actor'])) {
|
|
DB::wrapInTransaction(fn () => DB::persist($actor));
|
|
}
|
|
|
|
// ActivityPub Actor
|
|
$ap_actor = ActivitypubActor::create([
|
|
'inbox_uri' => $object->get('inbox'),
|
|
'inbox_shared_uri' => ($object->has('endpoints') && isset($object->get('endpoints')['sharedInbox'])) ? $object->get('endpoints')['sharedInbox'] : null,
|
|
'uri' => $object->get('id'),
|
|
'actor_id' => $actor->getId(),
|
|
'url' => $object->get('url') ?? null,
|
|
], $options['objects']['ActivitypubActor'] ?? null);
|
|
|
|
if (!isset($options['objects']['ActivitypubActor'])) {
|
|
DB::wrapInTransaction(fn () => DB::persist($ap_actor));
|
|
}
|
|
|
|
// Public Key
|
|
$apRSA = ActivitypubRsa::create([
|
|
'actor_id' => $actor->getID(),
|
|
'public_key' => ($object->has('publicKey') && isset($object->get('publicKey')['publicKeyPem'])) ? $object->get('publicKey')['publicKeyPem'] : null,
|
|
], $options['objects']['ActivitypubRsa'] ?? null);
|
|
|
|
if (!isset($options['objects']['ActivitypubRsa'])) {
|
|
DB::wrapInTransaction(fn () => DB::persist($apRSA));
|
|
}
|
|
|
|
// Avatar
|
|
if ($object->has('icon') && !empty($object->get('icon'))) {
|
|
try {
|
|
// Retrieve media
|
|
$get_response = HTTPClient::get($object->get('icon')->get('url'));
|
|
$media = $get_response->getContent();
|
|
$mimetype = $get_response->getHeaders()['content-type'][0] ?? null;
|
|
unset($get_response);
|
|
|
|
// Only handle if it is an image
|
|
if (GSFile::mimetypeMajor($mimetype) === 'image') {
|
|
// Ignore empty files
|
|
if (!empty($media)) {
|
|
// Create an attachment for this
|
|
$temp_file = new TemporaryFile();
|
|
$temp_file->write($media);
|
|
$attachment = GSFile::storeFileAsAttachment($temp_file);
|
|
// Delete current avatar if there's one
|
|
if (!\is_null($avatar = DB::findOneBy(\Component\Avatar\Entity\Avatar::class, ['actor_id' => $actor->getId()], return_null: true))) {
|
|
$avatar->delete();
|
|
}
|
|
DB::wrapInTransaction(function () use ($attachment, $actor, $object) {
|
|
DB::persist($attachment);
|
|
DB::persist(\Component\Avatar\Entity\Avatar::create([
|
|
'actor_id' => $actor->getId(),
|
|
'attachment_id' => $attachment->getId(),
|
|
'title' => $object->get('icon')->get('name') ?? null,
|
|
]));
|
|
});
|
|
Event::handle('AvatarUpdate', [$actor->getId()]);
|
|
}
|
|
}
|
|
} catch (Exception $e) {
|
|
// Let the exception go, it isn't a serious issue
|
|
Log::warning('ActivityPub Explorer: An error occurred while grabbing remote avatar: ' . $e->getMessage());
|
|
}
|
|
} else {
|
|
// Delete existing avatar if any
|
|
try {
|
|
$avatar = DB::findOneBy('avatar', ['actor_id' => $actor->getId()]);
|
|
$avatar->delete();
|
|
Event::handle('AvatarUpdate', [$actor->getId()]);
|
|
} catch (Exception) {
|
|
// No avatar set, so cannot delete
|
|
}
|
|
}
|
|
|
|
return $ap_actor;
|
|
}
|
|
|
|
/**
|
|
* Get a JSON
|
|
*
|
|
* @param null|int $options PHP JSON options
|
|
*
|
|
* @throws ServerException
|
|
*/
|
|
public static function toJson(mixed $object, ?int $options = null): string
|
|
{
|
|
if ($object::class !== GSActor::class) {
|
|
throw new InvalidArgumentException('First argument type must be an Actor.');
|
|
}
|
|
$rsa = ActivitypubRsa::getByActor($object);
|
|
$public_key = $rsa->getPublicKey();
|
|
$uri = $object->getUri(Router::ABSOLUTE_URL);
|
|
$attr = [
|
|
'@context' => 'https://www.w3.org/ns/activitystreams',
|
|
'type' => ($object->getType() === GSActor::GROUP) ? (LocalGroup::getByPK(['actor_id' => $object->getId()])->getType() === 'organisation' ? 'Organization' : 'Group'): self::$_gs_actor_type_to_as2_actor_type[$object->getType()],
|
|
'id' => $uri,
|
|
'inbox' => Router::url('activitypub_actor_inbox', ['gsactor_id' => $object->getId()], Router::ABSOLUTE_URL),
|
|
'outbox' => Router::url('activitypub_actor_outbox', ['gsactor_id' => $object->getId()], Router::ABSOLUTE_URL),
|
|
'following' => Router::url('actor_subscriptions_id', ['id' => $object->getId()], Router::ABSOLUTE_URL),
|
|
'followers' => Router::url('actor_subscribers_id', ['id' => $object->getId()], Router::ABSOLUTE_URL),
|
|
'liked' => Router::url('favourites_view_by_actor_id', ['id' => $object->getId()], Router::ABSOLUTE_URL),
|
|
//'streams' =>
|
|
'preferredUsername' => $object->getNickname(),
|
|
'publicKey' => [
|
|
'id' => $uri . '#public-key',
|
|
'owner' => $uri,
|
|
'publicKeyPem' => $public_key,
|
|
],
|
|
'name' => $object->getFullname(),
|
|
'location' => $object->getLocation(),
|
|
'published' => $object->getCreated()->format(DateTimeInterface::RFC3339),
|
|
'summary' => $object->getBio(),
|
|
//'tag' => $object->getSelfTags(),
|
|
'updated' => $object->getModified()->format(DateTimeInterface::RFC3339),
|
|
'url' => $object->getUrl(Router::ABSOLUTE_URL),
|
|
'endpoints' => [
|
|
'sharedInbox' => Router::url('activitypub_inbox', type: Router::ABSOLUTE_URL),
|
|
],
|
|
];
|
|
|
|
// Avatar
|
|
try {
|
|
$avatar = Avatar::getAvatar($object->getId());
|
|
$attr['icon'] = [
|
|
'type' => 'Image',
|
|
'summary' => 'Small Avatar',
|
|
'name' => \is_null($avatar->getTitle()) ? null : 'small-' . $avatar->getTitle(),
|
|
'mediaType' => $avatar->getAttachment()->getMimetype(),
|
|
'url' => $avatar->getUrl(size: 'small', type: Router::ABSOLUTE_URL),
|
|
];
|
|
$attr['image'] = [
|
|
[
|
|
'type' => 'Image',
|
|
'summary' => 'Medium Avatar',
|
|
'name' => \is_null($avatar->getTitle()) ? null : 'medium-' . $avatar->getTitle(),
|
|
'mediaType' => $avatar->getAttachment()->getMimetype(),
|
|
'url' => $avatar->getUrl(size: 'medium', type: Router::ABSOLUTE_URL),
|
|
],
|
|
[
|
|
'type' => 'Image',
|
|
'summary' => 'Full Avatar',
|
|
'name' => $avatar->getTitle(),
|
|
'mediaType' => $avatar->getAttachment()->getMimetype(),
|
|
'url' => $avatar->getUrl(size: 'full', type: Router::ABSOLUTE_URL),
|
|
],
|
|
];
|
|
} catch (Exception) {
|
|
// No icon for this actor
|
|
}
|
|
|
|
if ($object->isGroup()) {
|
|
if ($object->getRoles() & ActorLocalRoles::PRIVATE_GROUP) {
|
|
$attr['private'] = true;
|
|
}
|
|
}
|
|
|
|
$type = self::jsonToType($attr);
|
|
Event::handle('ActivityPubAddActivityStreamsTwoData', [$type->get('type'), &$type]);
|
|
return $type->toJson($options);
|
|
}
|
|
}
|