aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Notification
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Notification')
-rw-r--r--lib/private/Notification/Action.php102
-rw-r--r--lib/private/Notification/Manager.php248
-rw-r--r--lib/private/Notification/Notification.php387
3 files changed, 336 insertions, 401 deletions
diff --git a/lib/private/Notification/Action.php b/lib/private/Notification/Action.php
index a04f622c3cb..e2a75bea030 100644
--- a/lib/private/Notification/Action.php
+++ b/lib/private/Notification/Action.php
@@ -1,108 +1,61 @@
<?php
declare(strict_types=1);
-
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Joas Schilling <coding@schilljs.com>
- *
- * @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: 2019-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\InvalidValueException;
class Action implements IAction {
-
- /** @var string */
- protected $label;
-
- /** @var string */
- protected $labelParsed;
-
- /** @var string */
- protected $link;
-
- /** @var string */
- protected $requestType;
-
- /** @var string */
- protected $icon;
-
- /** @var bool */
- protected $primary;
-
- public function __construct() {
- $this->label = '';
- $this->labelParsed = '';
- $this->link = '';
- $this->requestType = '';
- $this->primary = false;
- }
+ protected string $label = '';
+ protected string $labelParsed = '';
+ protected string $link = '';
+ protected string $requestType = '';
+ protected bool $primary = false;
/**
- * @param string $label
- * @return $this
- * @throws \InvalidArgumentException if the label is invalid
- * @since 8.2.0
+ * {@inheritDoc}
*/
public function setLabel(string $label): IAction {
if ($label === '' || isset($label[32])) {
- throw new \InvalidArgumentException('The given label is invalid');
+ throw new InvalidValueException('label');
}
$this->label = $label;
return $this;
}
/**
- * @return string
- * @since 8.2.0
+ * {@inheritDoc}
*/
public function getLabel(): string {
return $this->label;
}
/**
- * @param string $label
- * @return $this
- * @throws \InvalidArgumentException if the label is invalid
- * @since 8.2.0
+ * {@inheritDoc}
*/
public function setParsedLabel(string $label): IAction {
if ($label === '') {
- throw new \InvalidArgumentException('The given parsed label is invalid');
+ throw new InvalidValueException('parsedLabel');
}
$this->labelParsed = $label;
return $this;
}
/**
- * @return string
- * @since 8.2.0
+ * {@inheritDoc}
*/
public function getParsedLabel(): string {
return $this->labelParsed;
}
/**
- * @param $primary bool
- * @return $this
- * @since 9.0.0
+ * {@inheritDoc}
*/
public function setPrimary(bool $primary): IAction {
$this->primary = $primary;
@@ -110,23 +63,18 @@ class Action implements IAction {
}
/**
- * @return bool
- * @since 9.0.0
+ * {@inheritDoc}
*/
public function isPrimary(): bool {
return $this->primary;
}
/**
- * @param string $link
- * @param string $requestType
- * @return $this
- * @throws \InvalidArgumentException if the link is invalid
- * @since 8.2.0
+ * {@inheritDoc}
*/
public function setLink(string $link, string $requestType): IAction {
if ($link === '' || isset($link[256])) {
- throw new \InvalidArgumentException('The given link is invalid');
+ throw new InvalidValueException('link');
}
if (!in_array($requestType, [
self::TYPE_GET,
@@ -135,7 +83,7 @@ class Action implements IAction {
self::TYPE_DELETE,
self::TYPE_WEB,
], true)) {
- throw new \InvalidArgumentException('The given request type is invalid');
+ throw new InvalidValueException('requestType');
}
$this->link = $link;
$this->requestType = $requestType;
@@ -143,30 +91,28 @@ class Action implements IAction {
}
/**
- * @return string
- * @since 8.2.0
+ * {@inheritDoc}
*/
public function getLink(): string {
return $this->link;
}
/**
- * @return string
- * @since 8.2.0
+ * {@inheritDoc}
*/
public function getRequestType(): string {
return $this->requestType;
}
/**
- * @return bool
+ * {@inheritDoc}
*/
public function isValid(): bool {
return $this->label !== '' && $this->link !== '';
}
/**
- * @return bool
+ * {@inheritDoc}
*/
public function isValidParsed(): bool {
return $this->labelParsed !== '' && $this->link !== '';
diff --git a/lib/private/Notification/Manager.php b/lib/private/Notification/Manager.php
index f485b37cae7..0cbda651a8b 100644
--- a/lib/private/Notification/Manager.php
+++ b/lib/private/Notification/Manager.php
@@ -1,102 +1,110 @@
<?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\AppFramework\QueryException;
-use OCP\ILogger;
+use OC\AppFramework\Bootstrap\Coordinator;
+use OCP\ICache;
+use OCP\ICacheFactory;
+use OCP\IUserManager;
use OCP\Notification\AlreadyProcessedException;
use OCP\Notification\IApp;
use OCP\Notification\IDeferrableApp;
use OCP\Notification\IDismissableNotifier;
use OCP\Notification\IManager;
+use OCP\Notification\IncompleteNotificationException;
+use OCP\Notification\IncompleteParsedNotificationException;
use OCP\Notification\INotification;
use OCP\Notification\INotifier;
+use OCP\Notification\IPreloadableNotifier;
+use OCP\Notification\UnknownNotificationException;
+use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
+use OCP\Support\Subscription\IRegistry;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Log\LoggerInterface;
class Manager implements IManager {
- /** @var IValidator */
- protected $validator;
- /** @var ILogger */
- protected $logger;
+ /** @var ICache */
+ protected ICache $cache;
/** @var IApp[] */
- protected $apps;
+ protected array $apps;
/** @var string[] */
- protected $appClasses;
+ protected array $appClasses;
/** @var INotifier[] */
- protected $notifiers;
+ protected array $notifiers;
/** @var string[] */
- protected $notifierClasses;
+ protected array $notifierClasses;
/** @var bool */
- protected $preparingPushNotification;
+ protected bool $preparingPushNotification;
/** @var bool */
- protected $deferPushing;
+ protected bool $deferPushing;
+ /** @var bool */
+ private bool $parsedRegistrationContext;
+
+ public function __construct(
+ protected IValidator $validator,
+ private IUserManager $userManager,
+ ICacheFactory $cacheFactory,
+ protected IRegistry $subscription,
+ protected LoggerInterface $logger,
+ private Coordinator $coordinator,
+ private IRichTextFormatter $richTextFormatter,
+ ) {
+ $this->cache = $cacheFactory->createDistributed('notifications');
- public function __construct(IValidator $validator,
- ILogger $logger) {
- $this->validator = $validator;
- $this->logger = $logger;
$this->apps = [];
$this->notifiers = [];
$this->appClasses = [];
$this->notifierClasses = [];
$this->preparingPushNotification = false;
$this->deferPushing = false;
+ $this->parsedRegistrationContext = false;
}
/**
* @param string $appClass The service must implement IApp, otherwise a
- * \InvalidArgumentException is thrown later
+ * \InvalidArgumentException is thrown later
* @since 17.0.0
*/
public function registerApp(string $appClass): void {
- $this->appClasses[] = $appClass;
+ // other apps may want to rely on the 'main' notification app so make it deterministic that
+ // the 'main' notification app adds it's notifications first and removes it's notifications last
+ if ($appClass === \OCA\Notifications\App::class) {
+ // add 'main' notifications app to start of internal list of apps
+ array_unshift($this->appClasses, $appClass);
+ } else {
+ // add app to end of internal list of apps
+ $this->appClasses[] = $appClass;
+ }
}
/**
* @param \Closure $service The service must implement INotifier, otherwise a
* \InvalidArgumentException is thrown later
- * @param \Closure $info An array with the keys 'id' and 'name' containing
- * the app id and the app name
+ * @param \Closure $info An array with the keys 'id' and 'name' containing
+ * the app id and the app name
* @deprecated 17.0.0 use registerNotifierService instead.
* @since 8.2.0 - Parameter $info was added in 9.0.0
*/
- public function registerNotifier(\Closure $service, \Closure $info) {
+ public function registerNotifier(\Closure $service, \Closure $info): void {
$infoData = $info();
- $this->logger->logException(new \InvalidArgumentException(
+ $exception = new \InvalidArgumentException(
'Notifier ' . $infoData['name'] . ' (id: ' . $infoData['id'] . ') is not considered because it is using the old way to register.'
- ));
+ );
+ $this->logger->error($exception->getMessage(), ['exception' => $exception]);
}
/**
* @param string $notifierService The service must implement INotifier, otherwise a
- * \InvalidArgumentException is thrown later
+ * \InvalidArgumentException is thrown later
* @since 17.0.0
*/
public function registerNotifierService(string $notifierService): void {
@@ -113,10 +121,10 @@ class Manager implements IManager {
foreach ($this->appClasses as $appClass) {
try {
- $app = \OC::$server->query($appClass);
- } catch (QueryException $e) {
- $this->logger->logException($e, [
- 'message' => 'Failed to load notification app class: ' . $appClass,
+ $app = \OC::$server->get($appClass);
+ } catch (ContainerExceptionInterface $e) {
+ $this->logger->error('Failed to load notification app class: ' . $appClass, [
+ 'exception' => $e,
'app' => 'notifications',
]);
continue;
@@ -141,16 +149,42 @@ class Manager implements IManager {
* @return INotifier[]
*/
public function getNotifiers(): array {
+ if (!$this->parsedRegistrationContext) {
+ $notifierServices = $this->coordinator->getRegistrationContext()->getNotifierServices();
+ foreach ($notifierServices as $notifierService) {
+ try {
+ $notifier = \OC::$server->get($notifierService->getService());
+ } catch (ContainerExceptionInterface $e) {
+ $this->logger->error('Failed to load notification notifier class: ' . $notifierService->getService(), [
+ 'exception' => $e,
+ 'app' => 'notifications',
+ ]);
+ continue;
+ }
+
+ if (!($notifier instanceof INotifier)) {
+ $this->logger->error('Notification notifier class ' . $notifierService->getService() . ' is not implementing ' . INotifier::class, [
+ 'app' => 'notifications',
+ ]);
+ continue;
+ }
+
+ $this->notifiers[] = $notifier;
+ }
+
+ $this->parsedRegistrationContext = true;
+ }
+
if (empty($this->notifierClasses)) {
return $this->notifiers;
}
foreach ($this->notifierClasses as $notifierClass) {
try {
- $notifier = \OC::$server->query($notifierClass);
- } catch (QueryException $e) {
- $this->logger->logException($e, [
- 'message' => 'Failed to load notification notifier class: ' . $notifierClass,
+ $notifier = \OC::$server->get($notifierClass);
+ } catch (ContainerExceptionInterface $e) {
+ $this->logger->error('Failed to load notification notifier class: ' . $notifierClass, [
+ 'exception' => $e,
'app' => 'notifications',
]);
continue;
@@ -176,7 +210,7 @@ class Manager implements IManager {
* @since 8.2.0
*/
public function createNotification(): INotification {
- return new Notification($this->validator);
+ return new Notification($this->validator, $this->richTextFormatter);
}
/**
@@ -184,7 +218,9 @@ class Manager implements IManager {
* @since 8.2.0
*/
public function hasNotifiers(): bool {
- return !empty($this->notifiers) || !empty($this->notifierClasses);
+ return !empty($this->notifiers)
+ || !empty($this->notifierClasses)
+ || (!$this->parsedRegistrationContext && !empty($this->coordinator->getRegistrationContext()->getNotifierServices()));
}
/**
@@ -212,7 +248,7 @@ class Manager implements IManager {
$alreadyDeferring = $this->deferPushing;
$this->deferPushing = true;
- $apps = $this->getApps();
+ $apps = array_reverse($this->getApps());
foreach ($apps as $app) {
if ($app instanceof IDeferrableApp) {
@@ -227,7 +263,7 @@ class Manager implements IManager {
* @since 20.0.0
*/
public function flush(): void {
- $apps = $this->getApps();
+ $apps = array_reverse($this->getApps());
foreach ($apps as $app) {
if (!$app instanceof IDeferrableApp) {
@@ -244,13 +280,29 @@ class Manager implements IManager {
}
/**
- * @param INotification $notification
- * @throws \InvalidArgumentException When the notification is not valid
- * @since 8.2.0
+ * {@inheritDoc}
+ */
+ public function isFairUseOfFreePushService(): bool {
+ $pushAllowed = $this->cache->get('push_fair_use');
+ if ($pushAllowed === null) {
+ /**
+ * We want to keep offering our push notification service for free, but large
+ * users overload our infrastructure. For this reason we have to rate-limit the
+ * use of push notifications. If you need this feature, consider using Nextcloud Enterprise.
+ */
+ $isFairUse = $this->subscription->delegateHasValidSubscription() || $this->userManager->countSeenUsers() < 1000;
+ $pushAllowed = $isFairUse ? 'yes' : 'no';
+ $this->cache->set('push_fair_use', $pushAllowed, 3600);
+ }
+ return $pushAllowed === 'yes';
+ }
+
+ /**
+ * {@inheritDoc}
*/
public function notify(INotification $notification): void {
if (!$notification->isValid()) {
- throw new \InvalidArgumentException('The given notification is invalid');
+ throw new IncompleteNotificationException('The given notification is invalid');
}
$apps = $this->getApps();
@@ -258,7 +310,11 @@ class Manager implements IManager {
foreach ($apps as $app) {
try {
$app->notify($notification);
+ } catch (IncompleteNotificationException) {
} catch (\InvalidArgumentException $e) {
+ // todo 33.0.0 Log as warning
+ // todo 39.0.0 Log as error
+ $this->logger->debug(get_class($app) . '::notify() threw \InvalidArgumentException which is deprecated. Throw \OCP\Notification\IncompleteNotificationException when the notification is incomplete for your app and otherwise handle all \InvalidArgumentException yourself.');
}
}
}
@@ -284,12 +340,7 @@ class Manager implements IManager {
}
/**
- * @param INotification $notification
- * @param string $languageCode The code of the language that should be used to prepare the notification
- * @return INotification
- * @throws \InvalidArgumentException When the notification was not prepared by a notifier
- * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
- * @since 8.2.0
+ * {@inheritDoc}
*/
public function prepare(INotification $notification, string $languageCode): INotification {
$notifiers = $this->getNotifiers();
@@ -297,30 +348,65 @@ class Manager implements IManager {
foreach ($notifiers as $notifier) {
try {
$notification = $notifier->prepare($notification, $languageCode);
- } catch (\InvalidArgumentException $e) {
- continue;
} catch (AlreadyProcessedException $e) {
$this->markProcessed($notification);
- throw new \InvalidArgumentException('The given notification has been processed');
+ throw $e;
+ } catch (UnknownNotificationException) {
+ continue;
+ } catch (\InvalidArgumentException $e) {
+ // todo 33.0.0 Log as warning
+ // todo 39.0.0 Log as error
+ $this->logger->debug(get_class($notifier) . '::prepare() threw \InvalidArgumentException which is deprecated. Throw \OCP\Notification\UnknownNotificationException when the notification is not known to your notifier and otherwise handle all \InvalidArgumentException yourself.');
+ continue;
}
- if (!($notification instanceof INotification) || !$notification->isValidParsed()) {
- throw new \InvalidArgumentException('The given notification has not been handled');
+ if (!$notification->isValidParsed()) {
+ $this->logger->info('Notification was claimed to be parsed, but was not fully parsed by ' . get_class($notifier) . ' [app: ' . $notification->getApp() . ', subject: ' . $notification->getSubject() . ']');
+ throw new IncompleteParsedNotificationException();
}
}
- if (!($notification instanceof INotification) || !$notification->isValidParsed()) {
- throw new \InvalidArgumentException('The given notification has not been handled');
+ if (!$notification->isValidParsed()) {
+ $this->logger->info('Notification was not parsed by any notifier [app: ' . $notification->getApp() . ', subject: ' . $notification->getSubject() . ']');
+ throw new IncompleteParsedNotificationException();
+ }
+
+ $link = $notification->getLink();
+ if ($link !== '' && !str_starts_with($link, 'http://') && !str_starts_with($link, 'https://')) {
+ $this->logger->warning('Link of notification is not an absolute URL and does not work in mobile and desktop clients [app: ' . $notification->getApp() . ', subject: ' . $notification->getSubject() . ']');
+ }
+
+ $icon = $notification->getIcon();
+ if ($icon !== '' && !str_starts_with($icon, 'http://') && !str_starts_with($icon, 'https://')) {
+ $this->logger->warning('Icon of notification is not an absolute URL and does not work in mobile and desktop clients [app: ' . $notification->getApp() . ', subject: ' . $notification->getSubject() . ']');
+ }
+
+ foreach ($notification->getParsedActions() as $action) {
+ $link = $action->getLink();
+ if ($link !== '' && !str_starts_with($link, 'http://') && !str_starts_with($link, 'https://')) {
+ $this->logger->warning('Link of action is not an absolute URL and does not work in mobile and desktop clients [app: ' . $notification->getApp() . ', subject: ' . $notification->getSubject() . ']');
+ }
}
return $notification;
}
+ public function preloadDataForParsing(array $notifications, string $languageCode): void {
+ $notifiers = $this->getNotifiers();
+ foreach ($notifiers as $notifier) {
+ if (!($notifier instanceof IPreloadableNotifier)) {
+ continue;
+ }
+
+ $notifier->preloadDataForParsing($notifications, $languageCode);
+ }
+ }
+
/**
* @param INotification $notification
*/
public function markProcessed(INotification $notification): void {
- $apps = $this->getApps();
+ $apps = array_reverse($this->getApps());
foreach ($apps as $app) {
$app->markProcessed($notification);
@@ -332,7 +418,7 @@ class Manager implements IManager {
* @return int
*/
public function getCount(INotification $notification): int {
- $apps = $this->getApps();
+ $apps = array_reverse($this->getApps());
$count = 0;
foreach ($apps as $app) {
@@ -342,6 +428,9 @@ class Manager implements IManager {
return $count;
}
+ /**
+ * {@inheritDoc}
+ */
public function dismissNotification(INotification $notification): void {
$notifiers = $this->getNotifiers();
@@ -349,7 +438,12 @@ class Manager implements IManager {
if ($notifier instanceof IDismissableNotifier) {
try {
$notifier->dismissNotification($notification);
+ } catch (UnknownNotificationException) {
+ continue;
} catch (\InvalidArgumentException $e) {
+ // todo 33.0.0 Log as warning
+ // todo 39.0.0 Log as error
+ $this->logger->debug(get_class($notifier) . '::dismissNotification() threw \InvalidArgumentException which is deprecated. Throw \OCP\Notification\UnknownNotificationException when the notification is not known to your notifier and otherwise handle all \InvalidArgumentException yourself.');
continue;
}
}
diff --git a/lib/private/Notification/Notification.php b/lib/private/Notification/Notification.php
index c0848817361..fcce7fd0020 100644
--- a/lib/private/Notification/Notification.php
+++ b/lib/private/Notification/Notification.php
@@ -1,241 +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;
@@ -245,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;
@@ -335,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;
@@ -482,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;
@@ -517,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())) {
@@ -559,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() !== ''
;
}
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-16 07:16:32 +0000