From fb5ae20722a29890535296c8871a2edf4201289d Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Mon, 15 Jun 2020 15:01:52 +0200 Subject: [PATCH 1/4] basic settings system for activity notifications Signed-off-by: Robin Appelman --- .../Activity/ActivitySettingsAdapter.php | 57 +++++++++++++ lib/private/Activity/Event.php | 11 +++ lib/private/Activity/Manager.php | 11 ++- lib/private/AppFramework/App.php | 14 ++++ lib/public/Activity/ActivitySettings.php | 79 +++++++++++++++++++ lib/public/Activity/IEvent.php | 19 +++++ lib/public/Activity/IExtension.php | 1 + lib/public/Activity/IManager.php | 6 +- 8 files changed, 191 insertions(+), 7 deletions(-) create mode 100644 lib/private/Activity/ActivitySettingsAdapter.php create mode 100644 lib/public/Activity/ActivitySettings.php diff --git a/lib/private/Activity/ActivitySettingsAdapter.php b/lib/private/Activity/ActivitySettingsAdapter.php new file mode 100644 index 0000000000..f5544debd7 --- /dev/null +++ b/lib/private/Activity/ActivitySettingsAdapter.php @@ -0,0 +1,57 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OC\Activity; + +use OCP\Activity\ActivitySettings; +use OCP\Activity\ISetting; + +/** + * Adapt the old interface based settings into the new abstract + * class based one + */ +class ActivitySettingsAdapter extends ActivitySettings { + private $oldSettings; + + public function __construct(ISetting $oldSettings) { + $this->oldSettings = $oldSettings; + } + + public function getIdentifier() { + return $this->oldSettings->getIdentifier(); + } + + public function getName() { + return $this->oldSettings->getName(); + } + + public function getPriority() { + return $this->oldSettings->getPriority(); + } + + public function canChangeMail() { + return $this->oldSettings->canChangeMail(); + } + + public function isDefaultEnabledMail() { + return $this->oldSettings->isDefaultEnabledMail(); + } +} diff --git a/lib/private/Activity/Event.php b/lib/private/Activity/Event.php index 4958cdfd46..5f82b37c91 100644 --- a/lib/private/Activity/Event.php +++ b/lib/private/Activity/Event.php @@ -74,6 +74,8 @@ class Event implements IEvent { protected $link = ''; /** @var string */ protected $icon = ''; + /** @var bool */ + protected $generateNotification = true; /** @var IEvent|null */ protected $child; @@ -532,4 +534,13 @@ class Event implements IEvent { */ ; } + + public function setGenerateNotification(bool $generate): IEvent { + $this->generateNotification = $generate; + return $this; + } + + public function getGenerateNotification(): bool { + return $this->generateNotification; + } } diff --git a/lib/private/Activity/Manager.php b/lib/private/Activity/Manager.php index ffe6c335b2..6c40f752bc 100644 --- a/lib/private/Activity/Manager.php +++ b/lib/private/Activity/Manager.php @@ -28,6 +28,7 @@ namespace OC\Activity; +use OCP\Activity\ActivitySettings; use OCP\Activity\IConsumer; use OCP\Activity\IEvent; use OCP\Activity\IFilter; @@ -262,7 +263,7 @@ class Manager implements IManager { } /** - * @return ISetting[] + * @return ActivitySettings[] * @throws \InvalidArgumentException */ public function getSettings(): array { @@ -270,7 +271,9 @@ class Manager implements IManager { /** @var ISetting $setting */ $setting = \OC::$server->query($class); - if (!$setting instanceof ISetting) { + if ($setting instanceof ISetting) { + $setting = new ActivitySettingsAdapter($setting); + } else if (!$setting instanceof ActivitySettings) { throw new \InvalidArgumentException('Invalid activity filter registered'); } @@ -283,11 +286,11 @@ class Manager implements IManager { /** * @param string $id - * @return ISetting + * @return ActivitySettings * @throws \InvalidArgumentException when the setting was not found * @since 11.0.0 */ - public function getSettingById(string $id): ISetting { + public function getSettingById(string $id): ActivitySettings { $settings = $this->getSettings(); if (isset($settings[$id])) { diff --git a/lib/private/AppFramework/App.php b/lib/private/AppFramework/App.php index ea97ea4096..75876055d8 100644 --- a/lib/private/AppFramework/App.php +++ b/lib/private/AppFramework/App.php @@ -87,6 +87,20 @@ class App { return $topNamespace . self::$nameSpaceCache[$appId]; } + public static function getAppIdForClass(string $className, string $topNamespace='OCA\\'): ?string { + if (strpos($className, $topNamespace) !== 0) { + return null; + } + + foreach (self::$nameSpaceCache as $appId => $namespace) { + if (strpos($className, $topNamespace . $namespace . '\\') === 0) { + return $appId; + } + } + + return null; + } + /** * Shortcut for calling a controller method and printing the result diff --git a/lib/public/Activity/ActivitySettings.php b/lib/public/Activity/ActivitySettings.php new file mode 100644 index 0000000000..c25e8d2c9f --- /dev/null +++ b/lib/public/Activity/ActivitySettings.php @@ -0,0 +1,79 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Activity; + +/** + * @since 20.0.0 + */ +abstract class ActivitySettings { + /** + * @return string Lowercase a-z and underscore only identifier + * @since 20.0.0 + */ + abstract public function getIdentifier(); + + /** + * @return string A translated string + * @since 20.0.0 + */ + abstract public function getName(); + + /** + * @return int whether the filter should be rather on the top or bottom of + * the admin section. The filters are arranged in ascending order of the + * priority values. It is required to return a value between 0 and 100. + * @since 20.0.0 + */ + abstract public function getPriority(); + + /** + * @return bool True when the option can be changed for the mail + * @since 20.0.0 + */ + public function canChangeMail() { + return true; + } + + /** + * @return bool True when the option can be changed for the notification + * @since 20.0.0 + */ + public function canChangeNotification() { + return true; + } + + /** + * @return bool Whether or not an activity email should be send by default + * @since 20.0.0 + */ + public function isDefaultEnabledMail() { + return false; + } + + /** + * @return bool Whether or not an activity notification should be send by default + * @since 20.0.0 + */ + public function isDefaultEnabledNotification() { + return $this->isDefaultEnabledMail(); + } +} diff --git a/lib/public/Activity/IEvent.php b/lib/public/Activity/IEvent.php index 6c3c7dd512..48fa6bc365 100644 --- a/lib/public/Activity/IEvent.php +++ b/lib/public/Activity/IEvent.php @@ -364,4 +364,23 @@ interface IEvent { * @since 11.0.0 */ public function isValidParsed(): bool; + + /** + * Set whether or not a notification should be automatically generated for this activity. + * + * Set this to `false` if the app already generates a notification for the event. + * + * @param bool $generate + * @return IEvent + * @since 20.0.0 + */ + public function setGenerateNotification(bool $generate): self; + + /** + * whether or not a notification should be automatically generated for this activity. + * + * @return bool + * @since 20.0.0 + */ + public function getGenerateNotification(): bool; } diff --git a/lib/public/Activity/IExtension.php b/lib/public/Activity/IExtension.php index 65d2eaa2c9..5762e41214 100644 --- a/lib/public/Activity/IExtension.php +++ b/lib/public/Activity/IExtension.php @@ -34,6 +34,7 @@ namespace OCP\Activity; interface IExtension { public const METHOD_STREAM = 'stream'; public const METHOD_MAIL = 'email'; + public const METHOD_NOTIFICATION = 'notification'; public const PRIORITY_VERYLOW = 10; public const PRIORITY_LOW = 20; diff --git a/lib/public/Activity/IManager.php b/lib/public/Activity/IManager.php index 9c1289b271..3717bb8235 100644 --- a/lib/public/Activity/IManager.php +++ b/lib/public/Activity/IManager.php @@ -103,7 +103,7 @@ interface IManager { public function registerSetting(string $setting): void; /** - * @return ISetting[] + * @return ActivitySettings[] * @since 11.0.0 */ public function getSettings(): array; @@ -122,11 +122,11 @@ interface IManager { /** * @param string $id - * @return ISetting + * @return ActivitySettings * @throws \InvalidArgumentException when the setting was not found * @since 11.0.0 */ - public function getSettingById(string $id): ISetting; + public function getSettingById(string $id): ActivitySettings; /** * @param string $type From aa051875f9588306c9636e3622518fab3e942f5e Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Tue, 21 Jul 2020 17:40:22 +0200 Subject: [PATCH 2/4] improve default notification fallback Signed-off-by: Robin Appelman --- lib/public/Activity/ActivitySettings.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/public/Activity/ActivitySettings.php b/lib/public/Activity/ActivitySettings.php index c25e8d2c9f..4c96b83199 100644 --- a/lib/public/Activity/ActivitySettings.php +++ b/lib/public/Activity/ActivitySettings.php @@ -74,6 +74,6 @@ abstract class ActivitySettings { * @since 20.0.0 */ public function isDefaultEnabledNotification() { - return $this->isDefaultEnabledMail(); + return $this->isDefaultEnabledMail() && !$this->canChangeMail(); } } From 5eb1e75e243917047cdb4b122a54fcd6a6d510af Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Tue, 21 Jul 2020 18:03:17 +0200 Subject: [PATCH 3/4] build autoloader Signed-off-by: Robin Appelman --- lib/composer/composer/autoload_classmap.php | 2 ++ lib/composer/composer/autoload_static.php | 2 ++ lib/private/Activity/ActivitySettingsAdapter.php | 4 +++- lib/private/Activity/Manager.php | 2 +- lib/public/Activity/ActivitySettings.php | 4 +++- 5 files changed, 11 insertions(+), 3 deletions(-) diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 94e35bf1b1..ab53e31291 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -11,6 +11,7 @@ return array( 'OCP\\Accounts\\IAccountManager' => $baseDir . '/lib/public/Accounts/IAccountManager.php', 'OCP\\Accounts\\IAccountProperty' => $baseDir . '/lib/public/Accounts/IAccountProperty.php', 'OCP\\Accounts\\PropertyDoesNotExistException' => $baseDir . '/lib/public/Accounts/PropertyDoesNotExistException.php', + 'OCP\\Activity\\ActivitySettings' => $baseDir . '/lib/public/Activity/ActivitySettings.php', 'OCP\\Activity\\IConsumer' => $baseDir . '/lib/public/Activity/IConsumer.php', 'OCP\\Activity\\IEvent' => $baseDir . '/lib/public/Activity/IEvent.php', 'OCP\\Activity\\IEventMerger' => $baseDir . '/lib/public/Activity/IEventMerger.php', @@ -546,6 +547,7 @@ return array( 'OC\\Accounts\\AccountManager' => $baseDir . '/lib/private/Accounts/AccountManager.php', 'OC\\Accounts\\AccountProperty' => $baseDir . '/lib/private/Accounts/AccountProperty.php', 'OC\\Accounts\\Hooks' => $baseDir . '/lib/private/Accounts/Hooks.php', + 'OC\\Activity\\ActivitySettingsAdapter' => $baseDir . '/lib/private/Activity/ActivitySettingsAdapter.php', 'OC\\Activity\\Event' => $baseDir . '/lib/private/Activity/Event.php', 'OC\\Activity\\EventMerger' => $baseDir . '/lib/private/Activity/EventMerger.php', 'OC\\Activity\\Manager' => $baseDir . '/lib/private/Activity/Manager.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index 1892c3bc96..4c33abf782 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -40,6 +40,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OCP\\Accounts\\IAccountManager' => __DIR__ . '/../../..' . '/lib/public/Accounts/IAccountManager.php', 'OCP\\Accounts\\IAccountProperty' => __DIR__ . '/../../..' . '/lib/public/Accounts/IAccountProperty.php', 'OCP\\Accounts\\PropertyDoesNotExistException' => __DIR__ . '/../../..' . '/lib/public/Accounts/PropertyDoesNotExistException.php', + 'OCP\\Activity\\ActivitySettings' => __DIR__ . '/../../..' . '/lib/public/Activity/ActivitySettings.php', 'OCP\\Activity\\IConsumer' => __DIR__ . '/../../..' . '/lib/public/Activity/IConsumer.php', 'OCP\\Activity\\IEvent' => __DIR__ . '/../../..' . '/lib/public/Activity/IEvent.php', 'OCP\\Activity\\IEventMerger' => __DIR__ . '/../../..' . '/lib/public/Activity/IEventMerger.php', @@ -575,6 +576,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OC\\Accounts\\AccountManager' => __DIR__ . '/../../..' . '/lib/private/Accounts/AccountManager.php', 'OC\\Accounts\\AccountProperty' => __DIR__ . '/../../..' . '/lib/private/Accounts/AccountProperty.php', 'OC\\Accounts\\Hooks' => __DIR__ . '/../../..' . '/lib/private/Accounts/Hooks.php', + 'OC\\Activity\\ActivitySettingsAdapter' => __DIR__ . '/../../..' . '/lib/private/Activity/ActivitySettingsAdapter.php', 'OC\\Activity\\Event' => __DIR__ . '/../../..' . '/lib/private/Activity/Event.php', 'OC\\Activity\\EventMerger' => __DIR__ . '/../../..' . '/lib/private/Activity/EventMerger.php', 'OC\\Activity\\Manager' => __DIR__ . '/../../..' . '/lib/private/Activity/Manager.php', diff --git a/lib/private/Activity/ActivitySettingsAdapter.php b/lib/private/Activity/ActivitySettingsAdapter.php index f5544debd7..c49231bee2 100644 --- a/lib/private/Activity/ActivitySettingsAdapter.php +++ b/lib/private/Activity/ActivitySettingsAdapter.php @@ -1,4 +1,6 @@ - * diff --git a/lib/private/Activity/Manager.php b/lib/private/Activity/Manager.php index 6c40f752bc..325f19bb7f 100644 --- a/lib/private/Activity/Manager.php +++ b/lib/private/Activity/Manager.php @@ -273,7 +273,7 @@ class Manager implements IManager { if ($setting instanceof ISetting) { $setting = new ActivitySettingsAdapter($setting); - } else if (!$setting instanceof ActivitySettings) { + } elseif (!$setting instanceof ActivitySettings) { throw new \InvalidArgumentException('Invalid activity filter registered'); } diff --git a/lib/public/Activity/ActivitySettings.php b/lib/public/Activity/ActivitySettings.php index 4c96b83199..ad2e091814 100644 --- a/lib/public/Activity/ActivitySettings.php +++ b/lib/public/Activity/ActivitySettings.php @@ -1,4 +1,6 @@ - * From c8427781b4524b3eb9bf792227f44587aceb703a Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Thu, 23 Jul 2020 16:39:27 +0200 Subject: [PATCH 4/4] implement old settings interface Signed-off-by: Robin Appelman --- lib/private/Activity/Manager.php | 8 +++++--- lib/public/Activity/ActivitySettings.php | 22 +++++++++++++++++++++- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/lib/private/Activity/Manager.php b/lib/private/Activity/Manager.php index 325f19bb7f..cbe2d8c3ee 100644 --- a/lib/private/Activity/Manager.php +++ b/lib/private/Activity/Manager.php @@ -271,9 +271,11 @@ class Manager implements IManager { /** @var ISetting $setting */ $setting = \OC::$server->query($class); - if ($setting instanceof ISetting) { - $setting = new ActivitySettingsAdapter($setting); - } elseif (!$setting instanceof ActivitySettings) { + if (!$setting instanceof ISetting) { + if (!$setting instanceof ActivitySettings) { + $setting = new ActivitySettingsAdapter($setting); + } + } else { throw new \InvalidArgumentException('Invalid activity filter registered'); } diff --git a/lib/public/Activity/ActivitySettings.php b/lib/public/Activity/ActivitySettings.php index ad2e091814..98b95061cd 100644 --- a/lib/public/Activity/ActivitySettings.php +++ b/lib/public/Activity/ActivitySettings.php @@ -26,7 +26,7 @@ namespace OCP\Activity; /** * @since 20.0.0 */ -abstract class ActivitySettings { +abstract class ActivitySettings implements ISetting { /** * @return string Lowercase a-z and underscore only identifier * @since 20.0.0 @@ -78,4 +78,24 @@ abstract class ActivitySettings { public function isDefaultEnabledNotification() { return $this->isDefaultEnabledMail() && !$this->canChangeMail(); } + + /** + * Left in for backwards compatibility + * + * @return bool + * @since 20.0.0 + */ + public function canChangeStream() { + return false; + } + + /** + * Left in for backwards compatibility + * + * @return bool + * @since 20.0.0 + */ + public function isDefaultEnabledStream() { + return true; + } }