From dfe677fabb63cf9d61e060d1bbf5bcb170eeb52a Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 1 Feb 2016 15:16:05 +0100 Subject: [PATCH] Add activities for admins when a tag is created/updated/deleted --- apps/systemtags/activity/extension.php | 273 +++++++++++++++++++++++++ apps/systemtags/activity/listener.php | 104 ++++++++++ apps/systemtags/appinfo/app.php | 25 +++ 3 files changed, 402 insertions(+) create mode 100644 apps/systemtags/activity/extension.php create mode 100644 apps/systemtags/activity/listener.php diff --git a/apps/systemtags/activity/extension.php b/apps/systemtags/activity/extension.php new file mode 100644 index 0000000000..b33b9046d3 --- /dev/null +++ b/apps/systemtags/activity/extension.php @@ -0,0 +1,273 @@ + + * + * @copyright Copyright (c) 2016, 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\SystemTags\Activity; + +use OCP\Activity\IExtension; +use OCP\Activity\IManager; +use OCP\IL10N; +use OCP\L10N\IFactory; + +/** + * Class Extension + * + * @package OCA\SystemTags\Activity + */ +class Extension implements IExtension { + const APP_NAME = 'systemtags'; + + const CREATE_TAG = 'create_tag'; + const UPDATE_TAG = 'update_tag'; + const DELETE_TAG = 'delete_tag'; + + /** @var IFactory */ + protected $languageFactory; + + /** @var IManager */ + protected $activityManager; + + /** + * @param IFactory $languageFactory + * @param IManager $activityManager + */ + public function __construct(IFactory $languageFactory, IManager $activityManager) { + $this->languageFactory = $languageFactory; + $this->activityManager = $activityManager; + } + + protected function getL10N($languageCode = null) { + return $this->languageFactory->get(self::APP_NAME, $languageCode); + } + + /** + * The extension can return an array of additional notification types. + * If no additional types are to be added false is to be returned + * + * @param string $languageCode + * @return array|false + */ + public function getNotificationTypes($languageCode) { + $l = $this->getL10N($languageCode); + + return array( + self::APP_NAME => (string) $l->t('System tags for a file have been modified'), + ); + } + + /** + * For a given method additional types to be displayed in the settings can be returned. + * In case no additional types are to be added false is to be returned. + * + * @param string $method + * @return array|false + */ + public function getDefaultTypes($method) { + return [self::APP_NAME]; + } + + /** + * A string naming the css class for the icon to be used can be returned. + * If no icon is known for the given type false is to be returned. + * + * @param string $type + * @return string|false + */ + public function getTypeIcon($type) { + switch ($type) { + case self::APP_NAME: + return false; + } + + return false; + } + + /** + * The extension can translate a given message to the requested languages. + * If no translation is available false is to be returned. + * + * @param string $app + * @param string $text + * @param array $params + * @param boolean $stripPath + * @param boolean $highlightParams + * @param string $languageCode + * @return string|false + */ + public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) { + if ($app !== self::APP_NAME) { + return false; + } + + $l = $this->getL10N($languageCode); + + /* + if ($this->activityManager->isFormattingFilteredObject()) { + $translation = $this->translateShort($text, $l, $params); + if ($translation !== false) { + return $translation; + } + } + */ + + return $this->translateLong($text, $l, $params); + } + + /** + * @param string $text + * @param IL10N $l + * @param array $params + * @return bool|string + */ + protected function translateLong($text, IL10N $l, array $params) { + + switch ($text) { + case self::CREATE_TAG: + $params[1] = $this->convertParameterToTag($params[1], $l); + return (string) $l->t('%1$s created system tag %2$s', $params); + case self::DELETE_TAG: + $params[1] = $this->convertParameterToTag($params[1], $l); + return (string) $l->t('%1$s deleted system tag %2$s', $params); + case self::UPDATE_TAG: + $params[1] = $this->convertParameterToTag($params[1], $l); + $params[2] = $this->convertParameterToTag($params[2], $l); + return (string) $l->t('%1$s updated system tag %3$s to %2$s', $params); + } + + return false; + } + + /** + * The extension can define the type of parameters for translation + * + * Currently known types are: + * * file => will strip away the path of the file and add a tooltip with it + * * username => will add the avatar of the user + * + * @param string $app + * @param string $text + * @return array|false + */ + public function getSpecialParameterList($app, $text) { + if ($app === self::APP_NAME) { + switch ($text) { + case self::CREATE_TAG: + case self::DELETE_TAG: + return array( + 0 => 'username', + //1 => 'systemtag description', + ); + case self::UPDATE_TAG: + return array( + 0 => 'username', + //1 => 'systemtag description', + //2 => 'systemtag description', + ); + } + } + + return false; + } + + /** + * The extension can define the parameter grouping by returning the index as integer. + * In case no grouping is required false is to be returned. + * + * @param array $activity + * @return integer|false + */ + public function getGroupParameter($activity) { + if ($activity['app'] === self::APP_NAME) { + switch ($activity['subject']) { + case self::CREATE_TAG: + // Group by system tag + // return 1; + } + } + + return false; + } + + /** + * The extension can define additional navigation entries. The array returned has to contain two keys 'top' + * and 'apps' which hold arrays with the relevant entries. + * If no further entries are to be added false is no be returned. + * + * @return array|false + */ + public function getNavigation() { + return false; + } + + /** + * The extension can check if a custom filter (given by a query string like filter=abc) is valid or not. + * + * @param string $filterValue + * @return boolean + */ + public function isFilterValid($filterValue) { + return false; + } + + /** + * The extension can filter the types based on the filter if required. + * In case no filter is to be applied false is to be returned unchanged. + * + * @param array $types + * @param string $filter + * @return array|false + */ + public function filterNotificationTypes($types, $filter) { + return false; + } + + /** + * For a given filter the extension can specify the sql query conditions including parameters for that query. + * In case the extension does not know the filter false is to be returned. + * The query condition and the parameters are to be returned as array with two elements. + * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%')); + * + * @param string $filter + * @return array|false + */ + public function getQueryForFilter($filter) { + return false; + } + + /** + * @param string $parameter + * @param IL10N $l + * @return string + */ + protected function convertParameterToTag($parameter, IL10N $l) { + if (preg_match('/^\\{\{\{(.*)\|\|\|(.*)\}\}\}\<\/parameter\>$/', $parameter, $matches)) { + switch ($matches[2]) { + case 'assignable': + return '' . $matches[1] . ''; + case 'not-assignable': + return '' . $l->t('%s (not-assignable)', $matches[1]) . ''; + case 'invisible': + return '' . $l->t('%s (invisible)', $matches[1]) . ''; + } + } + + return $parameter; + } +} diff --git a/apps/systemtags/activity/listener.php b/apps/systemtags/activity/listener.php new file mode 100644 index 0000000000..ce456afaef --- /dev/null +++ b/apps/systemtags/activity/listener.php @@ -0,0 +1,104 @@ + + * + * @copyright Copyright (c) 2016, 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\SystemTags\Activity; + +use OCP\Activity\IManager; +use OCP\IGroup; +use OCP\IGroupManager; +use OCP\IUser; +use OCP\IUserSession; +use OCP\SystemTag\ISystemTag; +use OCP\SystemTag\ManagerEvent; + +class Listener { + protected $groupManager; + protected $activityManager; + protected $session; + + /** + * Listener constructor. + * + * @param IGroupManager $groupManager + * @param IManager $activityManager + * @param IUserSession $session + */ + public function __construct(IGroupManager $groupManager, IManager $activityManager, IUserSession $session) { + $this->groupManager = $groupManager; + $this->activityManager = $activityManager; + $this->session = $session; + } + + public function event(ManagerEvent $event) { + $actor = $this->session->getUser(); + if ($actor instanceof IUser) { + $actor = $actor->getUID(); + } else { + $actor = ''; + } + + $activity = $this->activityManager->generateEvent(); + $activity->setApp(Extension::APP_NAME) + ->setType(Extension::APP_NAME) + ->setAuthor($actor); + if ($event->getEvent() === ManagerEvent::EVENT_CREATE) { + $activity->setSubject(Extension::CREATE_TAG, [ + $actor, + $this->prepareTagAsParameter($event->getTag()), + ]); + } else if ($event->getEvent() === ManagerEvent::EVENT_UPDATE) { + $activity->setSubject(Extension::UPDATE_TAG, [ + $actor, + $this->prepareTagAsParameter($event->getTag()), + $this->prepareTagAsParameter($event->getTagBefore()), + ]); + } else if ($event->getEvent() === ManagerEvent::EVENT_DELETE) { + $activity->setSubject(Extension::DELETE_TAG, [ + $actor, + $this->prepareTagAsParameter($event->getTag()), + ]); + } else { + return; + } + + $group = $this->groupManager->get('admin'); + if ($group instanceof IGroup) { + foreach ($group->getUsers() as $user) { + $activity->setAffectedUser($user->getUID()); + $this->activityManager->publish($activity); + } + } + } + + /** + * @param ISystemTag $tag + * @return string + */ + protected function prepareTagAsParameter(ISystemTag $tag) { + if (!$tag->isUserVisible()) { + return '{{{' . $tag->getName() . '|||invisible}}}'; + } else if (!$tag->isUserAssignable()) { + return '{{{' . $tag->getName() . '|||not-assignable}}}'; + } else { + return '{{{' . $tag->getName() . '|||assignable}}}'; + } + } +} diff --git a/apps/systemtags/appinfo/app.php b/apps/systemtags/appinfo/app.php index d3886993f8..c6fa21fa9b 100644 --- a/apps/systemtags/appinfo/app.php +++ b/apps/systemtags/appinfo/app.php @@ -19,6 +19,10 @@ * */ +use OCA\SystemTags\Activity\Extension; +use OCA\SystemTags\Activity\Listener; +use OCP\SystemTag\ManagerEvent; + $eventDispatcher = \OC::$server->getEventDispatcher(); $eventDispatcher->addListener( 'OCA\Files::loadAdditionalScripts', @@ -39,3 +43,24 @@ $eventDispatcher->addListener( \OCP\Util::addStyle('systemtags'); } ); + +$activityManager = \OC::$server->getActivityManager(); +$activityManager->registerExtension(function() { + return new Extension( + \OC::$server->getL10NFactory(), + \OC::$server->getActivityManager() + ); +}); + +$managerListener = function(ManagerEvent $event) use ($activityManager) { + $listener = new Listener( + \OC::$server->getGroupManager(), + $activityManager, + \OC::$server->getUserSession() + ); + $listener->event($event); +}; + +$eventDispatcher->addListener(ManagerEvent::EVENT_CREATE, $managerListener); +$eventDispatcher->addListener(ManagerEvent::EVENT_DELETE, $managerListener); +$eventDispatcher->addListener(ManagerEvent::EVENT_UPDATE, $managerListener);