From 4e347170ac31462e447daaccf794000981a68f86 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 31 Aug 2015 12:24:37 +0200 Subject: [PATCH 01/19] Notification API --- lib/private/notification/action.php | 151 ++++++++ lib/private/notification/manager.php | 180 +++++++++ lib/private/notification/notification.php | 448 ++++++++++++++++++++++ lib/private/server.php | 14 + lib/public/iservercontainer.php | 9 +- lib/public/notification/iaction.php | 96 +++++ lib/public/notification/iapp.php | 55 +++ lib/public/notification/imanager.php | 52 +++ lib/public/notification/inotification.php | 237 ++++++++++++ lib/public/notification/inotifier.php | 38 ++ 10 files changed, 1279 insertions(+), 1 deletion(-) create mode 100644 lib/private/notification/action.php create mode 100644 lib/private/notification/manager.php create mode 100644 lib/private/notification/notification.php create mode 100644 lib/public/notification/iaction.php create mode 100644 lib/public/notification/iapp.php create mode 100644 lib/public/notification/imanager.php create mode 100644 lib/public/notification/inotification.php create mode 100644 lib/public/notification/inotifier.php diff --git a/lib/private/notification/action.php b/lib/private/notification/action.php new file mode 100644 index 00000000000..09e37a70d5e --- /dev/null +++ b/lib/private/notification/action.php @@ -0,0 +1,151 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OC\Notification; + +use OCP\Notification\IAction; + +class Action implements IAction { + + /** @var string */ + protected $label; + + /** @var string */ + protected $labelParsed; + + /** @var string */ + protected $link; + + /** @var string */ + protected $icon; + + /** + * Constructor + */ + public function __construct() { + $this->label = ''; + $this->labelParsed = ''; + $this->link = ''; + $this->icon = ''; + } + + /** + * @param string $label + * @return $this + * @throws \InvalidArgumentException if the label is invalid + * @since 8.2.0 + */ + public function setLabel($label) { + if (!is_string($label) || $label === '' || isset($label[32])) { + throw new \InvalidArgumentException('The given label is invalid'); + } + $this->label = $label; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getLabel() { + return $this->label; + } + + /** + * @param string $label + * @return $this + * @throws \InvalidArgumentException if the label is invalid + * @since 8.2.0 + */ + public function setParsedLabel($label) { + if (!is_string($label) || $label === '') { + throw new \InvalidArgumentException('The given parsed label is invalid'); + } + $this->labelParsed = $label; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getParsedLabel() { + return $this->labelParsed; + } + + /** + * @param string $link + * @return $this + * @throws \InvalidArgumentException if the link is invalid + * @since 8.2.0 + */ + public function setLink($link) { + if (!is_string($link) || $link === '' || isset($link[256])) { + throw new \InvalidArgumentException('The given link is invalid'); + } + $this->link = $link; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getLink() { + return $this->link; + } + + /** + * @param string $icon + * @return $this + * @throws \InvalidArgumentException if the icon is invalid + * @since 8.2.0 + */ + public function setIcon($icon) { + if (!is_string($icon) || $icon === '' || isset($icon[64])) { + throw new \InvalidArgumentException('The given icon is invalid'); + } + $this->icon = $icon; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getIcon() { + return $this->icon; + } + + /** + * @return bool + */ + public function isValid() { + return $this->label !== '' && $this->link !== ''; + } + + /** + * @return bool + */ + public function isValidParsed() { + return $this->labelParsed !== '' && $this->link !== ''; + } +} diff --git a/lib/private/notification/manager.php b/lib/private/notification/manager.php new file mode 100644 index 00000000000..93062ae14dc --- /dev/null +++ b/lib/private/notification/manager.php @@ -0,0 +1,180 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OC\Notification; + + +use OCP\Notification\IApp; +use OCP\Notification\IManager; +use OCP\Notification\INotification; +use OCP\Notification\INotifier; + +class Manager implements IManager { + /** @var IApp */ + protected $apps; + + /** @var INotifier */ + protected $notifiers; + + /** @var \Closure */ + protected $appsClosures; + + /** @var \Closure */ + protected $notifiersClosures; + + /** + * @param \Closure $service The service must implement IApp, otherwise a + * \InvalidArgumentException is thrown later + * @return null + * @since 8.2.0 + */ + public function registerApp(\Closure $service) { + $this->appsClosures[] = $service; + $this->apps = []; + } + + /** + * @param \Closure $service The service must implement INotifier, otherwise a + * \InvalidArgumentException is thrown later + * @return null + * @since 8.2.0 + */ + public function registerNotifier(\Closure $service) { + $this->notifiersClosures[] = $service; + $this->notifiers = []; + } + + /** + * @return IApp[] + */ + protected function getApps() { + if (!empty($this->apps)) { + return $this->apps; + } + + foreach ($this->appsClosures as $closure) { + $app = $closure; + if (!($app instanceof IApp)) { + throw new \InvalidArgumentException('The given notification app does not implement the IApp interface'); + } + $this->apps[] = $app; + } + + return $this->apps; + } + + /** + * @return INotifier[] + */ + protected function getNotifiers() { + if (!empty($this->notifiers)) { + return $this->notifiers; + } + + foreach ($this->notifiersClosures as $closure) { + $notifier = $closure; + if (!($notifier instanceof INotifier)) { + throw new \InvalidArgumentException('The given notification app does not implement the INotifier interface'); + } + $this->notifiers[] = $notifier; + } + + return $this->notifiers; + } + + /** + * @return INotification + * @since 8.2.0 + */ + public function createNotification() { + return new Notification(); + } + + /** + * @param INotification $notification + * @return null + * @throws \InvalidArgumentException When the notification is not valid + * @since 8.2.0 + */ + public function notify(INotification $notification) { + if (!$notification->isValid()) { + throw new \InvalidArgumentException('The given notification is invalid'); + } + + $apps = $this->getApps(); + + foreach ($apps as $app) { + $app->notify($notification); + } + } + + /** + * @param INotification $notification + * @return INotification + * @throws \InvalidArgumentException When the notification was not prepared by a notifier + * @since 8.2.0 + */ + public function prepare(INotification $notification) { + $notifiers = $this->getNotifiers(); + + foreach ($notifiers as $notifier) { + try { + $notifier->prepare($notification); + } catch (\InvalidArgumentException $e) {} + } + + if (!$notification->isValidParsed()) { + throw new \InvalidArgumentException('The given notification has not been handled'); + } + + return $notification; + } + + /** + * @param string $objectType + * @param int $objectId + * @param string $user + * @return null + */ + public function markProcessed($objectType, $objectId, $user = '') { + $apps = $this->getApps(); + + foreach ($apps as $app) { + $app->markProcessed($objectType, $objectId, $user); + } + } + + /** + * @param string $user + * @param string $appId + * @return int + */ + public function getCount($user, $appId = '') { + $apps = $this->getApps(); + + $count = 0; + foreach ($apps as $app) { + $count += $app->markProcessed($user, $appId); + } + + return $count; + } +} diff --git a/lib/private/notification/notification.php b/lib/private/notification/notification.php new file mode 100644 index 00000000000..9262a198b52 --- /dev/null +++ b/lib/private/notification/notification.php @@ -0,0 +1,448 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OC\Notification; + +use OCP\Notification\IAction; +use OCP\Notification\INotification; + +class Notification implements INotification { + /** @var string */ + protected $app; + + /** @var string */ + protected $user; + + /** @var int */ + protected $timestamp; + + /** @var string */ + protected $objectType; + + /** @var int */ + protected $objectId; + + /** @var string */ + protected $subject; + + /** @var array */ + protected $subjectParameters; + + /** @var string */ + protected $subjectParsed; + + /** @var string */ + protected $message; + + /** @var array */ + protected $messageParameters; + + /** @var string */ + protected $messageParsed; + + /** @var string */ + protected $link; + + /** @var string */ + protected $icon; + + /** @var array */ + protected $actions; + + /** @var array */ + protected $actionsParsed; + + /** + * Constructor + */ + public function __construct() { + $this->app = ''; + $this->user = ''; + $this->timestamp = 0; + $this->objectType = ''; + $this->objectId = 0; + $this->subject = ''; + $this->subjectParameters = []; + $this->subjectParsed = ''; + $this->message = ''; + $this->messageParameters = []; + $this->messageParsed = ''; + $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 + */ + public function setApp($app) { + if (!is_string($app) || $app === '' || isset($app[32])) { + throw new \InvalidArgumentException('The given app name is invalid'); + } + $this->app = $app; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getApp() { + return $this->app; + } + + /** + * @param string $user + * @return $this + * @throws \InvalidArgumentException if the user id is invalid + * @since 8.2.0 + */ + public function setUser($user) { + if (!is_string($user) || $user === '' || isset($app[64])) { + throw new \InvalidArgumentException('The given user id is invalid'); + } + $this->user = $user; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getUser() { + return $this->user; + } + + /** + * @param int $timestamp + * @return $this + * @throws \InvalidArgumentException if the timestamp is invalid + * @since 8.2.0 + */ + public function setTimestamp($timestamp) { + if (!is_int($timestamp)) { + throw new \InvalidArgumentException('The given timestamp is invalid'); + } + $this->timestamp = $timestamp; + return $this; + } + + /** + * @return int + * @since 8.2.0 + */ + public function getTimestamp() { + return $this->timestamp; + } + + /** + * @param string $type + * @param int $id + * @return $this + * @throws \InvalidArgumentException if the object type or id is invalid + * @since 8.2.0 + */ + public function setObject($type, $id) { + if (!is_string($type) || $type === '' || isset($type[64])) { + throw new \InvalidArgumentException('The given object type is invalid'); + } + $this->objectType = $type; + + if (!is_int($id)) { + throw new \InvalidArgumentException('The given object id is invalid'); + } + $this->objectId = $id; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getObjectType() { + return $this->objectType; + } + + /** + * @return int + * @since 8.2.0 + */ + public function getObjectId() { + return $this->objectId; + } + + /** + * @param string $subject + * @param array $parameters + * @return $this + * @throws \InvalidArgumentException if the subject or parameters are invalid + * @since 8.2.0 + */ + public function setSubject($subject, array $parameters = []) { + if (!is_string($subject) || $subject === '' || isset($subject[64])) { + throw new \InvalidArgumentException('The given subject is invalid'); + } + $this->subject = $subject; + + if (!is_array($parameters)) { + throw new \InvalidArgumentException('The given subject parameters are invalid'); + } + $this->subjectParameters = $parameters; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getSubject() { + return $this->subject; + } + + /** + * @return string[] + * @since 8.2.0 + */ + public function getSubjectParameters() { + return $this->subjectParameters; + } + + /** + * @param string $subject + * @return $this + * @throws \InvalidArgumentException if the subject are invalid + * @since 8.2.0 + */ + public function setParsedSubject($subject) { + if (!is_string($subject) || $subject === '') { + throw new \InvalidArgumentException('The given parsed subject is invalid'); + } + $this->subjectParsed = $subject; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getParsedSubject() { + return $this->messageParsed; + } + + /** + * @param string $message + * @param array $parameters + * @return $this + * @throws \InvalidArgumentException if the message or parameters are invalid + * @since 8.2.0 + */ + public function setMessage($message, array $parameters = []) { + if (!is_string($message) || $message === '' || isset($message[64])) { + throw new \InvalidArgumentException('The given message is invalid'); + } + $this->message = $message; + + if (!is_array($parameters)) { + throw new \InvalidArgumentException('The given message parameters are invalid'); + } + $this->messageParameters = $parameters; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getMessage() { + return $this->message; + } + + /** + * @return string[] + * @since 8.2.0 + */ + public function getMessageParameters() { + return $this->messageParameters; + } + + /** + * @param string $message + * @return $this + * @throws \InvalidArgumentException if the message are invalid + * @since 8.2.0 + */ + public function setParsedMessage($message) { + if (!is_string($message) || $message === '') { + throw new \InvalidArgumentException('The given parsed message is invalid'); + } + $this->messageParsed = $message; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getParsedMessage() { + return $this->messageParsed; + } + + /** + * @param string $link + * @return $this + * @throws \InvalidArgumentException if the link are invalid + * @since 8.2.0 + */ + public function setLink($link) { + if (!is_string($link) || $link === '' || isset($link[256])) { + throw new \InvalidArgumentException('The given link is invalid'); + } + $this->link = $link; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getLink() { + return $this->link; + } + + /** + * @param string $icon + * @return $this + * @throws \InvalidArgumentException if the icon are invalid + * @since 8.2.0 + */ + public function setIcon($icon) { + if (!is_string($icon) || $icon === '' || isset($icon[64])) { + throw new \InvalidArgumentException('The given icon is invalid'); + } + $this->icon = $icon; + return $this; + } + + /** + * @return string + * @since 8.2.0 + */ + public function getIcon() { + return $this->icon; + } + + /** + * @return IAction + * @since 8.2.0 + */ + public function createAction() { + return new Action(); + } + + /** + * @param IAction $action + * @return $this + * @throws \InvalidArgumentException if the action are invalid + * @since 8.2.0 + */ + public function addAction(IAction $action) { + if ($action->isValid()) { + throw new \InvalidArgumentException('The given action is invalid'); + } + $this->actions[] = $action; + return $this; + } + + /** + * @return IAction[] + * @since 8.2.0 + */ + public function getActions() { + return $this->actions; + } + + /** + * @param IAction $action + * @return $this + * @throws \InvalidArgumentException if the action are invalid + * @since 8.2.0 + */ + public function addParsedAction(IAction $action) { + if ($action->isValidParsed()) { + throw new \InvalidArgumentException('The given parsed action is invalid'); + } + $this->actions[] = $action; + return $this; + } + + /** + * @return IAction[] + * @since 8.2.0 + */ + public function getParsedActions() { + return $this->actionsParsed; + } + + /** + * @return bool + * @since 8.2.0 + */ + public function isValid() { + return + $this->isValidCommon() + && + $this->subject !== '' + ; + } + + /** + * @return bool + * @since 8.2.0 + */ + public function isValidParsed() { + return + $this->isValidCommon() + && + $this->subjectParsed !== '' + ; + } + + /** + * @return bool + */ + protected function isValidCommon() { + return + $this->app !== '' + && + $this->user !== '' + && + $this->timestamp !== 0 + && + $this->objectType !== '' + && + $this->objectId !== 0 + ; + } +} diff --git a/lib/private/server.php b/lib/private/server.php index 393c1840973..880ab274f12 100644 --- a/lib/private/server.php +++ b/lib/private/server.php @@ -53,6 +53,7 @@ use OC\Lock\DBLockingProvider; use OC\Lock\MemcacheLockingProvider; use OC\Lock\NoopLockingProvider; use OC\Mail\Mailer; +use OC\Notification\Manager; use OC\Security\CertificateManager; use OC\Security\Crypto; use OC\Security\Hasher; @@ -475,6 +476,9 @@ class Server extends SimpleContainer implements IServerContainer { $c->getDatabaseConnection() ); }); + $this->registerService('NotificationManager', function() { + return new Manager(); + }); $this->registerService('CapabilitiesManager', function (Server $c) { $manager = new \OC\CapabilitiesManager(); $manager->registerCapability(function() use ($c) { @@ -1043,6 +1047,16 @@ class Server extends SimpleContainer implements IServerContainer { return $this->query('EventDispatcher'); } + /** + * Get the Notification Manager + * + * @return \OCP\Notification\IManager + * @since 8.2.0 + */ + public function getNotificationManager() { + return $this->query('NotificationManager'); + } + /** * @return \OC\Session\CryptoWrapper */ diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php index 81724cb4967..ea08b5a78ca 100644 --- a/lib/public/iservercontainer.php +++ b/lib/public/iservercontainer.php @@ -448,7 +448,6 @@ interface IServerContainer { */ public function getMimeTypeLoader(); - /** * Get the EventDispatcher * @@ -456,4 +455,12 @@ interface IServerContainer { * @since 8.2.0 */ public function getEventDispatcher(); + + /** + * Get the Notification Manager + * + * @return \OCP\Notification\IManager + * @since 8.2.0 + */ + public function getNotificationManager(); } diff --git a/lib/public/notification/iaction.php b/lib/public/notification/iaction.php new file mode 100644 index 00000000000..f0dfb024961 --- /dev/null +++ b/lib/public/notification/iaction.php @@ -0,0 +1,96 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OCP\Notification; + +/** + * Interface IAction + * + * @package OCP\Notification + * @since 8.2.0 + */ +interface IAction { + /** + * @param string $label + * @return $this + * @throws \InvalidArgumentException if the label is invalid + * @since 8.2.0 + */ + public function setLabel($label); + + /** + * @return string + * @since 8.2.0 + */ + public function getLabel(); + + /** + * @param string $label + * @return $this + * @throws \InvalidArgumentException if the label is invalid + * @since 8.2.0 + */ + public function setParsedLabel($label); + + /** + * @return string + * @since 8.2.0 + */ + public function getParsedLabel(); + + /** + * @param string $link + * @return $this + * @throws \InvalidArgumentException if the link is invalid + * @since 8.2.0 + */ + public function setLink($link); + + /** + * @return string + * @since 8.2.0 + */ + public function getLink(); + + /** + * @param string $icon + * @return $this + * @throws \InvalidArgumentException if the icon is invalid + * @since 8.2.0 + */ + public function setIcon($icon); + + /** + * @return string + * @since 8.2.0 + */ + public function getIcon(); + + /** + * @return bool + */ + public function isValid(); + + /** + * @return bool + */ + public function isValidParsed(); +} diff --git a/lib/public/notification/iapp.php b/lib/public/notification/iapp.php new file mode 100644 index 00000000000..b154efab759 --- /dev/null +++ b/lib/public/notification/iapp.php @@ -0,0 +1,55 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OCP\Notification; + +/** + * Interface IApp + * + * @package OCP\Notification + * @since 8.2.0 + */ +interface IApp { + /** + * @param INotification $notification + * @return null + * @throws \InvalidArgumentException When the notification is not valid + * @since 8.2.0 + */ + public function notify(INotification $notification); + + /** + * @param string $objectType + * @param int $objectId + * @param string $user + * @return null + * @since 8.2.0 + */ + public function markProcessed($objectType, $objectId, $user = ''); + + /** + * @param string $user + * @param string $appId + * @return int + * @since 8.2.0 + */ + public function getCount($user, $appId = ''); +} diff --git a/lib/public/notification/imanager.php b/lib/public/notification/imanager.php new file mode 100644 index 00000000000..e68f19e71fd --- /dev/null +++ b/lib/public/notification/imanager.php @@ -0,0 +1,52 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OCP\Notification; + +/** + * Interface IManager + * + * @package OCP\Notification + * @since 8.2.0 + */ +interface IManager extends IApp, INotifier { + /** + * @param \Closure $service The service must implement IApp, otherwise a + * \InvalidArgumentException is thrown later + * @return null + * @since 8.2.0 + */ + public function registerApp(\Closure $service); + + /** + * @param \Closure $service The service must implement INotifier, otherwise a + * \InvalidArgumentException is thrown later + * @return null + * @since 8.2.0 + */ + public function registerNotifier(\Closure $service); + + /** + * @return INotification + * @since 8.2.0 + */ + public function createNotification(); +} diff --git a/lib/public/notification/inotification.php b/lib/public/notification/inotification.php new file mode 100644 index 00000000000..48204f733c1 --- /dev/null +++ b/lib/public/notification/inotification.php @@ -0,0 +1,237 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OCP\Notification; + +/** + * Interface INotification + * + * @package OCP\Notification + * @since 8.2.0 + */ +interface INotification { + /** + * @param string $app + * @return $this + * @throws \InvalidArgumentException if the app id are invalid + * @since 8.2.0 + */ + public function setApp($app); + + /** + * @return string + * @since 8.2.0 + */ + public function getApp(); + + /** + * @param string $user + * @return $this + * @throws \InvalidArgumentException if the user id are invalid + * @since 8.2.0 + */ + public function setUser($user); + + /** + * @return string + * @since 8.2.0 + */ + public function getUser(); + + /** + * @param int $timestamp + * @return $this + * @throws \InvalidArgumentException if the timestamp are invalid + * @since 8.2.0 + */ + public function setTimestamp($timestamp); + + /** + * @return int + * @since 8.2.0 + */ + public function getTimestamp(); + + /** + * @param string $type + * @param int $id + * @return $this + * @throws \InvalidArgumentException if the object type or id are invalid + * @since 8.2.0 + */ + public function setObject($type, $id); + + /** + * @return string + * @since 8.2.0 + */ + public function getObjectType(); + + /** + * @return int + * @since 8.2.0 + */ + public function getObjectId(); + + /** + * @param string $subject + * @param array $parameters + * @return $this + * @throws \InvalidArgumentException if the subject or parameters are invalid + * @since 8.2.0 + */ + public function setSubject($subject, array $parameters = []); + + /** + * @return string + * @since 8.2.0 + */ + public function getSubject(); + + /** + * @return string[] + * @since 8.2.0 + */ + public function getSubjectParameters(); + + /** + * @param string $subject + * @return $this + * @throws \InvalidArgumentException if the subject are invalid + * @since 8.2.0 + */ + public function setParsedSubject($subject); + + /** + * @return string + * @since 8.2.0 + */ + public function getParsedSubject(); + + /** + * @param string $message + * @param array $parameters + * @return $this + * @throws \InvalidArgumentException if the message or parameters are invalid + * @since 8.2.0 + */ + public function setMessage($message, array $parameters = []); + + /** + * @return string + * @since 8.2.0 + */ + public function getMessage(); + + /** + * @return string[] + * @since 8.2.0 + */ + public function getMessageParameters(); + + /** + * @param string $message + * @return $this + * @throws \InvalidArgumentException if the message are invalid + * @since 8.2.0 + */ + public function setParsedMessage($message); + + /** + * @return string + * @since 8.2.0 + */ + public function getParsedMessage(); + + /** + * @param string $link + * @return $this + * @throws \InvalidArgumentException if the link are invalid + * @since 8.2.0 + */ + public function setLink($link); + + /** + * @return string + * @since 8.2.0 + */ + public function getLink(); + + /** + * @param string $icon + * @return $this + * @throws \InvalidArgumentException if the icon are invalid + * @since 8.2.0 + */ + public function setIcon($icon); + + /** + * @return string + * @since 8.2.0 + */ + public function getIcon(); + + /** + * @return IAction + * @since 8.2.0 + */ + public function createAction(); + + /** + * @param IAction $action + * @return $this + * @throws \InvalidArgumentException if the action are invalid + * @since 8.2.0 + */ + public function addAction(IAction $action); + + /** + * @return IAction[] + * @since 8.2.0 + */ + public function getActions(); + + /** + * @param IAction $action + * @return $this + * @throws \InvalidArgumentException if the action are invalid + * @since 8.2.0 + */ + public function addParsedAction(IAction $action); + + /** + * @return IAction[] + * @since 8.2.0 + */ + public function getParsedActions(); + + /** + * @return bool + * @since 8.2.0 + */ + public function isValid(); + + /** + * @return bool + * @since 8.2.0 + */ + public function isValidParsed(); +} diff --git a/lib/public/notification/inotifier.php b/lib/public/notification/inotifier.php new file mode 100644 index 00000000000..32628768ebc --- /dev/null +++ b/lib/public/notification/inotifier.php @@ -0,0 +1,38 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OCP\Notification; + +/** + * Interface INotifier + * + * @package OCP\Notification + * @since 8.2.0 + */ +interface INotifier { + /** + * @param INotification $notification + * @return INotification + * @throws \InvalidArgumentException When the notification was not prepared by a notifier + * @since 8.2.0 + */ + public function prepare(INotification $notification); +} From 5437aeeaa2ad2445c0ea9668d0afffee46a3ba68 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 31 Aug 2015 12:27:06 +0200 Subject: [PATCH 02/19] Nothing is set in stone here yet --- lib/public/notification/iaction.php | 4 ++++ lib/public/notification/iapp.php | 4 ++++ lib/public/notification/imanager.php | 4 ++++ lib/public/notification/inotification.php | 4 ++++ lib/public/notification/inotifier.php | 4 ++++ 5 files changed, 20 insertions(+) diff --git a/lib/public/notification/iaction.php b/lib/public/notification/iaction.php index f0dfb024961..334f6cc44a7 100644 --- a/lib/public/notification/iaction.php +++ b/lib/public/notification/iaction.php @@ -26,6 +26,10 @@ namespace OCP\Notification; * * @package OCP\Notification * @since 8.2.0 + * + * DEVELOPER NOTE: + * The notification api is experimental only in 8.2.0! Do not start using it, + * if you can not prepare an update for the next version afterwards. */ interface IAction { /** diff --git a/lib/public/notification/iapp.php b/lib/public/notification/iapp.php index b154efab759..b7bf41ce7f5 100644 --- a/lib/public/notification/iapp.php +++ b/lib/public/notification/iapp.php @@ -26,6 +26,10 @@ namespace OCP\Notification; * * @package OCP\Notification * @since 8.2.0 + * + * DEVELOPER NOTE: + * The notification api is experimental only in 8.2.0! Do not start using it, + * if you can not prepare an update for the next version afterwards. */ interface IApp { /** diff --git a/lib/public/notification/imanager.php b/lib/public/notification/imanager.php index e68f19e71fd..ca1cc968b12 100644 --- a/lib/public/notification/imanager.php +++ b/lib/public/notification/imanager.php @@ -26,6 +26,10 @@ namespace OCP\Notification; * * @package OCP\Notification * @since 8.2.0 + * + * DEVELOPER NOTE: + * The notification api is experimental only in 8.2.0! Do not start using it, + * if you can not prepare an update for the next version afterwards. */ interface IManager extends IApp, INotifier { /** diff --git a/lib/public/notification/inotification.php b/lib/public/notification/inotification.php index 48204f733c1..51d4a804647 100644 --- a/lib/public/notification/inotification.php +++ b/lib/public/notification/inotification.php @@ -26,6 +26,10 @@ namespace OCP\Notification; * * @package OCP\Notification * @since 8.2.0 + * + * DEVELOPER NOTE: + * The notification api is experimental only in 8.2.0! Do not start using it, + * if you can not prepare an update for the next version afterwards. */ interface INotification { /** diff --git a/lib/public/notification/inotifier.php b/lib/public/notification/inotifier.php index 32628768ebc..be6b3f25533 100644 --- a/lib/public/notification/inotifier.php +++ b/lib/public/notification/inotifier.php @@ -26,6 +26,10 @@ namespace OCP\Notification; * * @package OCP\Notification * @since 8.2.0 + * + * DEVELOPER NOTE: + * The notification api is experimental only in 8.2.0! Do not start using it, + * if you can not prepare an update for the next version afterwards. */ interface INotifier { /** From f16c5a38a85270e2230d78ab355774238a325f5d Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 1 Sep 2015 10:20:54 +0200 Subject: [PATCH 03/19] Add language to the preparation method --- lib/private/notification/manager.php | 5 +++-- lib/public/notification/inotifier.php | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/private/notification/manager.php b/lib/private/notification/manager.php index 93062ae14dc..0b3b68a4065 100644 --- a/lib/private/notification/manager.php +++ b/lib/private/notification/manager.php @@ -128,16 +128,17 @@ 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 * @since 8.2.0 */ - public function prepare(INotification $notification) { + public function prepare(INotification $notification, $languageCode) { $notifiers = $this->getNotifiers(); foreach ($notifiers as $notifier) { try { - $notifier->prepare($notification); + $notifier->prepare($notification, $languageCode); } catch (\InvalidArgumentException $e) {} } diff --git a/lib/public/notification/inotifier.php b/lib/public/notification/inotifier.php index be6b3f25533..9eefcddae18 100644 --- a/lib/public/notification/inotifier.php +++ b/lib/public/notification/inotifier.php @@ -34,9 +34,10 @@ namespace OCP\Notification; interface INotifier { /** * @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 * @since 8.2.0 */ - public function prepare(INotification $notification); + public function prepare(INotification $notification, $languageCode); } From 0bcae89d141fb8fd35477b5b847360fbf3eb32f1 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 1 Sep 2015 10:24:21 +0200 Subject: [PATCH 04/19] Handle InvalidArgumentException more gracefully --- lib/private/notification/manager.php | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/lib/private/notification/manager.php b/lib/private/notification/manager.php index 0b3b68a4065..c721f610113 100644 --- a/lib/private/notification/manager.php +++ b/lib/private/notification/manager.php @@ -122,7 +122,10 @@ class Manager implements IManager { $apps = $this->getApps(); foreach ($apps as $app) { - $app->notify($notification); + try { + $app->notify($notification); + } catch (\InvalidArgumentException $e) { + } } } @@ -139,11 +142,13 @@ class Manager implements IManager { foreach ($notifiers as $notifier) { try { $notifier->prepare($notification, $languageCode); - } catch (\InvalidArgumentException $e) {} - } + } catch (\InvalidArgumentException $e) { + continue; + } - if (!$notification->isValidParsed()) { - throw new \InvalidArgumentException('The given notification has not been handled'); + if (!$notification->isValidParsed()) { + throw new \InvalidArgumentException('The given notification has not been handled'); + } } return $notification; From f0ecfa6e6c49253230fa847ff2ce7082f6c97e68 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 1 Sep 2015 10:28:11 +0200 Subject: [PATCH 05/19] Add the app id to the markProcessed method --- lib/private/notification/manager.php | 5 +++-- lib/public/notification/iapp.php | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/private/notification/manager.php b/lib/private/notification/manager.php index c721f610113..1946c4203d4 100644 --- a/lib/private/notification/manager.php +++ b/lib/private/notification/manager.php @@ -155,16 +155,17 @@ class Manager implements IManager { } /** + * @param string $appId * @param string $objectType * @param int $objectId * @param string $user * @return null */ - public function markProcessed($objectType, $objectId, $user = '') { + public function markProcessed($appId, $objectType, $objectId, $user = '') { $apps = $this->getApps(); foreach ($apps as $app) { - $app->markProcessed($objectType, $objectId, $user); + $app->markProcessed($appId, $objectType, $objectId, $user); } } diff --git a/lib/public/notification/iapp.php b/lib/public/notification/iapp.php index b7bf41ce7f5..e2b0e89fc32 100644 --- a/lib/public/notification/iapp.php +++ b/lib/public/notification/iapp.php @@ -41,13 +41,14 @@ interface IApp { public function notify(INotification $notification); /** + * @param string $appId * @param string $objectType * @param int $objectId * @param string $user * @return null * @since 8.2.0 */ - public function markProcessed($objectType, $objectId, $user = ''); + public function markProcessed($appId, $objectType, $objectId, $user = ''); /** * @param string $user From 3bdfef910708eaba19daaf7d1d992cd4575af3b4 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 1 Sep 2015 10:46:08 +0200 Subject: [PATCH 06/19] Add the request type to the action --- lib/private/notification/action.php | 10 +++++++++- lib/public/notification/iaction.php | 3 ++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/lib/private/notification/action.php b/lib/private/notification/action.php index 09e37a70d5e..2f7c1a5b5f4 100644 --- a/lib/private/notification/action.php +++ b/lib/private/notification/action.php @@ -34,6 +34,9 @@ class Action implements IAction { /** @var string */ protected $link; + /** @var string */ + protected $requestType; + /** @var string */ protected $icon; @@ -44,6 +47,7 @@ class Action implements IAction { $this->label = ''; $this->labelParsed = ''; $this->link = ''; + $this->requestType = ''; $this->icon = ''; } @@ -93,14 +97,18 @@ class Action implements IAction { /** * @param string $link + * @param string $requestType * @return $this * @throws \InvalidArgumentException if the link is invalid * @since 8.2.0 */ - public function setLink($link) { + public function setLink($link, $requestType) { if (!is_string($link) || $link === '' || isset($link[256])) { throw new \InvalidArgumentException('The given link is invalid'); } + if (!in_array($requestType, ['GET', 'POST', 'PUT', 'DELETE'])) { + throw new \InvalidArgumentException('The given request type is invalid'); + } $this->link = $link; return $this; } diff --git a/lib/public/notification/iaction.php b/lib/public/notification/iaction.php index 334f6cc44a7..db60f6cedbb 100644 --- a/lib/public/notification/iaction.php +++ b/lib/public/notification/iaction.php @@ -62,11 +62,12 @@ interface IAction { /** * @param string $link + * @param string $requestType * @return $this * @throws \InvalidArgumentException if the link is invalid * @since 8.2.0 */ - public function setLink($link); + public function setLink($link, $requestType); /** * @return string From 913e2e9ae67de805d99039105c634c843009345e Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 1 Sep 2015 10:46:32 +0200 Subject: [PATCH 07/19] Use an INotification to getCount() and markProcessed() --- lib/private/notification/manager.php | 16 ++++++---------- lib/public/notification/iapp.php | 12 ++++-------- 2 files changed, 10 insertions(+), 18 deletions(-) diff --git a/lib/private/notification/manager.php b/lib/private/notification/manager.php index 1946c4203d4..f14929642dc 100644 --- a/lib/private/notification/manager.php +++ b/lib/private/notification/manager.php @@ -155,31 +155,27 @@ class Manager implements IManager { } /** - * @param string $appId - * @param string $objectType - * @param int $objectId - * @param string $user + * @param INotification $notification * @return null */ - public function markProcessed($appId, $objectType, $objectId, $user = '') { + public function markProcessed(INotification $notification) { $apps = $this->getApps(); foreach ($apps as $app) { - $app->markProcessed($appId, $objectType, $objectId, $user); + $app->markProcessed($notification); } } /** - * @param string $user - * @param string $appId + * @param INotification $notification * @return int */ - public function getCount($user, $appId = '') { + public function getCount(INotification $notification) { $apps = $this->getApps(); $count = 0; foreach ($apps as $app) { - $count += $app->markProcessed($user, $appId); + $count += $app->markProcessed($notification); } return $count; diff --git a/lib/public/notification/iapp.php b/lib/public/notification/iapp.php index e2b0e89fc32..a4718a21b60 100644 --- a/lib/public/notification/iapp.php +++ b/lib/public/notification/iapp.php @@ -41,20 +41,16 @@ interface IApp { public function notify(INotification $notification); /** - * @param string $appId - * @param string $objectType - * @param int $objectId - * @param string $user + * @param INotification $notification * @return null * @since 8.2.0 */ - public function markProcessed($appId, $objectType, $objectId, $user = ''); + public function markProcessed(INotification $notification); /** - * @param string $user - * @param string $appId + * @param INotification $notification * @return int * @since 8.2.0 */ - public function getCount($user, $appId = ''); + public function getCount(INotification $notification); } From 21b83dc730c9eebd9eb4d8c9944f680514eb2121 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 1 Sep 2015 12:09:39 +0200 Subject: [PATCH 08/19] Allow getting the request type --- lib/private/notification/action.php | 8 ++++++++ lib/public/notification/iaction.php | 6 ++++++ 2 files changed, 14 insertions(+) diff --git a/lib/private/notification/action.php b/lib/private/notification/action.php index 2f7c1a5b5f4..08f3d50bac2 100644 --- a/lib/private/notification/action.php +++ b/lib/private/notification/action.php @@ -121,6 +121,14 @@ class Action implements IAction { return $this->link; } + /** + * @return string + * @since 8.2.0 + */ + public function getRequestType() { + return $this->requestType; + } + /** * @param string $icon * @return $this diff --git a/lib/public/notification/iaction.php b/lib/public/notification/iaction.php index db60f6cedbb..64b95bdb5ad 100644 --- a/lib/public/notification/iaction.php +++ b/lib/public/notification/iaction.php @@ -75,6 +75,12 @@ interface IAction { */ public function getLink(); + /** + * @return string + * @since 8.2.0 + */ + public function getRequestType(); + /** * @param string $icon * @return $this From d04021b1ac8e9717adb39111622a7d024d90502d Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 1 Sep 2015 17:06:38 +0200 Subject: [PATCH 09/19] Fix the request type and the validity --- lib/private/notification/action.php | 1 + lib/private/notification/notification.php | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/lib/private/notification/action.php b/lib/private/notification/action.php index 08f3d50bac2..f0bcb23c877 100644 --- a/lib/private/notification/action.php +++ b/lib/private/notification/action.php @@ -110,6 +110,7 @@ class Action implements IAction { throw new \InvalidArgumentException('The given request type is invalid'); } $this->link = $link; + $this->requestType = $requestType; return $this; } diff --git a/lib/private/notification/notification.php b/lib/private/notification/notification.php index 9262a198b52..17246ddef32 100644 --- a/lib/private/notification/notification.php +++ b/lib/private/notification/notification.php @@ -316,7 +316,7 @@ class Notification implements INotification { * @since 8.2.0 */ public function setLink($link) { - if (!is_string($link) || $link === '' || isset($link[256])) { + if (!is_string($link) || $link === '' || isset($link[4000])) { throw new \InvalidArgumentException('The given link is invalid'); } $this->link = $link; @@ -368,7 +368,7 @@ class Notification implements INotification { * @since 8.2.0 */ public function addAction(IAction $action) { - if ($action->isValid()) { + if (!$action->isValid()) { throw new \InvalidArgumentException('The given action is invalid'); } $this->actions[] = $action; @@ -390,7 +390,7 @@ class Notification implements INotification { * @since 8.2.0 */ public function addParsedAction(IAction $action) { - if ($action->isValidParsed()) { + if (!$action->isValidParsed()) { throw new \InvalidArgumentException('The given parsed action is invalid'); } $this->actions[] = $action; From 57c273b2dae918e1b007c1f1d1cd37ec9f6fb248 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 1 Sep 2015 17:58:23 +0200 Subject: [PATCH 10/19] Fix closures and adding parsed Actions --- lib/private/notification/manager.php | 4 ++-- lib/private/notification/notification.php | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/private/notification/manager.php b/lib/private/notification/manager.php index f14929642dc..eee03d93db2 100644 --- a/lib/private/notification/manager.php +++ b/lib/private/notification/manager.php @@ -71,7 +71,7 @@ class Manager implements IManager { } foreach ($this->appsClosures as $closure) { - $app = $closure; + $app = $closure(); if (!($app instanceof IApp)) { throw new \InvalidArgumentException('The given notification app does not implement the IApp interface'); } @@ -90,7 +90,7 @@ class Manager implements IManager { } foreach ($this->notifiersClosures as $closure) { - $notifier = $closure; + $notifier = $closure(); if (!($notifier instanceof INotifier)) { throw new \InvalidArgumentException('The given notification app does not implement the INotifier interface'); } diff --git a/lib/private/notification/notification.php b/lib/private/notification/notification.php index 17246ddef32..f5171f150c6 100644 --- a/lib/private/notification/notification.php +++ b/lib/private/notification/notification.php @@ -393,7 +393,7 @@ class Notification implements INotification { if (!$action->isValidParsed()) { throw new \InvalidArgumentException('The given parsed action is invalid'); } - $this->actions[] = $action; + $this->actionsParsed[] = $action; return $this; } From d191a0daccfa923dcef4ffa9c020fe01f3caf129 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 1 Sep 2015 17:59:01 +0200 Subject: [PATCH 11/19] Add notifications for remote shares --- apps/files_sharing/api/server2server.php | 22 ++++++ apps/files_sharing/appinfo/app.php | 7 ++ apps/files_sharing/lib/notifier.php | 86 ++++++++++++++++++++++++ 3 files changed, 115 insertions(+) create mode 100644 apps/files_sharing/lib/notifier.php diff --git a/apps/files_sharing/api/server2server.php b/apps/files_sharing/api/server2server.php index 4328e3830ba..d5f1dce5055 100644 --- a/apps/files_sharing/api/server2server.php +++ b/apps/files_sharing/api/server2server.php @@ -82,6 +82,28 @@ class Server2Server { Activity::FILES_SHARING_APP, Activity::SUBJECT_REMOTE_SHARE_RECEIVED, array($user, trim($name, '/')), '', array(), '', '', $shareWith, Activity::TYPE_REMOTE_SHARE, Activity::PRIORITY_LOW); + $urlGenerator = \OC::$server->getURLGenerator(); + + $notificationManager = \OC::$server->getNotificationManager(); + $notification = $notificationManager->createNotification(); + $notification->setApp('files_sharing') + ->setUser($shareWith) + ->setTimestamp(time()) + ->setObject('remote_share', $remoteId) + ->setSubject('remote_share', [$user, trim($name, '/')]); + + $acceptAction = $notification->createAction(); + $acceptAction->setLabel('accept') + ->setLink($urlGenerator->getAbsoluteURL('/ocs/v1.php/apps/files_sharing/api/v1/remote_shares/' . $remoteId), 'POST'); + $declineAction = $notification->createAction(); + $declineAction->setLabel('decline') + ->setLink($urlGenerator->getAbsoluteURL('/ocs/v1.php/apps/files_sharing/api/v1/remote_shares/' . $remoteId), 'DELETE'); + + $notification->addAction($acceptAction) + ->addAction($declineAction); + + $notificationManager->notify($notification); + return new \OC_OCS_Result(); } catch (\Exception $e) { \OCP\Util::writeLog('files_sharing', 'server can not add remote share, ' . $e->getMessage(), \OCP\Util::ERROR); diff --git a/apps/files_sharing/appinfo/app.php b/apps/files_sharing/appinfo/app.php index 295d013beff..20f1b046d35 100644 --- a/apps/files_sharing/appinfo/app.php +++ b/apps/files_sharing/appinfo/app.php @@ -103,3 +103,10 @@ if ($config->getAppValue('core', 'shareapi_enabled', 'yes') === 'yes') { } } } + +$manager = \OC::$server->getNotificationManager(); +$manager->registerNotifier(function() { + return new \OCA\Files_Sharing\Notifier( + \OC::$server->getL10NFactory() + ); +}); diff --git a/apps/files_sharing/lib/notifier.php b/apps/files_sharing/lib/notifier.php new file mode 100644 index 00000000000..e050d4d3c1a --- /dev/null +++ b/apps/files_sharing/lib/notifier.php @@ -0,0 +1,86 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OCA\Files_Sharing; + + +use OCP\Notification\INotification; +use OCP\Notification\INotifier; + +class Notifier implements INotifier { + /** @var \OCP\L10N\IFactory */ + protected $factory; + + /** + * @param \OCP\L10N\IFactory $factory + */ + public function __construct(\OCP\L10N\IFactory $factory) { + $this->factory = $factory; + } + + /** + * @param INotification $notification + * @param string $languageCode The code of the language that should be used to prepare the notification + * @return INotification + */ + public function prepare(INotification $notification, $languageCode) { + if ($notification->getApp() !== 'files_sharing') { + // Not my app => throw + throw new \InvalidArgumentException(); + } + + // Read the language from the notification + $l = $this->factory->get('files_sharing', $languageCode); + + switch ($notification->getSubject()) { + // Deal with known subjects + case 'remote_share': + $params = $notification->getSubjectParameters(); + $notification->setParsedSubject( + (string) $l->t('You received %s as a remote share from %s', $params) + ); + + // Deal with the actions for a known subject + foreach ($notification->getActions() as $action) { + switch ($action->getLabel()) { + case 'accept': + $action->setParsedLabel( + (string) $l->t('Accept') + ); + break; + + case 'decline': + $action->setParsedLabel( + (string) $l->t('Decline') + ); + break; + } + + $notification->addParsedAction($action); + } + return $notification; + + default: + // Unknown subject => Unknown notification => throw + throw new \InvalidArgumentException(); + } + } +} From 805f1d0096205d346173ab4c0cf314e1c95eba2f Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 1 Sep 2015 18:56:09 +0200 Subject: [PATCH 12/19] Scrap the notifications when the share is accepted or declined --- apps/files_sharing/ajax/external.php | 1 + apps/files_sharing/api/remote.php | 5 +++- apps/files_sharing/api/server2server.php | 1 + apps/files_sharing/appinfo/application.php | 1 + apps/files_sharing/lib/external/manager.php | 24 ++++++++++++++++++- apps/files_sharing/lib/hooks.php | 1 + .../tests/external/managertest.php | 1 + apps/files_sharing/tests/server2server.php | 1 + 8 files changed, 33 insertions(+), 2 deletions(-) diff --git a/apps/files_sharing/ajax/external.php b/apps/files_sharing/ajax/external.php index d26a64d3aec..66cfd8e9d1a 100644 --- a/apps/files_sharing/ajax/external.php +++ b/apps/files_sharing/ajax/external.php @@ -52,6 +52,7 @@ $externalManager = new \OCA\Files_Sharing\External\Manager( \OC\Files\Filesystem::getMountManager(), \OC\Files\Filesystem::getLoader(), \OC::$server->getHTTPHelper(), + \OC::$server->getNotificationManager(), \OC::$server->getUserSession()->getUser()->getUID() ); diff --git a/apps/files_sharing/api/remote.php b/apps/files_sharing/api/remote.php index f6cb0a29d8b..404787c3895 100644 --- a/apps/files_sharing/api/remote.php +++ b/apps/files_sharing/api/remote.php @@ -23,6 +23,7 @@ namespace OCA\Files_Sharing\API; use OC\Files\Filesystem; use OCA\Files_Sharing\External\Manager; +use OCP\Notification\IManager; class Remote { @@ -38,6 +39,7 @@ class Remote { Filesystem::getMountManager(), Filesystem::getLoader(), \OC::$server->getHTTPHelper(), + \OC::$server->getNotificationManager(), \OC_User::getUser() ); @@ -56,6 +58,7 @@ class Remote { Filesystem::getMountManager(), Filesystem::getLoader(), \OC::$server->getHTTPHelper(), + \OC::$server->getNotificationManager(), \OC_User::getUser() ); @@ -78,6 +81,7 @@ class Remote { Filesystem::getMountManager(), Filesystem::getLoader(), \OC::$server->getHTTPHelper(), + \OC::$server->getNotificationManager(), \OC_User::getUser() ); @@ -87,5 +91,4 @@ class Remote { return new \OC_OCS_Result(null, 404, "wrong share ID, share doesn't exist."); } - } diff --git a/apps/files_sharing/api/server2server.php b/apps/files_sharing/api/server2server.php index d5f1dce5055..6ecaea20535 100644 --- a/apps/files_sharing/api/server2server.php +++ b/apps/files_sharing/api/server2server.php @@ -70,6 +70,7 @@ class Server2Server { \OC\Files\Filesystem::getMountManager(), \OC\Files\Filesystem::getLoader(), \OC::$server->getHTTPHelper(), + \OC::$server->getNotificationManager(), $shareWith ); diff --git a/apps/files_sharing/appinfo/application.php b/apps/files_sharing/appinfo/application.php index 530195c65fa..d0dcadb77e8 100644 --- a/apps/files_sharing/appinfo/application.php +++ b/apps/files_sharing/appinfo/application.php @@ -93,6 +93,7 @@ class Application extends App { \OC\Files\Filesystem::getMountManager(), \OC\Files\Filesystem::getLoader(), $server->getHTTPHelper(), + $server->getNotificationManager(), $uid ); }); diff --git a/apps/files_sharing/lib/external/manager.php b/apps/files_sharing/lib/external/manager.php index 67a26c096c2..18b9c724dea 100644 --- a/apps/files_sharing/lib/external/manager.php +++ b/apps/files_sharing/lib/external/manager.php @@ -28,6 +28,7 @@ namespace OCA\Files_Sharing\External; use OC\Files\Filesystem; use OCP\Files; +use OCP\Notification\IManager; class Manager { const STORAGE = '\OCA\Files_Sharing\External\Storage'; @@ -57,20 +58,27 @@ class Manager { */ private $httpHelper; + /** + * @var IManager + */ + private $notificationManager; + /** * @param \OCP\IDBConnection $connection * @param \OC\Files\Mount\Manager $mountManager * @param \OCP\Files\Storage\IStorageFactory $storageLoader * @param \OC\HTTPHelper $httpHelper + * @param IManager $notificationManager * @param string $uid */ public function __construct(\OCP\IDBConnection $connection, \OC\Files\Mount\Manager $mountManager, - \OCP\Files\Storage\IStorageFactory $storageLoader, \OC\HTTPHelper $httpHelper, $uid) { + \OCP\Files\Storage\IStorageFactory $storageLoader, \OC\HTTPHelper $httpHelper, IManager $notificationManager, $uid) { $this->connection = $connection; $this->mountManager = $mountManager; $this->storageLoader = $storageLoader; $this->httpHelper = $httpHelper; $this->uid = $uid; + $this->notificationManager = $notificationManager; } /** @@ -206,6 +214,7 @@ class Manager { $acceptShare->execute(array(1, $mountPoint, $hash, $id, $this->uid)); $this->sendFeedbackToRemote($share['remote'], $share['share_token'], $share['remote_id'], 'accept'); + $this->scrapNotification($share['remote_id']); return true; } @@ -228,12 +237,24 @@ class Manager { $removeShare->execute(array($id, $this->uid)); $this->sendFeedbackToRemote($share['remote'], $share['share_token'], $share['remote_id'], 'decline'); + $this->scrapNotification($share['remote_id']); return true; } return false; } + /** + * @param int $remoteShare + */ + protected function scrapNotification($remoteShare) { + $filter = $this->notificationManager->createNotification(); + $filter->setApp('files_sharing') + ->setUser($this->uid) + ->setObject('remote_share', (int) $remoteShare); + $this->notificationManager->markProcessed($filter); + } + /** * inform remote server whether server-to-server share was accepted/declined * @@ -265,6 +286,7 @@ class Manager { \OC\Files\Filesystem::getMountManager(), \OC\Files\Filesystem::getLoader(), \OC::$server->getHTTPHelper(), + \OC::$server->getNotificationManager(), $params['user'] ); diff --git a/apps/files_sharing/lib/hooks.php b/apps/files_sharing/lib/hooks.php index 7dd04f2f4a0..1937010f390 100644 --- a/apps/files_sharing/lib/hooks.php +++ b/apps/files_sharing/lib/hooks.php @@ -33,6 +33,7 @@ class Hooks { \OC\Files\Filesystem::getMountManager(), \OC\Files\Filesystem::getLoader(), \OC::$server->getHTTPHelper(), + \OC::$server->getNotificationManager(), $params['uid']); $manager->removeUserShares($params['uid']); diff --git a/apps/files_sharing/tests/external/managertest.php b/apps/files_sharing/tests/external/managertest.php index df01ea0f738..8e03c67a9a3 100644 --- a/apps/files_sharing/tests/external/managertest.php +++ b/apps/files_sharing/tests/external/managertest.php @@ -50,6 +50,7 @@ class ManagerTest extends TestCase { $this->mountManager, new StorageFactory(), $httpHelper, + \OC::$server->getNotificationManager(), $this->uid ); } diff --git a/apps/files_sharing/tests/server2server.php b/apps/files_sharing/tests/server2server.php index a1c87d73393..a4cc8209a8e 100644 --- a/apps/files_sharing/tests/server2server.php +++ b/apps/files_sharing/tests/server2server.php @@ -154,6 +154,7 @@ class Test_Files_Sharing_S2S_OCS_API extends TestCase { \OC\Files\Filesystem::getMountManager(), \OC\Files\Filesystem::getLoader(), \OC::$server->getHTTPHelper(), + \OC::$server->getNotificationManager(), $toDelete ); From 0d154595f81e9c181a73ee44650fffe78bccc002 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Wed, 2 Sep 2015 13:09:46 +0200 Subject: [PATCH 13/19] Fix the subject of notifications --- lib/private/notification/manager.php | 2 +- lib/private/notification/notification.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/private/notification/manager.php b/lib/private/notification/manager.php index eee03d93db2..933c6199bc5 100644 --- a/lib/private/notification/manager.php +++ b/lib/private/notification/manager.php @@ -141,7 +141,7 @@ class Manager implements IManager { foreach ($notifiers as $notifier) { try { - $notifier->prepare($notification, $languageCode); + $notification = $notifier->prepare($notification, $languageCode); } catch (\InvalidArgumentException $e) { continue; } diff --git a/lib/private/notification/notification.php b/lib/private/notification/notification.php index f5171f150c6..5151b5546a8 100644 --- a/lib/private/notification/notification.php +++ b/lib/private/notification/notification.php @@ -248,7 +248,7 @@ class Notification implements INotification { * @since 8.2.0 */ public function getParsedSubject() { - return $this->messageParsed; + return $this->subjectParsed; } /** From acf8149f17fb940c9c9ce1519869a1de34ef6a84 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Thu, 3 Sep 2015 12:12:10 +0200 Subject: [PATCH 14/19] Add tests for Action --- lib/private/notification/action.php | 2 +- lib/public/notification/iaction.php | 2 + tests/lib/notification/actiontest.php | 232 ++++++++++++++++++++++++++ 3 files changed, 235 insertions(+), 1 deletion(-) create mode 100644 tests/lib/notification/actiontest.php diff --git a/lib/private/notification/action.php b/lib/private/notification/action.php index f0bcb23c877..7f654bf9082 100644 --- a/lib/private/notification/action.php +++ b/lib/private/notification/action.php @@ -106,7 +106,7 @@ class Action implements IAction { if (!is_string($link) || $link === '' || isset($link[256])) { throw new \InvalidArgumentException('The given link is invalid'); } - if (!in_array($requestType, ['GET', 'POST', 'PUT', 'DELETE'])) { + if (!in_array($requestType, ['GET', 'POST', 'PUT', 'DELETE'], true)) { throw new \InvalidArgumentException('The given request type is invalid'); } $this->link = $link; diff --git a/lib/public/notification/iaction.php b/lib/public/notification/iaction.php index 64b95bdb5ad..8db1eaa6543 100644 --- a/lib/public/notification/iaction.php +++ b/lib/public/notification/iaction.php @@ -97,11 +97,13 @@ interface IAction { /** * @return bool + * @since 8.2.0 */ public function isValid(); /** * @return bool + * @since 8.2.0 */ public function isValidParsed(); } diff --git a/tests/lib/notification/actiontest.php b/tests/lib/notification/actiontest.php new file mode 100644 index 00000000000..5b3f10f9ce8 --- /dev/null +++ b/tests/lib/notification/actiontest.php @@ -0,0 +1,232 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace Test\Notification; + + +use OC\Notification\Action; +use OCP\Notification\IAction; + +class ActionTest extends \Test\TestCase { + /** @var IAction */ + protected $action; + + public function setUp() { + parent::setUp(); + $this->action = new Action(); + } + + public function dataSetLabel() { + return [ + ['test1'], + ['test2'], + ]; + } + + /** + * @dataProvider dataSetLabel + * @param string $label + */ + public function testSetLabel($label) { + $this->assertSame('', $this->action->getLabel()); + $this->action->setLabel($label); + $this->assertSame($label, $this->action->getLabel()); + } + + public function dataSetLabelInvalid() { + return [ + [true], + [false], + [0], + [1], + [''], + [str_repeat('a', 33)], + [[]], + [[str_repeat('a', 33)]], + ]; + } + + /** + * @dataProvider dataSetLabelInvalid + * @param string $label + * + * @expectedException \InvalidArgumentException + */ + public function testSetLabelInvalid($label) { + $this->action->setLabel($label); + } + + public function dataSetParsedLabel() { + return [ + ['test1'], + ['test2'], + ]; + } + + /** + * @dataProvider dataSetParsedLabel + * @param string $label + */ + public function testSetParsedLabel($label) { + $this->assertSame('', $this->action->getParsedLabel()); + $this->action->setParsedLabel($label); + $this->assertSame($label, $this->action->getParsedLabel()); + } + + public function dataSetParsedLabelInvalid() { + return [ + [true], + [false], + [0], + [1], + [''], + [[]], + [[str_repeat('a', 33)]], + ]; + } + + /** + * @dataProvider dataSetParsedLabelInvalid + * @param string $label + * + * @expectedException \InvalidArgumentException + */ + public function testSetParsedLabelInvalid($label) { + $this->action->setParsedLabel($label); + } + + public function dataSetLink() { + return [ + ['test1', 'GET'], + ['test2', 'POST'], + ['test3', 'PUT'], + ['test4', 'DELETE'], + ]; + } + + /** + * @dataProvider dataSetLink + * @param string $link + * @param string $type + */ + public function testSetLink($link, $type) { + $this->assertSame('', $this->action->getLink()); + $this->action->setLink($link, $type); + $this->assertSame($link, $this->action->getLink()); + $this->assertSame($type, $this->action->getRequestType()); + } + + public function dataSetLinkInvalid() { + return [ + // Invalid link + [true, 'GET'], + [false, 'GET'], + [0, 'GET'], + [1, 'GET'], + ['', 'GET'], + [str_repeat('a', 257), 'GET'], + [[], 'GET'], + [[str_repeat('a', 257)], 'GET'], + + // Invalid type + ['url', 'notGET'], + ['url', true], + ['url', false], + ['url', 0], + ['url', 1], + ['url', []], + ['url', ['GET']], + ]; + } + + /** + * @dataProvider dataSetLinkInvalid + * @param string $link + * @param string $type + * + * @expectedException \InvalidArgumentException + */ + public function testSetLinkInvalid($link, $type) { + $this->action->setLink($link, $type); + } + + public function dataSetIcon() { + return [ + ['test1'], + ['test2'], + ]; + } + + /** + * @dataProvider dataSetIcon + * @param string $icon + */ + public function testSetIcon($icon) { + $this->assertSame('', $this->action->getIcon()); + $this->action->setIcon($icon); + $this->assertSame($icon, $this->action->getIcon()); + } + + public function dataSetIconInvalid() { + return [ + [true], + [false], + [0], + [1], + [''], + [str_repeat('a', 65)], + [[]], + [[str_repeat('a', 65)]], + ]; + } + + /** + * @dataProvider dataSetIconInvalid + * @param string $icon + * + * @expectedException \InvalidArgumentException + */ + public function testSetIconInvalid($icon) { + $this->action->setIcon($icon); + } + + public function testIsValid() { + $this->assertFalse($this->action->isValid()); + $this->assertFalse($this->action->isValidParsed()); + $this->action->setLabel('label'); + $this->assertFalse($this->action->isValid()); + $this->assertFalse($this->action->isValidParsed()); + $this->action->setLink('link', 'GET'); + $this->assertTrue($this->action->isValid()); + $this->assertFalse($this->action->isValidParsed()); + } + + public function testIsValidParsed() { + $this->assertFalse($this->action->isValid()); + $this->assertFalse($this->action->isValidParsed()); + $this->action->setParsedLabel('label'); + $this->assertFalse($this->action->isValid()); + $this->assertFalse($this->action->isValidParsed()); + $this->action->setLink('link', 'GET'); + $this->assertFalse($this->action->isValid()); + $this->assertTrue($this->action->isValidParsed()); + } +} From c6469be8bdb70a57da5212f7b1e8e4836e0bb2be Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Thu, 3 Sep 2015 14:47:49 +0200 Subject: [PATCH 15/19] Add tests for notification --- lib/private/notification/notification.php | 16 +- tests/lib/notification/notificationtest.php | 602 ++++++++++++++++++++ 2 files changed, 610 insertions(+), 8 deletions(-) create mode 100644 tests/lib/notification/notificationtest.php diff --git a/lib/private/notification/notification.php b/lib/private/notification/notification.php index 5151b5546a8..2f53a347283 100644 --- a/lib/private/notification/notification.php +++ b/lib/private/notification/notification.php @@ -120,7 +120,7 @@ class Notification implements INotification { * @since 8.2.0 */ public function setUser($user) { - if (!is_string($user) || $user === '' || isset($app[64])) { + if (!is_string($user) || $user === '' || isset($user[64])) { throw new \InvalidArgumentException('The given user id is invalid'); } $this->user = $user; @@ -413,7 +413,7 @@ class Notification implements INotification { return $this->isValidCommon() && - $this->subject !== '' + $this->getSubject() !== '' ; } @@ -425,7 +425,7 @@ class Notification implements INotification { return $this->isValidCommon() && - $this->subjectParsed !== '' + $this->getParsedSubject() !== '' ; } @@ -434,15 +434,15 @@ class Notification implements INotification { */ protected function isValidCommon() { return - $this->app !== '' + $this->getApp() !== '' && - $this->user !== '' + $this->getUser() !== '' && - $this->timestamp !== 0 + $this->getTimestamp() !== 0 && - $this->objectType !== '' + $this->getObjectType() !== '' && - $this->objectId !== 0 + $this->getObjectId() !== 0 ; } } diff --git a/tests/lib/notification/notificationtest.php b/tests/lib/notification/notificationtest.php new file mode 100644 index 00000000000..8f1779dd968 --- /dev/null +++ b/tests/lib/notification/notificationtest.php @@ -0,0 +1,602 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace Test\Notification; + + +use OC\Notification\Action; +use OC\Notification\Notification; +use OCP\Notification\IAction; +use OCP\Notification\INotification; + +class NotificationTest extends \Test\TestCase { + /** @var INotification */ + protected $notification; + + public function setUp() { + parent::setUp(); + $this->notification = new Notification(); + } + + protected function dataValidString($maxLength) { + $dataSets = [ + ['test1'], + [str_repeat('a', 1)], + ]; + if ($maxLength !== false) { + $dataSets[] = [str_repeat('a', $maxLength)]; + } + return $dataSets; + } + + protected function dataInvalidString($maxLength) { + $dataSets = [ + [true], + [false], + [0], + [1], + [''], + [[]], + ]; + if ($maxLength !== false) { + $dataSets[] = [str_repeat('a', $maxLength + 1)]; + $dataSets[] = [[str_repeat('a', $maxLength + 1)]]; + } + return $dataSets; + } + + protected function dataValidInt() { + return [ + [0], + [1], + [time()], + ]; + } + + protected function dataInvalidInt() { + return [ + [true], + [false], + [''], + ['a'], + [str_repeat('a', 256)], + [[]], + [['a']], + [[str_repeat('a', 256)]], + ]; + } + + public function dataSetApp() { + return $this->dataValidString(32); + } + + /** + * @dataProvider dataSetApp + * @param string $app + */ + public function testSetApp($app) { + $this->assertSame('', $this->notification->getApp()); + $this->notification->setApp($app); + $this->assertSame($app, $this->notification->getApp()); + } + + public function dataSetAppInvalid() { + return $this->dataInvalidString(32); + } + + /** + * @dataProvider dataSetAppInvalid + * @param mixed $app + * + * @expectedException \InvalidArgumentException + */ + public function testSetAppInvalid($app) { + $this->notification->setApp($app); + } + + public function dataSetUser() { + return $this->dataValidString(64); + } + + /** + * @dataProvider dataSetUser + * @param string $user + */ + public function testSetUser($user) { + $this->assertSame('', $this->notification->getUser()); + $this->notification->setUser($user); + $this->assertSame($user, $this->notification->getUser()); + } + + public function dataSetUserInvalid() { + return $this->dataInvalidString(64); + } + + /** + * @dataProvider dataSetUserInvalid + * @param mixed $user + * + * @expectedException \InvalidArgumentException + */ + public function testSetUserInvalid($user) { + $this->notification->setUser($user); + } + + public function dataSetTimestamp() { + return $this->dataValidInt(); + } + + /** + * @dataProvider dataSetTimestamp + * @param int $timestamp + */ + public function testSetTimestamp($timestamp) { + $this->assertSame(0, $this->notification->getTimestamp()); + $this->notification->setTimestamp($timestamp); + $this->assertSame($timestamp, $this->notification->getTimestamp()); + } + + public function dataSetTimestampInvalid() { + return $this->dataInvalidInt(); + } + + /** + * @dataProvider dataSetTimestampInvalid + * @param mixed $timestamp + * + * @expectedException \InvalidArgumentException + */ + public function testSetTimestampInvalid($timestamp) { + $this->notification->setTimestamp($timestamp); + } + + public function dataSetObject() { + return [ + ['a', 1], + [str_repeat('a', 64), time()], + ]; + } + + /** + * @dataProvider dataSetObject + * @param string $type + * @param int $id + */ + public function testSetObject($type, $id) { + $this->assertSame('', $this->notification->getObjectType()); + $this->assertSame(0, $this->notification->getObjectId()); + $this->notification->setObject($type, $id); + $this->assertSame($type, $this->notification->getObjectType()); + $this->assertSame($id, $this->notification->getObjectId()); + } + + public function dataSetObjectTypeInvalid() { + return $this->dataInvalidString(64); + } + + /** + * @dataProvider dataSetObjectTypeInvalid + * @param mixed $type + * + * @expectedException \InvalidArgumentException + * @expectedMessage 'The given object type is invalid' + */ + public function testSetObjectTypeInvalid($type) { + $this->notification->setObject($type, 1337); + } + + public function dataSetObjectIdInvalid() { + return $this->dataInvalidInt(); + } + + /** + * @dataProvider dataSetObjectIdInvalid + * @param mixed $id + * + * @expectedException \InvalidArgumentException + * @expectedMessage 'The given object id is invalid' + */ + public function testSetObjectIdInvalid($id) { + $this->notification->setObject('object', $id); + } + + public function dataSetSubject() { + return [ + ['a', []], + [str_repeat('a', 64), [str_repeat('a', 160)]], + [str_repeat('a', 64), array_fill(0, 160, 'a')], + ]; + } + + /** + * @dataProvider dataSetSubject + * @param string $subject + * @param array $parameters + */ + public function testSetSubject($subject, $parameters) { + $this->assertSame('', $this->notification->getSubject()); + $this->assertSame([], $this->notification->getSubjectParameters()); + $this->notification->setSubject($subject, $parameters); + $this->assertSame($subject, $this->notification->getSubject()); + $this->assertSame($parameters, $this->notification->getSubjectParameters()); + } + + public function dataSetSubjectInvalidSubject() { + return $this->dataInvalidString(64); + } + + /** + * @dataProvider dataSetSubjectInvalidSubject + * @param mixed $subject + * + * @expectedException \InvalidArgumentException + */ + public function testSetSubjectInvalidSubject($subject) { + $this->notification->setSubject($subject, []); + } + + public function dataSetParsedSubject() { + return $this->dataValidString(false); + } + + /** + * @dataProvider dataSetParsedSubject + * @param string $subject + */ + public function testSetParsedSubject($subject) { + $this->assertSame('', $this->notification->getParsedSubject()); + $this->notification->setParsedSubject($subject); + $this->assertSame($subject, $this->notification->getParsedSubject()); + } + + public function dataSetParsedSubjectInvalid() { + return $this->dataInvalidString(false); + } + + /** + * @dataProvider dataSetParsedSubjectInvalid + * @param mixed $subject + * + * @expectedException \InvalidArgumentException + */ + public function testSetParsedSubjectInvalid($subject) { + $this->notification->setParsedSubject($subject); + } + + public function dataSetMessage() { + return [ + ['a', []], + [str_repeat('a', 64), [str_repeat('a', 160)]], + [str_repeat('a', 64), array_fill(0, 160, 'a')], + ]; + } + + /** + * @dataProvider dataSetMessage + * @param string $message + * @param array $parameters + */ + public function testSetMessage($message, $parameters) { + $this->assertSame('', $this->notification->getMessage()); + $this->assertSame([], $this->notification->getMessageParameters()); + $this->notification->setMessage($message, $parameters); + $this->assertSame($message, $this->notification->getMessage()); + $this->assertSame($parameters, $this->notification->getMessageParameters()); + } + + public function dataSetMessageInvalidMessage() { + return $this->dataInvalidString(64); + } + + /** + * @dataProvider dataSetMessageInvalidMessage + * @param mixed $message + * + * @expectedException \InvalidArgumentException + */ + public function testSetMessageInvalidMessage($message) { + $this->notification->setMessage($message, []); + } + + public function dataSetParsedMessage() { + return $this->dataValidString(false); + } + + /** + * @dataProvider dataSetParsedMessage + * @param string $message + */ + public function testSetParsedMessage($message) { + $this->assertSame('', $this->notification->getParsedMessage()); + $this->notification->setParsedMessage($message); + $this->assertSame($message, $this->notification->getParsedMessage()); + } + + public function dataSetParsedMessageInvalid() { + return $this->dataInvalidString(false); + } + + /** + * @dataProvider dataSetParsedMessageInvalid + * @param mixed $message + * + * @expectedException \InvalidArgumentException + */ + public function testSetParsedMessageInvalid($message) { + $this->notification->setParsedMessage($message); + } + + public function dataSetLink() { + return $this->dataValidString(4000); + } + + /** + * @dataProvider dataSetLink + * @param string $link + */ + public function testSetLink($link) { + $this->assertSame('', $this->notification->getLink()); + $this->notification->setLink($link); + $this->assertSame($link, $this->notification->getLink()); + } + + public function dataSetLinkInvalid() { + return $this->dataInvalidString(4000); + } + + /** + * @dataProvider dataSetLinkInvalid + * @param mixed $link + * + * @expectedException \InvalidArgumentException + */ + public function testSetLinkInvalid($link) { + $this->notification->setLink($link); + } + + public function dataSetIcon() { + return $this->dataValidString(64); + } + + /** + * @dataProvider dataSetIcon + * @param string $icon + */ + public function testSetIcon($icon) { + $this->assertSame('', $this->notification->getIcon()); + $this->notification->setIcon($icon); + $this->assertSame($icon, $this->notification->getIcon()); + } + + public function dataSetIconInvalid() { + return $this->dataInvalidString(64); + } + + /** + * @dataProvider dataSetIconInvalid + * @param mixed $icon + * + * @expectedException \InvalidArgumentException + */ + public function testSetIconInvalid($icon) { + $this->notification->setIcon($icon); + } + + public function testCreateAction() { + $action = $this->notification->createAction(); + $this->assertInstanceOf('OCP\Notification\IAction', $action); + } + + public function testAddAction() { + /** @var \OCP\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ + $action = $this->getMockBuilder('OCP\Notification\IAction') + ->disableOriginalConstructor() + ->getMock(); + $action->expects($this->once()) + ->method('isValid') + ->willReturn(true); + $action->expects($this->never()) + ->method('isValidParsed'); + + $this->notification->addAction($action); + + $this->assertEquals([$action], $this->notification->getActions()); + $this->assertEquals([], $this->notification->getParsedActions()); + } + + /** + * @expectedException \InvalidArgumentException + */ + public function testAddActionInvalid() { + /** @var \OCP\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ + $action = $this->getMockBuilder('OCP\Notification\IAction') + ->disableOriginalConstructor() + ->getMock(); + $action->expects($this->once()) + ->method('isValid') + ->willReturn(false); + $action->expects($this->never()) + ->method('isValidParsed'); + + $this->notification->addAction($action); + } + + public function testAddParsedAction() { + /** @var \OCP\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ + $action = $this->getMockBuilder('OCP\Notification\IAction') + ->disableOriginalConstructor() + ->getMock(); + $action->expects($this->once()) + ->method('isValidParsed') + ->willReturn(true); + $action->expects($this->never()) + ->method('isValid'); + + $this->notification->addParsedAction($action); + + $this->assertEquals([$action], $this->notification->getParsedActions()); + $this->assertEquals([], $this->notification->getActions()); + } + + /** + * @expectedException \InvalidArgumentException + */ + public function testAddParsedActionInvalid() { + /** @var \OCP\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ + $action = $this->getMockBuilder('OCP\Notification\IAction') + ->disableOriginalConstructor() + ->getMock(); + $action->expects($this->once()) + ->method('isValidParsed') + ->willReturn(false); + $action->expects($this->never()) + ->method('isValid'); + + $this->notification->addParsedAction($action); + } + + public function dataIsValid() { + return [ + [false, '', false], + [true, '', false], + [false, 'a', false], + [true, 'a', true], + ]; + } + + /** + * @dataProvider dataIsValid + * + * @param bool $isValidCommon + * @param string $subject + * @param bool $expected + */ + public function testIsValid($isValidCommon, $subject, $expected) { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('\OC\Notification\Notification') + ->setMethods([ + 'isValidCommon', + 'getSubject', + ]) + ->getMock(); + + $notification->expects($this->once()) + ->method('isValidCommon') + ->willReturn($isValidCommon); + + $notification->expects(!$isValidCommon ? $this->never() : $this->once()) + ->method('getSubject') + ->willReturn($subject); + + $notification->expects($this->never()) + ->method('getParsedSubject') + ->willReturn($subject); + + $this->assertEquals($expected, $notification->isValid()); + } + + /** + * @dataProvider dataIsValid + * + * @param bool $isValidCommon + * @param string $subject + * @param bool $expected + */ + public function testIsParsedValid($isValidCommon, $subject, $expected) { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('\OC\Notification\Notification') + ->setMethods([ + 'isValidCommon', + 'getParsedSubject', + ]) + ->getMock(); + + $notification->expects($this->once()) + ->method('isValidCommon') + ->willReturn($isValidCommon); + + $notification->expects(!$isValidCommon ? $this->never() : $this->once()) + ->method('getParsedSubject') + ->willReturn($subject); + + $notification->expects($this->never()) + ->method('getSubject') + ->willReturn($subject); + + $this->assertEquals($expected, $notification->isValidParsed()); + } + + public function dataIsValidCommon() { + return [ + ['', '', 0, '', 0, false], + ['app', '', 0, '', 0, false], + ['app', 'user', 0, '', 0, false], + ['app', 'user', time(), '', 0, false], + ['app', 'user', time(), 'type', 0, false], + ['app', 'user', time(), 'type', 42, true], + ]; + } + + /** + * @dataProvider dataIsValidCommon + * + * @param string $app + * @param string $user + * @param int $timestamp + * @param string $objectType + * @param int $objectId + * @param bool $expected + */ + public function testIsValidCommon($app, $user, $timestamp, $objectType, $objectId, $expected) { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('\OC\Notification\Notification') + ->setMethods([ + 'getApp', + 'getUser', + 'getTimestamp', + 'getObjectType', + 'getObjectId', + ]) + ->getMock(); + + $notification->expects($this->any()) + ->method('getApp') + ->willReturn($app); + + $notification->expects($this->any()) + ->method('getUser') + ->willReturn($user); + + $notification->expects($this->any()) + ->method('getTimestamp') + ->willReturn($timestamp); + + $notification->expects($this->any()) + ->method('getObjectType') + ->willReturn($objectType); + + $notification->expects($this->any()) + ->method('getObjectId') + ->willReturn($objectId); + + $this->assertEquals($expected, $this->invokePrivate($notification, 'isValidCommon')); + } +} From 270b0bd91b9ff5ab8fa87bd2e8124ff0bb35470b Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Thu, 3 Sep 2015 14:48:27 +0200 Subject: [PATCH 16/19] Add more action tests --- tests/lib/notification/actiontest.php | 16 ++++++++++------ tests/lib/notification/notificationtest.php | 5 ++--- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/tests/lib/notification/actiontest.php b/tests/lib/notification/actiontest.php index 5b3f10f9ce8..994e22a2f14 100644 --- a/tests/lib/notification/actiontest.php +++ b/tests/lib/notification/actiontest.php @@ -24,8 +24,9 @@ namespace Test\Notification; use OC\Notification\Action; use OCP\Notification\IAction; +use Test\TestCase; -class ActionTest extends \Test\TestCase { +class ActionTest extends TestCase { /** @var IAction */ protected $action; @@ -37,7 +38,8 @@ class ActionTest extends \Test\TestCase { public function dataSetLabel() { return [ ['test1'], - ['test2'], + [str_repeat('a', 1)], + [str_repeat('a', 32)], ]; } @@ -77,7 +79,8 @@ class ActionTest extends \Test\TestCase { public function dataSetParsedLabel() { return [ ['test1'], - ['test2'], + [str_repeat('a', 1)], + [str_repeat('a', 32)], ]; } @@ -117,8 +120,8 @@ class ActionTest extends \Test\TestCase { return [ ['test1', 'GET'], ['test2', 'POST'], - ['test3', 'PUT'], - ['test4', 'DELETE'], + [str_repeat('a', 1), 'PUT'], + [str_repeat('a', 256), 'DELETE'], ]; } @@ -171,7 +174,8 @@ class ActionTest extends \Test\TestCase { public function dataSetIcon() { return [ ['test1'], - ['test2'], + [str_repeat('a', 1)], + [str_repeat('a', 64)], ]; } diff --git a/tests/lib/notification/notificationtest.php b/tests/lib/notification/notificationtest.php index 8f1779dd968..5865d2dbee1 100644 --- a/tests/lib/notification/notificationtest.php +++ b/tests/lib/notification/notificationtest.php @@ -22,12 +22,11 @@ namespace Test\Notification; -use OC\Notification\Action; use OC\Notification\Notification; -use OCP\Notification\IAction; use OCP\Notification\INotification; +use Test\TestCase; -class NotificationTest extends \Test\TestCase { +class NotificationTest extends TestCase { /** @var INotification */ protected $notification; From 190d2c3d5bd8b2bbd39f9112c5b977d27ee70664 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Thu, 3 Sep 2015 15:24:33 +0200 Subject: [PATCH 17/19] Add tests for the notification manager --- lib/private/notification/manager.php | 17 +- tests/lib/notification/managertest.php | 345 +++++++++++++++++++++++++ 2 files changed, 360 insertions(+), 2 deletions(-) create mode 100644 tests/lib/notification/managertest.php diff --git a/lib/private/notification/manager.php b/lib/private/notification/manager.php index 933c6199bc5..bafb123f768 100644 --- a/lib/private/notification/manager.php +++ b/lib/private/notification/manager.php @@ -40,6 +40,13 @@ class Manager implements IManager { /** @var \Closure */ protected $notifiersClosures; + public function __construct() { + $this->apps = []; + $this->notifiers = []; + $this->appsClosures = []; + $this->notifiersClosures = []; + } + /** * @param \Closure $service The service must implement IApp, otherwise a * \InvalidArgumentException is thrown later @@ -70,6 +77,7 @@ class Manager implements IManager { return $this->apps; } + $this->apps = []; foreach ($this->appsClosures as $closure) { $app = $closure(); if (!($app instanceof IApp)) { @@ -89,6 +97,7 @@ class Manager implements IManager { return $this->notifiers; } + $this->notifiers = []; foreach ($this->notifiersClosures as $closure) { $notifier = $closure(); if (!($notifier instanceof INotifier)) { @@ -146,11 +155,15 @@ class Manager implements IManager { continue; } - if (!$notification->isValidParsed()) { + if (!($notification instanceof INotification) || !$notification->isValidParsed()) { throw new \InvalidArgumentException('The given notification has not been handled'); } } + if (!($notification instanceof INotification) || !$notification->isValidParsed()) { + throw new \InvalidArgumentException('The given notification has not been handled'); + } + return $notification; } @@ -175,7 +188,7 @@ class Manager implements IManager { $count = 0; foreach ($apps as $app) { - $count += $app->markProcessed($notification); + $count += $app->getCount($notification); } return $count; diff --git a/tests/lib/notification/managertest.php b/tests/lib/notification/managertest.php new file mode 100644 index 00000000000..13ac4b80b84 --- /dev/null +++ b/tests/lib/notification/managertest.php @@ -0,0 +1,345 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace Test\Notification; + +use OC\Notification\Manager; +use OCP\Notification\IManager; +use Test\TestCase; + +class ManagerTest extends TestCase { + /** @var IManager */ + protected $manager; + + public function setUp() { + parent::setUp(); + $this->manager = new Manager(); + } + + public function testRegisterApp() { + $app = $this->getMockBuilder('OCP\Notification\IApp') + ->disableOriginalConstructor() + ->getMock(); + + $closure = function() use ($app) { + return $app; + }; + + $this->assertEquals([], $this->invokePrivate($this->manager, 'getApps')); + + $this->manager->registerApp($closure); + + $this->assertEquals([$app], $this->invokePrivate($this->manager, 'getApps')); + $this->assertEquals([$app], $this->invokePrivate($this->manager, 'getApps')); + + $this->manager->registerApp($closure); + + $this->assertEquals([$app, $app], $this->invokePrivate($this->manager, 'getApps')); + } + + /** + * @expectedException \InvalidArgumentException + */ + public function testRegisterAppInvalid() { + $notifier = $this->getMockBuilder('OCP\Notification\INotifier') + ->disableOriginalConstructor() + ->getMock(); + + $closure = function() use ($notifier) { + return $notifier; + }; + + $this->manager->registerApp($closure); + + $this->invokePrivate($this->manager, 'getApps'); + } + + public function testRegisterNotifier() { + $notifier = $this->getMockBuilder('OCP\Notification\INotifier') + ->disableOriginalConstructor() + ->getMock(); + + $closure = function() use ($notifier) { + return $notifier; + }; + + $this->assertEquals([], $this->invokePrivate($this->manager, 'getNotifiers')); + + $this->manager->registerNotifier($closure); + + $this->assertEquals([$notifier], $this->invokePrivate($this->manager, 'getNotifiers')); + $this->assertEquals([$notifier], $this->invokePrivate($this->manager, 'getNotifiers')); + + $this->manager->registerNotifier($closure); + + $this->assertEquals([$notifier, $notifier], $this->invokePrivate($this->manager, 'getNotifiers')); + } + + /** + * @expectedException \InvalidArgumentException + */ + public function testRegisterNotifierInvalid() { + $app = $this->getMockBuilder('OCP\Notification\IApp') + ->disableOriginalConstructor() + ->getMock(); + + $closure = function() use ($app) { + return $app; + }; + + $this->manager->registerNotifier($closure); + + $this->invokePrivate($this->manager, 'getNotifiers'); + } + + public function testCreateNotification() { + $action = $this->manager->createNotification(); + $this->assertInstanceOf('OCP\Notification\INotification', $action); + } + + public function testNotify() { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OCP\Notification\INotification') + ->disableOriginalConstructor() + ->getMock(); + $notification->expects($this->once()) + ->method('isValid') + ->willReturn(true); + + /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app */ + $app = $this->getMockBuilder('OCP\Notification\IApp') + ->disableOriginalConstructor() + ->getMock(); + $app->expects($this->once()) + ->method('notify') + ->with($notification); + + /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app2 */ + $app2 = $this->getMockBuilder('OCP\Notification\IApp') + ->disableOriginalConstructor() + ->getMock(); + $app2->expects($this->once()) + ->method('notify') + ->with($notification); + + $this->manager->registerApp(function() use ($app) { + return $app; + }); + $this->manager->registerApp(function() use ($app2) { + return $app2; + }); + + $this->manager->notify($notification); + } + + /** + * @expectedException \InvalidArgumentException + */ + public function testNotifyInvalid() { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OCP\Notification\INotification') + ->disableOriginalConstructor() + ->getMock(); + $notification->expects($this->once()) + ->method('isValid') + ->willReturn(false); + + $this->manager->notify($notification); + } + + public function testPrepare() { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OCP\Notification\INotification') + ->disableOriginalConstructor() + ->getMock(); + $notification->expects($this->once()) + ->method('isValidParsed') + ->willReturn(true); + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification2 */ + $notification2 = $this->getMockBuilder('OCP\Notification\INotification') + ->disableOriginalConstructor() + ->getMock(); + $notification2->expects($this->exactly(2)) + ->method('isValidParsed') + ->willReturn(true); + + /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier */ + $notifier = $this->getMockBuilder('OCP\Notification\INotifier') + ->disableOriginalConstructor() + ->getMock(); + $notifier->expects($this->once()) + ->method('prepare') + ->with($notification, 'en') + ->willReturnArgument(0); + + /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier2 */ + $notifier2 = $this->getMockBuilder('OCP\Notification\INotifier') + ->disableOriginalConstructor() + ->getMock(); + $notifier2->expects($this->once()) + ->method('prepare') + ->with($notification, 'en') + ->willReturn($notification2); + + $this->manager->registerNotifier(function() use ($notifier) { + return $notifier; + }); + $this->manager->registerNotifier(function() use ($notifier2) { + return $notifier2; + }); + + $this->assertEquals($notification2, $this->manager->prepare($notification, 'en')); + } + + /** + * @expectedException \InvalidArgumentException + */ + public function testPrepareInvalid() { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OCP\Notification\INotification') + ->disableOriginalConstructor() + ->getMock(); + $notification->expects($this->once()) + ->method('isValidParsed') + ->willReturn(false); + + /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier */ + $notifier = $this->getMockBuilder('OCP\Notification\INotifier') + ->disableOriginalConstructor() + ->getMock(); + $notifier->expects($this->once()) + ->method('prepare') + ->with($notification, 'de') + ->willReturnArgument(0); + + $this->manager->registerNotifier(function() use ($notifier) { + return $notifier; + }); + + $this->manager->prepare($notification, 'de'); + } + + public function testPrepareNotifierThrows() { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OCP\Notification\INotification') + ->disableOriginalConstructor() + ->getMock(); + $notification->expects($this->once()) + ->method('isValidParsed') + ->willReturn(true); + + /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier */ + $notifier = $this->getMockBuilder('OCP\Notification\INotifier') + ->disableOriginalConstructor() + ->getMock(); + $notifier->expects($this->once()) + ->method('prepare') + ->with($notification, 'de') + ->willThrowException(new \InvalidArgumentException); + + $this->manager->registerNotifier(function() use ($notifier) { + return $notifier; + }); + + $this->assertEquals($notification, $this->manager->prepare($notification, 'de')); + } + + /** + * @expectedException \InvalidArgumentException + */ + public function testPrepareNoNotifier() { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OCP\Notification\INotification') + ->disableOriginalConstructor() + ->getMock(); + $notification->expects($this->once()) + ->method('isValidParsed') + ->willReturn(false); + + $this->manager->prepare($notification, 'en'); + } + + public function testMarkProcessed() { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OCP\Notification\INotification') + ->disableOriginalConstructor() + ->getMock(); + + /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app */ + $app = $this->getMockBuilder('OCP\Notification\IApp') + ->disableOriginalConstructor() + ->getMock(); + $app->expects($this->once()) + ->method('markProcessed') + ->with($notification); + + /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app2 */ + $app2 = $this->getMockBuilder('OCP\Notification\IApp') + ->disableOriginalConstructor() + ->getMock(); + $app2->expects($this->once()) + ->method('markProcessed') + ->with($notification); + + $this->manager->registerApp(function() use ($app) { + return $app; + }); + $this->manager->registerApp(function() use ($app2) { + return $app2; + }); + + $this->manager->markProcessed($notification); + } + + public function testGetCount() { + /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OCP\Notification\INotification') + ->disableOriginalConstructor() + ->getMock(); + + /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app */ + $app = $this->getMockBuilder('OCP\Notification\IApp') + ->disableOriginalConstructor() + ->getMock(); + $app->expects($this->once()) + ->method('getCount') + ->with($notification) + ->willReturn(21); + + /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app2 */ + $app2 = $this->getMockBuilder('OCP\Notification\IApp') + ->disableOriginalConstructor() + ->getMock(); + $app2->expects($this->once()) + ->method('getCount') + ->with($notification) + ->willReturn(42); + + $this->manager->registerApp(function() use ($app) { + return $app; + }); + $this->manager->registerApp(function() use ($app2) { + return $app2; + }); + + $this->assertSame(63, $this->manager->getCount($notification)); + } +} From 59f37a8dfbc27242bb0ad50731f8ae20b1ad938c Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Thu, 3 Sep 2015 15:26:17 +0200 Subject: [PATCH 18/19] Add tests for the query() --- tests/lib/server.php | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/lib/server.php b/tests/lib/server.php index e73fc8b3ab1..78d6a0c8302 100644 --- a/tests/lib/server.php +++ b/tests/lib/server.php @@ -104,6 +104,8 @@ class Server extends \Test\TestCase { ['NavigationManager', '\OC\NavigationManager'], ['NavigationManager', '\OCP\INavigationManager'], + ['NotificationManager', '\OC\Notification\Manager'], + ['NotificationManager', '\OCP\Notification\IManager'], ['UserCache', '\OC\Cache\File'], ['UserCache', '\OCP\ICache'], From 38001d824b142ca9c47f2afafce91ab8b76f1a9a Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 8 Sep 2015 08:57:29 +0200 Subject: [PATCH 19/19] Move interfaces to private until they are no longer experimental --- apps/files_sharing/api/remote.php | 1 - apps/files_sharing/lib/external/manager.php | 2 +- apps/files_sharing/lib/notifier.php | 4 +- lib/private/notification/action.php | 1 - .../notification/iaction.php | 4 +- lib/{public => private}/notification/iapp.php | 4 +- .../notification/imanager.php | 4 +- .../notification/inotification.php | 4 +- .../notification/inotifier.php | 4 +- lib/private/notification/manager.php | 5 -- lib/private/notification/notification.php | 2 - lib/private/server.php | 2 +- lib/public/iservercontainer.php | 2 +- tests/lib/notification/actiontest.php | 2 +- tests/lib/notification/managertest.php | 88 +++++++++---------- tests/lib/notification/notificationtest.php | 26 +++--- tests/lib/server.php | 2 +- 17 files changed, 74 insertions(+), 83 deletions(-) rename lib/{public => private}/notification/iaction.php (97%) rename lib/{public => private}/notification/iapp.php (96%) rename lib/{public => private}/notification/imanager.php (96%) rename lib/{public => private}/notification/inotification.php (98%) rename lib/{public => private}/notification/inotifier.php (95%) diff --git a/apps/files_sharing/api/remote.php b/apps/files_sharing/api/remote.php index 404787c3895..0f6d2dc265a 100644 --- a/apps/files_sharing/api/remote.php +++ b/apps/files_sharing/api/remote.php @@ -23,7 +23,6 @@ namespace OCA\Files_Sharing\API; use OC\Files\Filesystem; use OCA\Files_Sharing\External\Manager; -use OCP\Notification\IManager; class Remote { diff --git a/apps/files_sharing/lib/external/manager.php b/apps/files_sharing/lib/external/manager.php index 18b9c724dea..17142e95099 100644 --- a/apps/files_sharing/lib/external/manager.php +++ b/apps/files_sharing/lib/external/manager.php @@ -28,7 +28,7 @@ namespace OCA\Files_Sharing\External; use OC\Files\Filesystem; use OCP\Files; -use OCP\Notification\IManager; +use OC\Notification\IManager; class Manager { const STORAGE = '\OCA\Files_Sharing\External\Storage'; diff --git a/apps/files_sharing/lib/notifier.php b/apps/files_sharing/lib/notifier.php index e050d4d3c1a..cc2deb3f439 100644 --- a/apps/files_sharing/lib/notifier.php +++ b/apps/files_sharing/lib/notifier.php @@ -22,8 +22,8 @@ namespace OCA\Files_Sharing; -use OCP\Notification\INotification; -use OCP\Notification\INotifier; +use OC\Notification\INotification; +use OC\Notification\INotifier; class Notifier implements INotifier { /** @var \OCP\L10N\IFactory */ diff --git a/lib/private/notification/action.php b/lib/private/notification/action.php index 7f654bf9082..6de8a1a4bbc 100644 --- a/lib/private/notification/action.php +++ b/lib/private/notification/action.php @@ -21,7 +21,6 @@ namespace OC\Notification; -use OCP\Notification\IAction; class Action implements IAction { diff --git a/lib/public/notification/iaction.php b/lib/private/notification/iaction.php similarity index 97% rename from lib/public/notification/iaction.php rename to lib/private/notification/iaction.php index 8db1eaa6543..da6728f5c52 100644 --- a/lib/public/notification/iaction.php +++ b/lib/private/notification/iaction.php @@ -19,12 +19,12 @@ * */ -namespace OCP\Notification; +namespace OC\Notification; /** * Interface IAction * - * @package OCP\Notification + * @package OC\Notification * @since 8.2.0 * * DEVELOPER NOTE: diff --git a/lib/public/notification/iapp.php b/lib/private/notification/iapp.php similarity index 96% rename from lib/public/notification/iapp.php rename to lib/private/notification/iapp.php index a4718a21b60..eda66423f3a 100644 --- a/lib/public/notification/iapp.php +++ b/lib/private/notification/iapp.php @@ -19,12 +19,12 @@ * */ -namespace OCP\Notification; +namespace OC\Notification; /** * Interface IApp * - * @package OCP\Notification + * @package OC\Notification * @since 8.2.0 * * DEVELOPER NOTE: diff --git a/lib/public/notification/imanager.php b/lib/private/notification/imanager.php similarity index 96% rename from lib/public/notification/imanager.php rename to lib/private/notification/imanager.php index ca1cc968b12..0cd92b33251 100644 --- a/lib/public/notification/imanager.php +++ b/lib/private/notification/imanager.php @@ -19,12 +19,12 @@ * */ -namespace OCP\Notification; +namespace OC\Notification; /** * Interface IManager * - * @package OCP\Notification + * @package OC\Notification * @since 8.2.0 * * DEVELOPER NOTE: diff --git a/lib/public/notification/inotification.php b/lib/private/notification/inotification.php similarity index 98% rename from lib/public/notification/inotification.php rename to lib/private/notification/inotification.php index 51d4a804647..faf5db1d24c 100644 --- a/lib/public/notification/inotification.php +++ b/lib/private/notification/inotification.php @@ -19,12 +19,12 @@ * */ -namespace OCP\Notification; +namespace OC\Notification; /** * Interface INotification * - * @package OCP\Notification + * @package OC\Notification * @since 8.2.0 * * DEVELOPER NOTE: diff --git a/lib/public/notification/inotifier.php b/lib/private/notification/inotifier.php similarity index 95% rename from lib/public/notification/inotifier.php rename to lib/private/notification/inotifier.php index 9eefcddae18..22531229e3f 100644 --- a/lib/public/notification/inotifier.php +++ b/lib/private/notification/inotifier.php @@ -19,12 +19,12 @@ * */ -namespace OCP\Notification; +namespace OC\Notification; /** * Interface INotifier * - * @package OCP\Notification + * @package OC\Notification * @since 8.2.0 * * DEVELOPER NOTE: diff --git a/lib/private/notification/manager.php b/lib/private/notification/manager.php index bafb123f768..9635925e38e 100644 --- a/lib/private/notification/manager.php +++ b/lib/private/notification/manager.php @@ -22,11 +22,6 @@ namespace OC\Notification; -use OCP\Notification\IApp; -use OCP\Notification\IManager; -use OCP\Notification\INotification; -use OCP\Notification\INotifier; - class Manager implements IManager { /** @var IApp */ protected $apps; diff --git a/lib/private/notification/notification.php b/lib/private/notification/notification.php index 2f53a347283..40fe39a956e 100644 --- a/lib/private/notification/notification.php +++ b/lib/private/notification/notification.php @@ -21,8 +21,6 @@ namespace OC\Notification; -use OCP\Notification\IAction; -use OCP\Notification\INotification; class Notification implements INotification { /** @var string */ diff --git a/lib/private/server.php b/lib/private/server.php index 880ab274f12..8e8444c83d4 100644 --- a/lib/private/server.php +++ b/lib/private/server.php @@ -1050,7 +1050,7 @@ class Server extends SimpleContainer implements IServerContainer { /** * Get the Notification Manager * - * @return \OCP\Notification\IManager + * @return \OC\Notification\IManager * @since 8.2.0 */ public function getNotificationManager() { diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php index ea08b5a78ca..8be23dff214 100644 --- a/lib/public/iservercontainer.php +++ b/lib/public/iservercontainer.php @@ -459,7 +459,7 @@ interface IServerContainer { /** * Get the Notification Manager * - * @return \OCP\Notification\IManager + * @return \OC\Notification\IManager * @since 8.2.0 */ public function getNotificationManager(); diff --git a/tests/lib/notification/actiontest.php b/tests/lib/notification/actiontest.php index 994e22a2f14..e319c250cc7 100644 --- a/tests/lib/notification/actiontest.php +++ b/tests/lib/notification/actiontest.php @@ -23,7 +23,7 @@ namespace Test\Notification; use OC\Notification\Action; -use OCP\Notification\IAction; +use OC\Notification\IAction; use Test\TestCase; class ActionTest extends TestCase { diff --git a/tests/lib/notification/managertest.php b/tests/lib/notification/managertest.php index 13ac4b80b84..fa2a0586f90 100644 --- a/tests/lib/notification/managertest.php +++ b/tests/lib/notification/managertest.php @@ -22,7 +22,7 @@ namespace Test\Notification; use OC\Notification\Manager; -use OCP\Notification\IManager; +use OC\Notification\IManager; use Test\TestCase; class ManagerTest extends TestCase { @@ -35,7 +35,7 @@ class ManagerTest extends TestCase { } public function testRegisterApp() { - $app = $this->getMockBuilder('OCP\Notification\IApp') + $app = $this->getMockBuilder('OC\Notification\IApp') ->disableOriginalConstructor() ->getMock(); @@ -59,7 +59,7 @@ class ManagerTest extends TestCase { * @expectedException \InvalidArgumentException */ public function testRegisterAppInvalid() { - $notifier = $this->getMockBuilder('OCP\Notification\INotifier') + $notifier = $this->getMockBuilder('OC\Notification\INotifier') ->disableOriginalConstructor() ->getMock(); @@ -73,7 +73,7 @@ class ManagerTest extends TestCase { } public function testRegisterNotifier() { - $notifier = $this->getMockBuilder('OCP\Notification\INotifier') + $notifier = $this->getMockBuilder('OC\Notification\INotifier') ->disableOriginalConstructor() ->getMock(); @@ -97,7 +97,7 @@ class ManagerTest extends TestCase { * @expectedException \InvalidArgumentException */ public function testRegisterNotifierInvalid() { - $app = $this->getMockBuilder('OCP\Notification\IApp') + $app = $this->getMockBuilder('OC\Notification\IApp') ->disableOriginalConstructor() ->getMock(); @@ -112,28 +112,28 @@ class ManagerTest extends TestCase { public function testCreateNotification() { $action = $this->manager->createNotification(); - $this->assertInstanceOf('OCP\Notification\INotification', $action); + $this->assertInstanceOf('OC\Notification\INotification', $action); } public function testNotify() { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ - $notification = $this->getMockBuilder('OCP\Notification\INotification') + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OC\Notification\INotification') ->disableOriginalConstructor() ->getMock(); $notification->expects($this->once()) ->method('isValid') ->willReturn(true); - /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app */ - $app = $this->getMockBuilder('OCP\Notification\IApp') + /** @var \OC\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app */ + $app = $this->getMockBuilder('OC\Notification\IApp') ->disableOriginalConstructor() ->getMock(); $app->expects($this->once()) ->method('notify') ->with($notification); - /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app2 */ - $app2 = $this->getMockBuilder('OCP\Notification\IApp') + /** @var \OC\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app2 */ + $app2 = $this->getMockBuilder('OC\Notification\IApp') ->disableOriginalConstructor() ->getMock(); $app2->expects($this->once()) @@ -154,8 +154,8 @@ class ManagerTest extends TestCase { * @expectedException \InvalidArgumentException */ public function testNotifyInvalid() { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ - $notification = $this->getMockBuilder('OCP\Notification\INotification') + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OC\Notification\INotification') ->disableOriginalConstructor() ->getMock(); $notification->expects($this->once()) @@ -166,23 +166,23 @@ class ManagerTest extends TestCase { } public function testPrepare() { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ - $notification = $this->getMockBuilder('OCP\Notification\INotification') + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OC\Notification\INotification') ->disableOriginalConstructor() ->getMock(); $notification->expects($this->once()) ->method('isValidParsed') ->willReturn(true); - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification2 */ - $notification2 = $this->getMockBuilder('OCP\Notification\INotification') + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification2 */ + $notification2 = $this->getMockBuilder('OC\Notification\INotification') ->disableOriginalConstructor() ->getMock(); $notification2->expects($this->exactly(2)) ->method('isValidParsed') ->willReturn(true); - /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier */ - $notifier = $this->getMockBuilder('OCP\Notification\INotifier') + /** @var \OC\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier */ + $notifier = $this->getMockBuilder('OC\Notification\INotifier') ->disableOriginalConstructor() ->getMock(); $notifier->expects($this->once()) @@ -190,8 +190,8 @@ class ManagerTest extends TestCase { ->with($notification, 'en') ->willReturnArgument(0); - /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier2 */ - $notifier2 = $this->getMockBuilder('OCP\Notification\INotifier') + /** @var \OC\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier2 */ + $notifier2 = $this->getMockBuilder('OC\Notification\INotifier') ->disableOriginalConstructor() ->getMock(); $notifier2->expects($this->once()) @@ -213,16 +213,16 @@ class ManagerTest extends TestCase { * @expectedException \InvalidArgumentException */ public function testPrepareInvalid() { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ - $notification = $this->getMockBuilder('OCP\Notification\INotification') + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OC\Notification\INotification') ->disableOriginalConstructor() ->getMock(); $notification->expects($this->once()) ->method('isValidParsed') ->willReturn(false); - /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier */ - $notifier = $this->getMockBuilder('OCP\Notification\INotifier') + /** @var \OC\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier */ + $notifier = $this->getMockBuilder('OC\Notification\INotifier') ->disableOriginalConstructor() ->getMock(); $notifier->expects($this->once()) @@ -238,16 +238,16 @@ class ManagerTest extends TestCase { } public function testPrepareNotifierThrows() { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ - $notification = $this->getMockBuilder('OCP\Notification\INotification') + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OC\Notification\INotification') ->disableOriginalConstructor() ->getMock(); $notification->expects($this->once()) ->method('isValidParsed') ->willReturn(true); - /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier */ - $notifier = $this->getMockBuilder('OCP\Notification\INotifier') + /** @var \OC\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $notifier */ + $notifier = $this->getMockBuilder('OC\Notification\INotifier') ->disableOriginalConstructor() ->getMock(); $notifier->expects($this->once()) @@ -266,8 +266,8 @@ class ManagerTest extends TestCase { * @expectedException \InvalidArgumentException */ public function testPrepareNoNotifier() { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ - $notification = $this->getMockBuilder('OCP\Notification\INotification') + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OC\Notification\INotification') ->disableOriginalConstructor() ->getMock(); $notification->expects($this->once()) @@ -278,21 +278,21 @@ class ManagerTest extends TestCase { } public function testMarkProcessed() { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ - $notification = $this->getMockBuilder('OCP\Notification\INotification') + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OC\Notification\INotification') ->disableOriginalConstructor() ->getMock(); - /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app */ - $app = $this->getMockBuilder('OCP\Notification\IApp') + /** @var \OC\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app */ + $app = $this->getMockBuilder('OC\Notification\IApp') ->disableOriginalConstructor() ->getMock(); $app->expects($this->once()) ->method('markProcessed') ->with($notification); - /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app2 */ - $app2 = $this->getMockBuilder('OCP\Notification\IApp') + /** @var \OC\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app2 */ + $app2 = $this->getMockBuilder('OC\Notification\IApp') ->disableOriginalConstructor() ->getMock(); $app2->expects($this->once()) @@ -310,13 +310,13 @@ class ManagerTest extends TestCase { } public function testGetCount() { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ - $notification = $this->getMockBuilder('OCP\Notification\INotification') + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + $notification = $this->getMockBuilder('OC\Notification\INotification') ->disableOriginalConstructor() ->getMock(); - /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app */ - $app = $this->getMockBuilder('OCP\Notification\IApp') + /** @var \OC\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app */ + $app = $this->getMockBuilder('OC\Notification\IApp') ->disableOriginalConstructor() ->getMock(); $app->expects($this->once()) @@ -324,8 +324,8 @@ class ManagerTest extends TestCase { ->with($notification) ->willReturn(21); - /** @var \OCP\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app2 */ - $app2 = $this->getMockBuilder('OCP\Notification\IApp') + /** @var \OC\Notification\IApp|\PHPUnit_Framework_MockObject_MockObject $app2 */ + $app2 = $this->getMockBuilder('OC\Notification\IApp') ->disableOriginalConstructor() ->getMock(); $app2->expects($this->once()) diff --git a/tests/lib/notification/notificationtest.php b/tests/lib/notification/notificationtest.php index 5865d2dbee1..a790a53eaa7 100644 --- a/tests/lib/notification/notificationtest.php +++ b/tests/lib/notification/notificationtest.php @@ -23,7 +23,7 @@ namespace Test\Notification; use OC\Notification\Notification; -use OCP\Notification\INotification; +use OC\Notification\INotification; use Test\TestCase; class NotificationTest extends TestCase { @@ -401,12 +401,12 @@ class NotificationTest extends TestCase { public function testCreateAction() { $action = $this->notification->createAction(); - $this->assertInstanceOf('OCP\Notification\IAction', $action); + $this->assertInstanceOf('OC\Notification\IAction', $action); } public function testAddAction() { - /** @var \OCP\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ - $action = $this->getMockBuilder('OCP\Notification\IAction') + /** @var \OC\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ + $action = $this->getMockBuilder('OC\Notification\IAction') ->disableOriginalConstructor() ->getMock(); $action->expects($this->once()) @@ -425,8 +425,8 @@ class NotificationTest extends TestCase { * @expectedException \InvalidArgumentException */ public function testAddActionInvalid() { - /** @var \OCP\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ - $action = $this->getMockBuilder('OCP\Notification\IAction') + /** @var \OC\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ + $action = $this->getMockBuilder('OC\Notification\IAction') ->disableOriginalConstructor() ->getMock(); $action->expects($this->once()) @@ -439,8 +439,8 @@ class NotificationTest extends TestCase { } public function testAddParsedAction() { - /** @var \OCP\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ - $action = $this->getMockBuilder('OCP\Notification\IAction') + /** @var \OC\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ + $action = $this->getMockBuilder('OC\Notification\IAction') ->disableOriginalConstructor() ->getMock(); $action->expects($this->once()) @@ -459,8 +459,8 @@ class NotificationTest extends TestCase { * @expectedException \InvalidArgumentException */ public function testAddParsedActionInvalid() { - /** @var \OCP\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ - $action = $this->getMockBuilder('OCP\Notification\IAction') + /** @var \OC\Notification\IAction|\PHPUnit_Framework_MockObject_MockObject $action */ + $action = $this->getMockBuilder('OC\Notification\IAction') ->disableOriginalConstructor() ->getMock(); $action->expects($this->once()) @@ -489,7 +489,7 @@ class NotificationTest extends TestCase { * @param bool $expected */ public function testIsValid($isValidCommon, $subject, $expected) { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ $notification = $this->getMockBuilder('\OC\Notification\Notification') ->setMethods([ 'isValidCommon', @@ -520,7 +520,7 @@ class NotificationTest extends TestCase { * @param bool $expected */ public function testIsParsedValid($isValidCommon, $subject, $expected) { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ $notification = $this->getMockBuilder('\OC\Notification\Notification') ->setMethods([ 'isValidCommon', @@ -565,7 +565,7 @@ class NotificationTest extends TestCase { * @param bool $expected */ public function testIsValidCommon($app, $user, $timestamp, $objectType, $objectId, $expected) { - /** @var \OCP\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ + /** @var \OC\Notification\INotification|\PHPUnit_Framework_MockObject_MockObject $notification */ $notification = $this->getMockBuilder('\OC\Notification\Notification') ->setMethods([ 'getApp', diff --git a/tests/lib/server.php b/tests/lib/server.php index 78d6a0c8302..96a476bd4d1 100644 --- a/tests/lib/server.php +++ b/tests/lib/server.php @@ -105,7 +105,7 @@ class Server extends \Test\TestCase { ['NavigationManager', '\OC\NavigationManager'], ['NavigationManager', '\OCP\INavigationManager'], ['NotificationManager', '\OC\Notification\Manager'], - ['NotificationManager', '\OCP\Notification\IManager'], + ['NotificationManager', '\OC\Notification\IManager'], ['UserCache', '\OC\Cache\File'], ['UserCache', '\OCP\ICache'],