basic settings system for activity notificationstags/v20.0.0beta1
@@ -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', | |||
@@ -547,6 +548,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', |
@@ -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', | |||
@@ -576,6 +577,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', |
@@ -0,0 +1,59 @@ | |||
<?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(); | |||
} | |||
} |
@@ -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; | |||
} | |||
} |
@@ -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 { | |||
@@ -271,6 +272,10 @@ class Manager implements IManager { | |||
$setting = \OC::$server->query($class); | |||
if (!$setting instanceof ISetting) { | |||
if (!$setting instanceof ActivitySettings) { | |||
$setting = new ActivitySettingsAdapter($setting); | |||
} | |||
} else { | |||
throw new \InvalidArgumentException('Invalid activity filter registered'); | |||
} | |||
@@ -283,11 +288,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])) { |
@@ -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 |
@@ -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; | |||
} | |||
} |
@@ -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; | |||
} |
@@ -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; |
@@ -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 |