social/lib/Model/ActivityPub/ACore.php

959 wiersze
16 KiB
PHP

<?php
declare(strict_types=1);
/**
* Nextcloud - Social Support
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
* @license GNU AGPL version 3 or any later version
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Social\Model\ActivityPub;
use daita\MySmallPhpTools\Traits\TArrayTools;
use daita\MySmallPhpTools\Traits\TPathTools;
use JsonSerializable;
use OCA\Social\Exceptions\ActivityCantBeVerifiedException;
use OCA\Social\Exceptions\UrlCloudException;
use OCA\Social\Model\InstancePath;
use OCA\Social\Service\ICoreService;
abstract class ACore implements JsonSerializable {
use TArrayTools;
use TPathTools;
const CONTEXT_ACTIVITYSTREAMS = 'https://www.w3.org/ns/activitystreams';
const CONTEXT_SECURITY = 'https://w3id.org/security/v1';
/** @var string */
private $urlSocial = '';
/** @var string */
private $urlCloud = '';
// /** @var bool */
// private $isTopLevel = false;
/** @var array */
private $meta = [];
/** @var string */
private $address = '';
/** @var string */
private $id = '';
/** @var string */
private $type = '';
/** @var string */
private $url = '';
/** @var string */
private $summary = '';
/** @var InstancePath[] */
private $instancePaths = [];
/** @var string */
private $to = '';
/** @var array */
private $toArray = [];
/** @var array */
private $cc = [];
/** @var array */
private $bcc = [];
/** @var string */
private $published = '';
/** @var array */
private $tags = [];
/** @var array */
private $entries = [];
/** @var Person */
private $actor = null;
/** @var string */
private $actorId = '';
/** @var Document */
private $icon = null;
/** @var ACore */
private $object = null;
/** @var string */
private $objectId = '';
/** @var ICoreService */
private $saveAs;
/** @var bool */
private $completeDetails = false;
/** @var string */
private $source = '';
/** @var null ACore */
private $parent = null;
/** @var bool */
private $local = false;
/**
* Core constructor.
*
* @param ACore $parent
*/
public function __construct($parent = null) {
// $this->isTopLevel = $isTopLevel;
if ($parent instanceof ACore) {
$this->setParent($parent);
}
}
/**
* @return string
*/
public function getId(): string {
return $this->id;
}
/**
* @param string $id
*
* @return ACore
*/
public function setId(string $id): ACore {
$this->id = $id;
return $this;
}
/**
* @param string $base
*
* @throws UrlCloudException
*/
public function generateUniqueId(string $base = '') {
if ($this->getUrlCloud() === '') {
throw new UrlCloudException();
}
if ($base !== '') {
$base = $this->withoutEndSlash($this->withBeginSlash($base));
}
$uuid = sprintf(
'%04x%04x-%04x-%04x-%04x-%04x%04x%04x', mt_rand(0, 0xffff), mt_rand(0, 0xffff),
mt_rand(0, 0xffff), mt_rand(0, 0xfff) | 0x4000, mt_rand(0, 0x3fff) | 0x8000,
mt_rand(0, 0xffff), mt_rand(0, 0xffff), mt_rand(0, 0xffff)
);
$this->setId($this->getUrlCloud() . $base . '/' . $uuid);
}
/**
* @return string
*/
public function getType(): string {
return $this->type;
}
/**
* @param string $type
*
* @return ACore
*/
public function setType(string $type): ACore {
// if ($type !== '') {
$this->type = $type;
// }
return $this;
}
/**
* @param string $url
*
* @throws ActivityCantBeVerifiedException
*/
public function verify(string $url) {
$url1 = parse_url($this->getId());
$url2 = parse_url($url);
if ($this->get('host', $url1, '1') !== $this->get('host', $url2, '2')) {
throw new ActivityCantBeVerifiedException('activity cannot be verified');
}
if ($this->get('scheme', $url1, '1') !== $this->get('scheme', $url2, '2')) {
throw new ActivityCantBeVerifiedException('activity cannot be verified');
}
if ($this->getInt('port', $url1, 1) !== $this->getInt('port', $url2, 1)) {
throw new ActivityCantBeVerifiedException('activity cannot be verified');
}
}
/**
* @return string
*/
public function getUrl(): string {
return $this->url;
}
/**
* @param string $url
*
* @return ACore
*/
public function setUrl(string $url): ACore {
$this->url = $url;
return $this;
}
/**
* @param InstancePath $instancePath
*
* @return ACore
*/
public function addInstancePath(InstancePath $instancePath): ACore {
if ($instancePath->getUri() !== '') {
$this->instancePaths[] = $instancePath;
}
return $this;
}
/**
* @param InstancePath[] $path
*
* @return ACore
*/
public function addInstancePaths(array $path): ACore {
$this->instancePaths = array_merge($this->instancePaths, $path);
return $this;
}
/**
* @return InstancePath[]
*/
public function getInstancePaths(): array {
return $this->instancePaths;
}
/**
* @param InstancePath[] $instancePaths
*
* @return ACore
*/
public function setInstancePaths(array $instancePaths): ACore {
$this->instancePaths = $instancePaths;
return $this;
}
/**
* @return string
*/
public function getSummary(): string {
return $this->summary;
}
/**
* @param string $summary
*
* @return ACore
*/
public function setSummary(string $summary): ACore {
$this->summary = $summary;
return $this;
}
/**
* @return Person
*/
public function getActor(): Person {
return $this->actor;
}
/**
* @param Person $actor
*
* @return ACore
*/
public function setActor(Person $actor): ACore {
$this->actor = $actor;
return $this;
}
/**
* @return bool
*/
public function gotActor(): bool {
if ($this->actor === null) {
return false;
}
return true;
}
/**
* @param string $actorId
*
* @return ACore
*/
public function setActorId(string $actorId): ACore {
$this->actorId = $actorId;
return $this;
}
/**
* @return string
*/
public function getActorId(): string {
return $this->actorId;
}
/**
* @return string
*/
public function getUrlSocial(): string {
return $this->urlSocial;
}
/**
* @param string $path
*
* @return ACore
*/
public function setUrlSocial(string $path): ACore {
$this->urlSocial = $path;
return $this;
}
/**
* @return string
*/
public function getUrlCloud(): string {
return $this->urlCloud;
}
/**
* @param string $path
*
* @return ACore
*/
public function setUrlCloud(string $path): ACore {
$this->urlCloud = $path;
return $this;
}
/**
* @return string
*/
public function getAddress(): string {
return $this->address;
}
/**
* @param string $address
*
* @return ACore
*/
public function setAddress(string $address) {
$this->address = $address;
return $this;
}
/**
* @return string
*/
public function getTo(): string {
return $this->to;
}
/**
* @param string $to
*
* @return ACore
*/
public function setTo(string $to): ACore {
$this->to = $to;
return $this;
}
/**
* @return array
*/
public function getToArray(): array {
return $this->toArray;
}
/**
* @param string $to
*
* @return ACore
*/
public function addToArray(string $to): ACore {
$this->toArray[] = $to;
return $this;
}
/**
* @param array $toArray
*
* @return ACore
*/
public function setToArray(array $toArray): ACore {
$this->toArray = $toArray;
return $this;
}
public function addCc(string $cc): Acore {
$this->cc[] = $cc;
return $this;
}
/**
* @return array
*/
public function getCcArray(): array {
return $this->cc;
}
/**
* @param array $cc
*
* @return ACore
*/
public function setCcArray(array $cc): ACore {
$this->cc = $cc;
return $this;
}
/**
* @return array
*/
public function getBccArray(): array {
return $this->bcc;
}
/**
* @param array $bcc
*
* @return ACore
*/
public function setBccArray(array $bcc): ACore {
$this->bcc = $bcc;
return $this;
}
/**
* @param string $published
*
* @return ACore
*/
public function setPublished(string $published): ACore {
$this->published = $published;
return $this;
}
/**
* @return string
*/
public function getPublished(): string {
return $this->published;
}
/**
* @param array $tag
*
* @return ACore
*/
public function addTag(array $tag): ACore {
$this->tags[] = $tag;
return $this;
}
/**
* @return array
*/
public function getTags(): array {
return $this->tags;
}
/**
* @param array $tag
*
* @return ACore
*/
public function setTags(array $tag): ACore {
$this->tags = $tag;
return $this;
}
/**
* @return bool
*/
public function gotObject(): bool {
if ($this->object === null) {
return false;
}
return true;
}
/**
* @return ACore
*/
public function getObject(): ACore {
return $this->object;
}
/**
* @param ACore $object
*
* @return ACore
*/
public function setObject(ACore $object): ACore {
$this->object = $object;
return $this;
}
/**
* @return string
*/
public function getObjectId(): string {
return $this->objectId;
}
/**
* @param string $objectId
*
* @return ACore
*/
public function setObjectId(string $objectId): ACore {
$this->objectId = $objectId;
return $this;
}
/**
* @return bool
*/
public function gotIcon(): bool {
if ($this->icon === null) {
return false;
}
return true;
}
/**
* @return Document
*/
public function getIcon(): Document {
return $this->icon;
}
/**
* @param Document $icon
*
* @return ACore
*/
public function setIcon(Document $icon): ACore {
$this->icon = $icon;
return $this;
}
/**
* @return bool
*/
public function isLocal(): bool {
return $this->local;
}
/**
* @param bool $local
*
* @return Person
*/
public function setLocal(bool $local): ACore {
$this->local = $local;
return $this;
}
/**
* @param ACore $parent
*
* @return ACore
*/
public function setParent(ACore $parent): ACore {
$this->parent = $parent;
return $this;
}
/**
* @return ACore
*/
public function getParent(): ACore {
return $this->parent;
}
/**
* @return bool
*/
public function isRoot(): bool {
return ($this->parent === null);
}
/**
* @param array $chain
*
* @return ACore
*/
public function getRoot(array &$chain = []): ACore {
$chain[] = $this;
if ($this->isRoot()) {
return $this;
}
return $this->getParent()
->getRoot($chain);
}
/**
* @param array $arr
*
* @return ACore
*/
public function setEntries(array $arr): ACore {
$this->entries = $arr;
return $this;
}
/**
* @return array
*/
public function getEntries(): array {
return $this->entries;
}
/**
* @param string $k
* @param string $v
*
* @return ACore
*/
public function addEntry(string $k, string $v): ACore {
if ($v === '') {
// unset($this->entries[$k]);
return $this;
}
$this->entries[$k] = $v;
return $this;
}
/**
* @param string $k
* @param int $v
*
* @return ACore
*/
public function addEntryInt(string $k, int $v): ACore {
if ($v === 0) {
return $this;
}
$this->entries[$k] = $v;
return $this;
}
/**
* @param string $k
* @param bool $v
*
* @return ACore
*/
public function addEntryBool(string $k, bool $v): ACore {
if ($v === 0) {
return $this;
}
$this->entries[$k] = $v;
return $this;
}
/**
* @param string $k
* @param array $v
*
* @return ACore
*/
public function addEntryArray(string $k, array $v): ACore {
if ($v === []) {
// unset($this->entries[$k]);
return $this;
}
$this->entries[$k] = $v;
return $this;
}
/**
* @param string $k
* @param ACore $v
*
* @return ACore
*/
public function addEntryItem(string $k, ACore $v): ACore {
if ($v === null) {
// unset($this->entries[$k]);
return $this;
}
$this->entries[$k] = $v;
return $this;
}
/**
* @param ICoreService $class
*/
public function saveAs(ICoreService $class) {
$this->saveAs = $class;
}
/**
* @return ICoreService
*/
public function savingAs() {
return $this->saveAs;
}
/**
* @return bool
*/
public function isCompleteDetails(): bool {
return $this->completeDetails;
}
/**
* @param bool $completeDetails
*
* @return ACore
*/
public function setCompleteDetails(bool $completeDetails): ACore {
$this->completeDetails = $completeDetails;
return $this;
}
/**
* @return string
*/
public function getSource(): string {
return $this->source;
}
/**
* @param string $source
*
* @return ACore
*/
public function setSource(string $source): ACore {
$this->source = $source;
return $this;
}
/**
* @param array $data
*/
public function import(array $data) {
$this->setId($this->get('id', $data, ''));
$this->setType($this->get('type', $data, ''));
$this->setUrl($this->get('url', $data, ''));
$this->setSummary($this->get('summary', $data, ''));
$this->setToArray($this->getArray('to', $data, []));
$this->setCcArray($this->getArray('cc', $data, []));
$this->setPublished($this->get('published', $data, ''));
$this->setActorId($this->get('actor', $data, ''));
$this->setObjectId($this->get('object', $data, ''));
$this->setLocal(($this->getInt('local', $data, 0) === 1));
}
/**
* @param array $data
*/
public function importFromDatabase(array $data) {
$this->setId($this->get('id', $data, ''));
$this->setType($this->get('type', $data, ''));
$this->setUrl($this->get('url', $data, ''));
$this->setSummary($this->get('summary', $data, ''));
$this->setToArray($this->getArray('to', $data, []));
$this->setCcArray($this->getArray('cc', $data, []));
$this->setPublished($this->get('published', $data, ''));
$this->setActorId($this->get('actor', $data, ''));
$this->setObjectId($this->get('object', $data, ''));
$this->setSource($this->get('source', $data, ''));
$this->setLocal(($this->getInt('local', $data, 0) === 1));
}
/**
* @return array
*/
public function jsonSerialize(): array {
if ($this->isRoot()) {
$this->addEntryArray(
'@context', [
self::CONTEXT_ACTIVITYSTREAMS,
self::CONTEXT_SECURITY
]
);
}
$this->addEntry('id', $this->getId());
$this->addEntry('type', $this->getType());
$this->addEntry('url', $this->getUrl());
$this->addEntry('to', $this->getTo());
$this->addEntryArray('to', $this->getToArray());
$this->addEntryArray('cc', $this->getCcArray());
if ($this->gotActor()) {
$this->addEntry(
'actor', $this->getActor()
->getId()
);
if ($this->isCompleteDetails()) {
$this->addEntryItem('actor_info', $this->getActor());
}
} else {
$this->addEntry('actor', $this->getActorId());
}
$this->addEntry('summary', $this->getSummary());
$this->addEntry('published', $this->getPublished());
$this->addEntryArray('tag', $this->getTags());
// $arr = $this->getEntries();
if ($this->gotObject()) {
$this->addEntryItem('object', $this->getObject());
} else {
$this->addEntry('object', $this->getObjectId());
}
if ($this->gotIcon()) {
$this->addEntryItem('icon', $this->getIcon());
}
if ($this->isCompleteDetails()) {
$this->addEntry('source', $this->getSource());
}
if ($this->isLocal()) {
$this->addEntryBool('local', $this->isLocal());
}
return $this->getEntries();
}
}