2021-12-04 04:07:08 +00:00
|
|
|
<?php
|
|
|
|
|
2021-12-26 09:48:16 +00:00
|
|
|
declare(strict_types = 1);
|
2021-12-04 04:07:08 +00:00
|
|
|
|
|
|
|
// {{{ 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
|
2021-12-26 09:48:16 +00:00
|
|
|
*
|
2021-12-04 04:07:08 +00:00
|
|
|
* @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;
|
|
|
|
|
|
|
|
use ActivityPhp\Type;
|
|
|
|
use ActivityPhp\Type\TypeConfiguration;
|
|
|
|
use ActivityPhp\Type\TypeResolver;
|
|
|
|
use App\Core\Entity;
|
|
|
|
use App\Core\Event;
|
|
|
|
use App\Util\Exception\ClientException;
|
|
|
|
use Exception;
|
|
|
|
use InvalidArgumentException;
|
|
|
|
use Plugin\ActivityPub\Util\Model\Activity;
|
|
|
|
use Plugin\ActivityPub\Util\Model\Note;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This class handles translation between JSON and GS Entities
|
|
|
|
*
|
|
|
|
* @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
|
|
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
|
|
*/
|
|
|
|
abstract class Model
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Create a Type from an ActivityStreams 2.0 JSON string
|
|
|
|
*
|
|
|
|
* @throws Exception
|
|
|
|
*/
|
|
|
|
public static function jsonToType(string|array $data): Type\AbstractObject
|
|
|
|
{
|
2021-12-26 09:48:16 +00:00
|
|
|
if (\is_string($data)) {
|
2021-12-04 04:07:08 +00:00
|
|
|
$attributes = json_decode($data, true);
|
2021-12-26 09:48:16 +00:00
|
|
|
if (json_last_error() !== \JSON_ERROR_NONE
|
|
|
|
|| !\is_array($attributes)
|
2021-12-04 04:07:08 +00:00
|
|
|
) {
|
|
|
|
throw new Exception(
|
|
|
|
sprintf(
|
|
|
|
"An error occurred during the JSON decoding.\n '%s'",
|
2021-12-26 09:48:16 +00:00
|
|
|
$data,
|
|
|
|
),
|
2021-12-04 04:07:08 +00:00
|
|
|
);
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
$attributes = $data;
|
|
|
|
}
|
|
|
|
|
2021-12-26 09:48:16 +00:00
|
|
|
if (!\array_key_exists('type', $attributes)) {
|
2021-12-04 04:07:08 +00:00
|
|
|
throw new InvalidArgumentException('Missing "type" attribute in $data: ' . var_export($data, true));
|
|
|
|
}
|
|
|
|
unset($data);
|
|
|
|
|
|
|
|
try {
|
|
|
|
$type = TypeResolver::getClass($attributes['type']);
|
|
|
|
} catch (Exception $e) {
|
2021-12-26 09:48:16 +00:00
|
|
|
$message = json_encode($attributes, \JSON_PRETTY_PRINT);
|
2021-12-04 04:07:08 +00:00
|
|
|
throw new Exception(
|
2021-12-26 09:48:16 +00:00
|
|
|
$e->getMessage() . "\n{$message}",
|
2021-12-04 04:07:08 +00:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2021-12-26 09:48:16 +00:00
|
|
|
if (\is_string($type)) {
|
2021-12-04 04:07:08 +00:00
|
|
|
$type = new $type();
|
|
|
|
}
|
|
|
|
|
|
|
|
// Add our own extensions
|
|
|
|
$validators = [];
|
|
|
|
if (Event::handle('ActivityPubValidateActivityStreamsTwoData', [$attributes['type'], &$validators]) === Event::next) {
|
|
|
|
foreach ($validators as $name => $class) {
|
|
|
|
Type::addValidator($name, $class);
|
|
|
|
$type->extend($name);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
TypeConfiguration::set('undefined_properties', 'include');
|
|
|
|
foreach ($attributes as $name => $value) {
|
|
|
|
$type->set($name, $value);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $type;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create an Entity from an ActivityStreams 2.0 JSON string
|
|
|
|
*/
|
|
|
|
abstract public static function fromJson(string|Type\AbstractObject $json, array $options = []): Entity;
|
|
|
|
|
|
|
|
/**
|
2022-03-28 20:58:48 +01:00
|
|
|
* Get a Type
|
2021-12-26 09:48:16 +00:00
|
|
|
*
|
2022-03-28 20:58:48 +01:00
|
|
|
* @throws \App\Util\Exception\ServerException
|
2021-12-04 04:07:08 +00:00
|
|
|
* @throws ClientException
|
|
|
|
*/
|
2022-03-28 20:58:48 +01:00
|
|
|
public static function toType(mixed $object): Type\AbstractObject
|
2021-12-04 04:07:08 +00:00
|
|
|
{
|
|
|
|
switch ($object::class) {
|
2021-12-28 16:44:38 +00:00
|
|
|
case \App\Entity\Activity::class:
|
2022-03-28 20:58:48 +01:00
|
|
|
return Activity::toType($object);
|
2021-12-28 16:44:38 +00:00
|
|
|
case \App\Entity\Note::class:
|
2022-03-28 20:58:48 +01:00
|
|
|
return Note::toType($object);
|
2021-12-04 04:07:08 +00:00
|
|
|
default:
|
|
|
|
$type = self::jsonToType($object);
|
|
|
|
Event::handle('ActivityPubAddActivityStreamsTwoData', [$type->get('type'), &$type]);
|
2022-03-28 20:58:48 +01:00
|
|
|
return $type;
|
2021-12-04 04:07:08 +00:00
|
|
|
}
|
|
|
|
}
|
2022-03-28 20:58:48 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a JSON
|
|
|
|
*
|
|
|
|
* @param int $options PHP JSON options
|
|
|
|
*
|
|
|
|
* @throws \App\Util\Exception\ServerException
|
|
|
|
* @throws ClientException
|
|
|
|
*/
|
|
|
|
public static function toJson(mixed $object, int $options = \JSON_UNESCAPED_SLASHES): string
|
|
|
|
{
|
|
|
|
return self::toType($object)->toJson($options);
|
|
|
|
}
|
2021-12-26 09:48:16 +00:00
|
|
|
}
|