diff options
Diffstat (limited to 'lib/private/Activity/Event.php')
| -rw-r--r-- | lib/private/Activity/Event.php | 472 |
1 files changed, 472 insertions, 0 deletions
diff --git a/lib/private/Activity/Event.php b/lib/private/Activity/Event.php new file mode 100644 index 00000000000..0ccad1d0a4e --- /dev/null +++ b/lib/private/Activity/Event.php @@ -0,0 +1,472 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only + */ +namespace OC\Activity; + +use OCP\Activity\Exceptions\InvalidValueException; +use OCP\Activity\IEvent; +use OCP\RichObjectStrings\InvalidObjectExeption; +use OCP\RichObjectStrings\IRichTextFormatter; +use OCP\RichObjectStrings\IValidator; + +class Event implements IEvent { + /** @var string */ + protected $app = ''; + /** @var string */ + protected $type = ''; + /** @var string */ + protected $affectedUser = ''; + /** @var string */ + protected $author = ''; + /** @var int */ + protected $timestamp = 0; + /** @var string */ + protected $subject = ''; + /** @var array */ + protected $subjectParameters = []; + /** @var string */ + protected $subjectParsed = ''; + /** @var string */ + protected $subjectRich = ''; + /** @var array<string, array<string, string>> */ + protected $subjectRichParameters = []; + /** @var string */ + protected $message = ''; + /** @var array */ + protected $messageParameters = []; + /** @var string */ + protected $messageParsed = ''; + /** @var string */ + protected $messageRich = ''; + /** @var array<string, array<string, string>> */ + protected $messageRichParameters = []; + /** @var string */ + protected $objectType = ''; + /** @var int */ + protected $objectId = 0; + /** @var string */ + protected $objectName = ''; + /** @var string */ + protected $link = ''; + /** @var string */ + protected $icon = ''; + /** @var bool */ + protected $generateNotification = true; + + /** @var IEvent|null */ + protected $child; + + public function __construct( + protected IValidator $richValidator, + protected IRichTextFormatter $richTextFormatter, + ) { + } + + /** + * {@inheritDoc} + */ + public function setApp(string $app): IEvent { + if ($app === '' || isset($app[32])) { + throw new InvalidValueException('app'); + } + $this->app = $app; + return $this; + } + + /** + * @return string + */ + public function getApp(): string { + return $this->app; + } + + /** + * {@inheritDoc} + */ + public function setType(string $type): IEvent { + if ($type === '' || isset($type[255])) { + throw new InvalidValueException('type'); + } + $this->type = $type; + return $this; + } + + /** + * @return string + */ + public function getType(): string { + return $this->type; + } + + /** + * {@inheritDoc} + */ + public function setAffectedUser(string $affectedUser): IEvent { + if ($affectedUser === '' || isset($affectedUser[64])) { + throw new InvalidValueException('affectedUser'); + } + $this->affectedUser = $affectedUser; + return $this; + } + + /** + * @return string + */ + public function getAffectedUser(): string { + return $this->affectedUser; + } + + /** + * {@inheritDoc} + */ + public function setAuthor(string $author): IEvent { + if (isset($author[64])) { + throw new InvalidValueException('author'); + } + $this->author = $author; + return $this; + } + + /** + * @return string + */ + public function getAuthor(): string { + return $this->author; + } + + /** + * {@inheritDoc} + */ + public function setTimestamp(int $timestamp): IEvent { + if ($timestamp < 0) { + throw new InvalidValueException('timestamp'); + } + $this->timestamp = $timestamp; + return $this; + } + + /** + * @return int + */ + public function getTimestamp(): int { + return $this->timestamp; + } + + /** + * {@inheritDoc} + */ + public function setSubject(string $subject, array $parameters = []): IEvent { + if (isset($subject[255])) { + throw new InvalidValueException('subject'); + } + $this->subject = $subject; + $this->subjectParameters = $parameters; + return $this; + } + + /** + * @return string + */ + public function getSubject(): string { + return $this->subject; + } + + /** + * @return array + */ + public function getSubjectParameters(): array { + return $this->subjectParameters; + } + + /** + * {@inheritDoc} + */ + public function setParsedSubject(string $subject): IEvent { + if ($subject === '') { + throw new InvalidValueException('parsedSubject'); + } + $this->subjectParsed = $subject; + return $this; + } + + /** + * @return string + * @since 11.0.0 + */ + public function getParsedSubject(): string { + return $this->subjectParsed; + } + + /** + * {@inheritDoc} + */ + public function setRichSubject(string $subject, array $parameters = []): IEvent { + if ($subject === '') { + throw new InvalidValueException('richSubject'); + } + $this->subjectRich = $subject; + $this->subjectRichParameters = $parameters; + + if ($this->subjectParsed === '') { + try { + $this->subjectParsed = $this->richTextFormatter->richToParsed($subject, $parameters); + } catch (\InvalidArgumentException $e) { + throw new InvalidValueException('richSubjectParameters', $e); + } + } + + return $this; + } + + /** + * @return string + * @since 11.0.0 + */ + public function getRichSubject(): string { + return $this->subjectRich; + } + + /** + * @return array<string, array<string, string>> + * @since 11.0.0 + */ + public function getRichSubjectParameters(): array { + return $this->subjectRichParameters; + } + + /** + * {@inheritDoc} + */ + public function setMessage(string $message, array $parameters = []): IEvent { + if (isset($message[255])) { + throw new InvalidValueException('message'); + } + $this->message = $message; + $this->messageParameters = $parameters; + return $this; + } + + /** + * @return string + */ + public function getMessage(): string { + return $this->message; + } + + /** + * @return array + */ + public function getMessageParameters(): array { + return $this->messageParameters; + } + + /** + * {@inheritDoc} + */ + public function setParsedMessage(string $message): IEvent { + $this->messageParsed = $message; + return $this; + } + + /** + * @return string + * @since 11.0.0 + */ + public function getParsedMessage(): string { + return $this->messageParsed; + } + + /** + * {@inheritDoc} + */ + public function setRichMessage(string $message, array $parameters = []): IEvent { + $this->messageRich = $message; + $this->messageRichParameters = $parameters; + + if ($this->messageParsed === '') { + try { + $this->messageParsed = $this->richTextFormatter->richToParsed($message, $parameters); + } catch (\InvalidArgumentException $e) { + throw new InvalidValueException('richMessageParameters', $e); + } + } + + return $this; + } + + /** + * @return string + * @since 11.0.0 + */ + public function getRichMessage(): string { + return $this->messageRich; + } + + /** + * @return array<string, array<string, string>> + * @since 11.0.0 + */ + public function getRichMessageParameters(): array { + return $this->messageRichParameters; + } + + /** + * {@inheritDoc} + */ + public function setObject(string $objectType, int $objectId, string $objectName = ''): IEvent { + if (isset($objectType[255])) { + throw new InvalidValueException('objectType'); + } + if (isset($objectName[4000])) { + throw new InvalidValueException('objectName'); + } + $this->objectType = $objectType; + $this->objectId = $objectId; + $this->objectName = $objectName; + return $this; + } + + /** + * @return string + */ + public function getObjectType(): string { + return $this->objectType; + } + + /** + * @return int + */ + public function getObjectId(): int { + return $this->objectId; + } + + /** + * @return string + */ + public function getObjectName(): string { + return $this->objectName; + } + + /** + * {@inheritDoc} + */ + public function setLink(string $link): IEvent { + if (isset($link[4000])) { + throw new InvalidValueException('link'); + } + $this->link = $link; + return $this; + } + + /** + * @return string + */ + public function getLink(): string { + return $this->link; + } + + /** + * {@inheritDoc} + */ + public function setIcon(string $icon): IEvent { + if (isset($icon[4000])) { + throw new InvalidValueException('icon'); + } + $this->icon = $icon; + return $this; + } + + /** + * @return string + * @since 11.0.0 + */ + public function getIcon(): string { + return $this->icon; + } + + /** + * @param IEvent $child + * @return $this + * @since 11.0.0 - Since 15.0.0 returns $this + */ + public function setChildEvent(IEvent $child): IEvent { + $this->child = $child; + return $this; + } + + /** + * @return IEvent|null + * @since 11.0.0 + */ + public function getChildEvent() { + return $this->child; + } + + /** + * @return bool + * @since 8.2.0 + */ + public function isValid(): bool { + return + $this->isValidCommon() + && $this->getSubject() !== '' + ; + } + + /** + * @return bool + * @since 8.2.0 + */ + public function isValidParsed(): bool { + if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) { + try { + $this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters()); + } catch (InvalidObjectExeption $e) { + return false; + } + } + + if ($this->getRichMessage() !== '' || !empty($this->getRichMessageParameters())) { + try { + $this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters()); + } catch (InvalidObjectExeption $e) { + return false; + } + } + + return + $this->isValidCommon() + && $this->getParsedSubject() !== '' + ; + } + + protected function isValidCommon(): bool { + return + $this->getApp() !== '' + && $this->getType() !== '' + && $this->getTimestamp() !== 0 + /** + * Disabled for BC with old activities + * && + * $this->getObjectType() !== '' + * && + * $this->getObjectId() !== 0 + */ + ; + } + + public function setGenerateNotification(bool $generate): IEvent { + $this->generateNotification = $generate; + return $this; + } + + public function getGenerateNotification(): bool { + return $this->generateNotification; + } +} |