diff options
Diffstat (limited to 'lib/private/Notification/Notification.php')
| -rw-r--r-- | lib/private/Notification/Notification.php | 386 |
1 files changed, 141 insertions, 245 deletions
diff --git a/lib/private/Notification/Notification.php b/lib/private/Notification/Notification.php index 3e5cf1d6934..fcce7fd0020 100644 --- a/lib/private/Notification/Notification.php +++ b/lib/private/Notification/Notification.php @@ -1,240 +1,150 @@ <?php declare(strict_types=1); - /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Joas Schilling <coding@schilljs.com> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * 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, version 3, - * along with this program. If not, see <http://www.gnu.org/licenses/> - * + * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ namespace OC\Notification; use OCP\Notification\IAction; use OCP\Notification\INotification; +use OCP\Notification\InvalidValueException; use OCP\RichObjectStrings\InvalidObjectExeption; +use OCP\RichObjectStrings\IRichTextFormatter; use OCP\RichObjectStrings\IValidator; class Notification implements INotification { - - /** @var IValidator */ - protected $richValidator; - - /** @var string */ - protected $app; - - /** @var string */ - protected $user; - - /** @var \DateTime */ - protected $dateTime; - - /** @var string */ - protected $objectType; - - /** @var string */ - protected $objectId; - - /** @var string */ - protected $subject; - - /** @var array */ - protected $subjectParameters; - - /** @var string */ - protected $subjectParsed; - - /** @var string */ - protected $subjectRich; - - /** @var array */ - protected $subjectRichParameters; - - /** @var string */ - protected $message; - - /** @var array */ - protected $messageParameters; - - /** @var string */ - protected $messageParsed; - - /** @var string */ - protected $messageRich; - - /** @var array */ - protected $messageRichParameters; - - /** @var string */ - protected $link; - - /** @var string */ - protected $icon; - - /** @var array */ - protected $actions; - - /** @var array */ - protected $actionsParsed; - - /** @var bool */ - protected $hasPrimaryAction; - - /** @var bool */ - protected $hasPrimaryParsedAction; - - public function __construct(IValidator $richValidator) { - $this->richValidator = $richValidator; - $this->app = ''; - $this->user = ''; + /** + * A very small and privileged list of apps that are allowed to push during DND. + */ + public const PRIORITY_NOTIFICATION_APPS = [ + 'spreed', + 'twofactor_nextcloud_notification', + ]; + + protected string $app = ''; + protected string $user = ''; + protected \DateTime $dateTime; + protected string $objectType = ''; + protected string $objectId = ''; + protected string $subject = ''; + protected array $subjectParameters = []; + protected string $subjectParsed = ''; + protected string $subjectRich = ''; + protected array $subjectRichParameters = []; + protected string $message = ''; + protected array $messageParameters = []; + protected string $messageParsed = ''; + protected string $messageRich = ''; + protected array $messageRichParameters = []; + protected string $link = ''; + protected string $icon = ''; + protected bool $priorityNotification = false; + protected array $actions = []; + protected array $actionsParsed = []; + protected bool $hasPrimaryAction = false; + protected bool $hasPrimaryParsedAction = false; + + public function __construct( + protected IValidator $richValidator, + protected IRichTextFormatter $richTextFormatter, + ) { $this->dateTime = new \DateTime(); $this->dateTime->setTimestamp(0); - $this->objectType = ''; - $this->objectId = ''; - $this->subject = ''; - $this->subjectParameters = []; - $this->subjectParsed = ''; - $this->subjectRich = ''; - $this->subjectRichParameters = []; - $this->message = ''; - $this->messageParameters = []; - $this->messageParsed = ''; - $this->messageRich = ''; - $this->messageRichParameters = []; - $this->link = ''; - $this->icon = ''; - $this->actions = []; - $this->actionsParsed = []; - } - - /** - * @param string $app - * @return $this - * @throws \InvalidArgumentException if the app id is invalid - * @since 8.2.0 + } + + /** + * {@inheritDoc} */ public function setApp(string $app): INotification { if ($app === '' || isset($app[32])) { - throw new \InvalidArgumentException('The given app name is invalid'); + throw new InvalidValueException('app'); } $this->app = $app; return $this; } /** - * @return string - * @since 8.2.0 + * {@inheritDoc} */ public function getApp(): string { return $this->app; } /** - * @param string $user - * @return $this - * @throws \InvalidArgumentException if the user id is invalid - * @since 8.2.0 + * {@inheritDoc} */ public function setUser(string $user): INotification { if ($user === '' || isset($user[64])) { - throw new \InvalidArgumentException('The given user id is invalid'); + throw new InvalidValueException('user'); } $this->user = $user; return $this; } /** - * @return string - * @since 8.2.0 + * {@inheritDoc} */ public function getUser(): string { return $this->user; } /** - * @param \DateTime $dateTime - * @return $this - * @throws \InvalidArgumentException if the $dateTime is invalid - * @since 9.0.0 + * {@inheritDoc} */ public function setDateTime(\DateTime $dateTime): INotification { if ($dateTime->getTimestamp() === 0) { - throw new \InvalidArgumentException('The given date time is invalid'); + throw new InvalidValueException('dateTime'); } $this->dateTime = $dateTime; return $this; } /** - * @return \DateTime - * @since 9.0.0 + * {@inheritDoc} */ public function getDateTime(): \DateTime { return $this->dateTime; } /** - * @param string $type - * @param string $id - * @return $this - * @throws \InvalidArgumentException if the object type or id is invalid - * @since 8.2.0 - 9.0.0: Type of $id changed to string + * {@inheritDoc} */ public function setObject(string $type, string $id): INotification { if ($type === '' || isset($type[64])) { - throw new \InvalidArgumentException('The given object type is invalid'); + throw new InvalidValueException('objectType'); } $this->objectType = $type; if ($id === '' || isset($id[64])) { - throw new \InvalidArgumentException('The given object id is invalid'); + throw new InvalidValueException('objectId'); } $this->objectId = $id; return $this; } /** - * @return string - * @since 8.2.0 + * {@inheritDoc} */ public function getObjectType(): string { return $this->objectType; } /** - * @return string - * @since 8.2.0 - 9.0.0: Return type changed to string + * {@inheritDoc} */ public function getObjectId(): string { return $this->objectId; } /** - * @param string $subject - * @param array $parameters - * @return $this - * @throws \InvalidArgumentException if the subject or parameters are invalid - * @since 8.2.0 + * {@inheritDoc} */ public function setSubject(string $subject, array $parameters = []): INotification { if ($subject === '' || isset($subject[64])) { - throw new \InvalidArgumentException('The given subject is invalid'); + throw new InvalidValueException('subject'); } $this->subject = $subject; @@ -244,87 +154,79 @@ class Notification implements INotification { } /** - * @return string - * @since 8.2.0 + * {@inheritDoc} */ public function getSubject(): string { return $this->subject; } /** - * @return array - * @since 8.2.0 + * {@inheritDoc} */ public function getSubjectParameters(): array { return $this->subjectParameters; } /** - * @param string $subject - * @return $this - * @throws \InvalidArgumentException if the subject is invalid - * @since 8.2.0 + * {@inheritDoc} */ public function setParsedSubject(string $subject): INotification { if ($subject === '') { - throw new \InvalidArgumentException('The given parsed subject is invalid'); + throw new InvalidValueException('parsedSubject'); } $this->subjectParsed = $subject; return $this; } /** - * @return string - * @since 8.2.0 + * {@inheritDoc} */ public function getParsedSubject(): string { return $this->subjectParsed; } /** - * @param string $subject - * @param array $parameters - * @return $this - * @throws \InvalidArgumentException if the subject or parameters are invalid - * @since 11.0.0 + * {@inheritDoc} */ public function setRichSubject(string $subject, array $parameters = []): INotification { if ($subject === '') { - throw new \InvalidArgumentException('The given parsed subject is invalid'); + 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 + * {@inheritDoc} */ public function getRichSubject(): string { return $this->subjectRich; } /** - * @return array[] - * @since 11.0.0 + * {@inheritDoc} */ public function getRichSubjectParameters(): array { return $this->subjectRichParameters; } /** - * @param string $message - * @param array $parameters - * @return $this - * @throws \InvalidArgumentException if the message or parameters are invalid - * @since 8.2.0 + * {@inheritDoc} */ public function setMessage(string $message, array $parameters = []): INotification { if ($message === '' || isset($message[64])) { - throw new \InvalidArgumentException('The given message is invalid'); + throw new InvalidValueException('message'); } $this->message = $message; @@ -334,143 +236,146 @@ class Notification implements INotification { } /** - * @return string - * @since 8.2.0 + * {@inheritDoc} */ public function getMessage(): string { return $this->message; } /** - * @return array - * @since 8.2.0 + * {@inheritDoc} */ public function getMessageParameters(): array { return $this->messageParameters; } /** - * @param string $message - * @return $this - * @throws \InvalidArgumentException if the message is invalid - * @since 8.2.0 + * {@inheritDoc} */ public function setParsedMessage(string $message): INotification { if ($message === '') { - throw new \InvalidArgumentException('The given parsed message is invalid'); + throw new InvalidValueException('parsedMessage'); } $this->messageParsed = $message; return $this; } /** - * @return string - * @since 8.2.0 + * {@inheritDoc} */ public function getParsedMessage(): string { return $this->messageParsed; } /** - * @param string $message - * @param array $parameters - * @return $this - * @throws \InvalidArgumentException if the message or parameters are invalid - * @since 11.0.0 + * {@inheritDoc} */ public function setRichMessage(string $message, array $parameters = []): INotification { if ($message === '') { - throw new \InvalidArgumentException('The given parsed message is invalid'); + throw new InvalidValueException('richMessage'); } $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 + * {@inheritDoc} */ public function getRichMessage(): string { return $this->messageRich; } /** - * @return array[] - * @since 11.0.0 + * {@inheritDoc} */ public function getRichMessageParameters(): array { return $this->messageRichParameters; } /** - * @param string $link - * @return $this - * @throws \InvalidArgumentException if the link is invalid - * @since 8.2.0 + * {@inheritDoc} */ public function setLink(string $link): INotification { if ($link === '' || isset($link[4000])) { - throw new \InvalidArgumentException('The given link is invalid'); + throw new InvalidValueException('link'); } $this->link = $link; return $this; } /** - * @return string - * @since 8.2.0 + * {@inheritDoc} */ public function getLink(): string { return $this->link; } /** - * @param string $icon - * @return $this - * @throws \InvalidArgumentException if the icon is invalid - * @since 11.0.0 + * {@inheritDoc} */ public function setIcon(string $icon): INotification { if ($icon === '' || isset($icon[4000])) { - throw new \InvalidArgumentException('The given icon is invalid'); + throw new InvalidValueException('icon'); } $this->icon = $icon; return $this; } /** - * @return string - * @since 11.0.0 + * {@inheritDoc} */ public function getIcon(): string { return $this->icon; } /** - * @return IAction - * @since 8.2.0 + * {@inheritDoc} + */ + public function setPriorityNotification(bool $priorityNotification): INotification { + if ($priorityNotification && !in_array($this->getApp(), self::PRIORITY_NOTIFICATION_APPS, true)) { + throw new InvalidValueException('priorityNotification'); + } + + $this->priorityNotification = $priorityNotification; + return $this; + } + + /** + * {@inheritDoc} + */ + public function isPriorityNotification(): bool { + return $this->priorityNotification; + } + + /** + * {@inheritDoc} */ public function createAction(): IAction { return new Action(); } /** - * @param IAction $action - * @return $this - * @throws \InvalidArgumentException if the action is invalid - * @since 8.2.0 + * {@inheritDoc} */ public function addAction(IAction $action): INotification { if (!$action->isValid()) { - throw new \InvalidArgumentException('The given action is invalid'); + throw new InvalidValueException('action'); } if ($action->isPrimary()) { if ($this->hasPrimaryAction) { - throw new \InvalidArgumentException('The notification already has a primary action'); + throw new InvalidValueException('primaryAction'); } $this->hasPrimaryAction = true; @@ -481,27 +386,23 @@ class Notification implements INotification { } /** - * @return IAction[] - * @since 8.2.0 + * {@inheritDoc} */ public function getActions(): array { return $this->actions; } /** - * @param IAction $action - * @return $this - * @throws \InvalidArgumentException if the action is invalid - * @since 8.2.0 + * {@inheritDoc} */ public function addParsedAction(IAction $action): INotification { if (!$action->isValidParsed()) { - throw new \InvalidArgumentException('The given parsed action is invalid'); + throw new InvalidValueException('action'); } if ($action->isPrimary()) { if ($this->hasPrimaryParsedAction) { - throw new \InvalidArgumentException('The notification already has a primary action'); + throw new InvalidValueException('primaryAction'); } $this->hasPrimaryParsedAction = true; @@ -516,28 +417,24 @@ class Notification implements INotification { } /** - * @return IAction[] - * @since 8.2.0 + * {@inheritDoc} */ public function getParsedActions(): array { return $this->actionsParsed; } /** - * @return bool - * @since 8.2.0 + * {@inheritDoc} */ public function isValid(): bool { return $this->isValidCommon() - && - $this->getSubject() !== '' + && $this->getSubject() !== '' ; } /** - * @return bool - * @since 8.2.0 + * {@inheritDoc} */ public function isValidParsed(): bool { if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) { @@ -558,22 +455,21 @@ class Notification implements INotification { return $this->isValidCommon() - && - $this->getParsedSubject() !== '' + && $this->getParsedSubject() !== '' ; } protected function isValidCommon(): bool { + if ($this->isPriorityNotification() && !in_array($this->getApp(), self::PRIORITY_NOTIFICATION_APPS, true)) { + return false; + } + return $this->getApp() !== '' - && - $this->getUser() !== '' - && - $this->getDateTime()->getTimestamp() !== 0 - && - $this->getObjectType() !== '' - && - $this->getObjectId() !== '' + && $this->getUser() !== '' + && $this->getDateTime()->getTimestamp() !== 0 + && $this->getObjectType() !== '' + && $this->getObjectId() !== '' ; } } |