Merge pull request #21542 from nextcloud/activity-notifications

basic settings system for activity notifications

4 files changed, 124 insertions, 3 deletions

diff --git a/lib/public/Activity/ActivitySettings.php b/lib/public/Activity/ActivitySettings.php
new file mode 100644
index 00000000000..98b95061cd7
--- /dev/null
+++ b/lib/public/Activity/ActivitySettings.php
@@ -0,0 +1,101 @@
+<?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 implements ISetting {
+	/**
+	 * @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() && !$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;
+	}
+}
diff --git a/lib/public/Activity/IEvent.php b/lib/public/Activity/IEvent.php
index 6c3c7dd5127..48fa6bc3659 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 65d2eaa2c93..5762e412149 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 9c1289b2719..3717bb8235e 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