basic settings system for activity notifications

Signed-off-by: Robin Appelman <robin@icewind.nl>

diff --git a/lib/private/Activity/ActivitySettingsAdapter.php b/lib/private/Activity/ActivitySettingsAdapter.php
new file mode 100644 (file)
index 0000000..f5544de
--- /dev/null
+++ b/lib/private/Activity/ActivitySettingsAdapter.php
@@ -0,0 +1,57 @@
+<?php declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2020 Robin Appelman <robin@icewind.nl>
+ *
+ * @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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+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 4958cdfd46e43c78dab9d2911fd2eb014fa7ba23..5f82b37c91a124e395ae792d6d499f0e33c1943b 100644 (file)
--- 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 ffe6c335b27abde0ad10c28a749e4c4149e73af6..6c40f752bc8ddae4efb5762a66e1b40c58ed4c37 100644 (file)
--- 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 ea97ea4096d9841fafc652841c6cd37b02cae6af..75876055d80a84157d535cf8782147c8f58b7d48 100644 (file)
--- 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 (file)
index 0000000..c25e8d2
--- /dev/null
+++ b/lib/public/Activity/ActivitySettings.php
@@ -0,0 +1,79 @@
+<?php declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2020 Robin Appelman <robin@icewind.nl>
+ *
+ * @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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+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 6c3c7dd51270e58fb85b13005b839ee0bc6521b8..48fa6bc3659aa24c66493661228e6bc2afb46458 100644 (file)
--- 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 65d2eaa2c9333bcc07aa69d5a1b4501f1614f997..5762e4121494e3b46ec326eb813b2738e0243f80 100644 (file)
--- 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 9c1289b27198180398ad8cb839318b1a5a46a0f8..3717bb8235ea9332d6b9a06bf198e742400f3853 100644 (file)
--- 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