diff --git a/settings/Activity/GroupProvider.php b/settings/Activity/GroupProvider.php new file mode 100644 index 0000000000..866cb08366 --- /dev/null +++ b/settings/Activity/GroupProvider.php @@ -0,0 +1,202 @@ + + * + * @author Christoph Wurst + * @author Joas Schilling + * + * @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\Settings\Activity; + +use InvalidArgumentException; +use OCP\Activity\IEvent; +use OCP\Activity\IManager; +use OCP\Activity\IProvider; +use OCP\IGroup; +use OCP\IGroupManager; +use OCP\IURLGenerator; +use OCP\IUser; +use OCP\IUserManager; +use OCP\L10N\IFactory as L10nFactory; + +class GroupProvider implements IProvider { + + public const ADDED_TO_GROUP = 'group_added'; + public const REMOVED_FROM_GROUP = 'group_removed'; + + /** @var L10nFactory */ + private $l10n; + /** @var IURLGenerator */ + private $urlGenerator; + /** @var IManager */ + private $activityManager; + /** @var IUserManager */ + protected $userManager; + /** @var IGroupManager */ + protected $groupManager; + + /** @var string[] */ + protected $groupDisplayNames = []; + /** @var string[] */ + protected $userDisplayNames = []; + + + public function __construct(L10nFactory $l10n, + IURLGenerator $urlGenerator, + IManager $activityManager, + IUserManager $userManager, + IGroupManager $groupManager) { + $this->urlGenerator = $urlGenerator; + $this->l10n = $l10n; + $this->activityManager = $activityManager; + $this->userManager = $userManager; + $this->groupManager = $groupManager; + } + + public function parse($language, IEvent $event, IEvent $previousEvent = null) { + if ($event->getType() !== 'group_settings') { + throw new InvalidArgumentException(); + } + + $l = $this->l10n->get('settings', $language); + + $params = $event->getSubjectParameters(); + $parsedParameters = [ + 'user' => $this->generateUserParameter($params['user']), + 'group' => $this->generateGroupParameter($params['group']), + ]; + + if (isset($params['actor'])) { + $parsedParameters['actor'] = $this->generateUserParameter($params['actor']); + } + + switch ($event->getSubject()) { + case self::ADDED_TO_GROUP: + if (isset($parsedParameters['actor'])) { + if ($this->activityManager->getCurrentUserId() === $params['user']) { + $subject = $l->t('{actor} added you to group {group}'); + } elseif (isset($params['actor']) && $this->activityManager->getCurrentUserId() === $params['actor']) { + $subject = $l->t('You added {user} to group {group}'); + } else { + $subject = $l->t('{actor} added {user} to group {group}'); + } + } else if ($this->activityManager->getCurrentUserId() === $params['user']) { + $subject = $l->t('An administrator added you to group {group}'); + } else { + $subject = $l->t('An administrator added {user} to group {group}'); + } + break; + case self::REMOVED_FROM_GROUP: + if (isset($parsedParameters['actor'])) { + if ($this->activityManager->getCurrentUserId() === $params['user']) { + $subject = $l->t('{actor} removed you from group {group}'); + } elseif (isset($params['actor']) && $this->activityManager->getCurrentUserId() === $params['actor']) { + $subject = $l->t('You removed {user} from group {group}'); + } else { + $subject = $l->t('{actor} removed {user} from group {group}'); + } + } else if ($this->activityManager->getCurrentUserId() === $params['user']) { + $subject = $l->t('An administrator removed you from group {group}'); + } else { + $subject = $l->t('An administrator removed {user} from group {group}'); + } + break; + default: + throw new InvalidArgumentException(); + } + + $this->setSubjects($event, $subject, $parsedParameters); + + return $event; + } + + /** + * @param IEvent $event + * @param string $subject + * @param array $parameters + * @throws \InvalidArgumentException + */ + protected function setSubjects(IEvent $event, string $subject, array $parameters): void { + $placeholders = $replacements = []; + foreach ($parameters as $placeholder => $parameter) { + $placeholders[] = '{' . $placeholder . '}'; + $replacements[] = $parameter['name']; + } + + $event->setParsedSubject(str_replace($placeholders, $replacements, $subject)) + ->setRichSubject($subject, $parameters); + } + + /** + * @param string $gid + * @return array + */ + protected function generateGroupParameter(string $gid): array { + if (!isset($this->groupDisplayNames[$gid])) { + $this->groupDisplayNames[$gid] = $this->getGroupDisplayName($gid); + } + + return [ + 'type' => 'user-group', + 'id' => $gid, + 'name' => $this->groupDisplayNames[$gid], + ]; + } + + /** + * @param string $gid + * @return string + */ + protected function getGroupDisplayName(string $gid): string { + $group = $this->groupManager->get($gid); + if ($group instanceof IGroup) { + return $group->getDisplayName(); + } + return $gid; + } + + /** + * @param string $uid + * @return array + */ + protected function generateUserParameter(string $uid): array { + if (!isset($this->displayNames[$uid])) { + $this->userDisplayNames[$uid] = $this->getDisplayName($uid); + } + + return [ + 'type' => 'user', + 'id' => $uid, + 'name' => $this->userDisplayNames[$uid], + ]; + } + + /** + * @param string $uid + * @return string + */ + protected function getDisplayName(string $uid): string { + $user = $this->userManager->get($uid); + if ($user instanceof IUser) { + return $user->getDisplayName(); + } else { + return $uid; + } + } +} diff --git a/settings/Activity/GroupSetting.php b/settings/Activity/GroupSetting.php new file mode 100644 index 0000000000..39b13d5c14 --- /dev/null +++ b/settings/Activity/GroupSetting.php @@ -0,0 +1,98 @@ + + * + * @author Joas Schilling + * + * @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\Settings\Activity; + +use OCP\Activity\ISetting; +use OCP\IL10N; + +class GroupSetting implements ISetting { + + /** @var IL10N */ + protected $l; + + /** + * @param IL10N $l10n + */ + public function __construct(IL10N $l10n) { + $this->l = $l10n; + } + + /** + * @return string Lowercase a-z and underscore only identifier + * @since 11.0.0 + */ + public function getIdentifier(): string { + return 'group_settings'; + } + + /** + * @return string A translated string + * @since 11.0.0 + */ + public function getName(): string { + return $this->l->t('Your group memberships were modified'); + } + + /** + * @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 11.0.0 + */ + public function getPriority(): int { + return 0; + } + + /** + * @return bool True when the option can be changed for the stream + * @since 11.0.0 + */ + public function canChangeStream(): bool { + return false; + } + + /** + * @return bool True when the option can be changed for the stream + * @since 11.0.0 + */ + public function isDefaultEnabledStream(): bool { + return true; + } + + /** + * @return bool True when the option can be changed for the mail + * @since 11.0.0 + */ + public function canChangeMail(): bool { + return false; + } + + /** + * @return bool True when the option can be changed for the stream + * @since 11.0.0 + */ + public function isDefaultEnabledMail(): bool { + return true; + } +} diff --git a/settings/Application.php b/settings/Application.php index 111cb6a6e0..b76ebda403 100644 --- a/settings/Application.php +++ b/settings/Application.php @@ -33,6 +33,8 @@ use OC\AppFramework\Utility\TimeFactory; use OC\Authentication\Token\IProvider; use OC\Authentication\Token\IToken; use OC\Server; +use OC\Settings\Activity\GroupProvider; +use OC\Settings\Activity\GroupSetting; use OC\Settings\Activity\Provider; use OC\Settings\Activity\SecurityFilter; use OC\Settings\Activity\SecurityProvider; @@ -44,7 +46,9 @@ use OCP\Activity\IManager as IActivityManager; use OCP\AppFramework\App; use OCP\Defaults; use OCP\IContainer; +use OCP\IGroup; use OCP\ILogger; +use OCP\IUser; use OCP\Settings\IManager; use OCP\Util; use Symfony\Component\EventDispatcher\EventDispatcherInterface; @@ -149,13 +153,32 @@ class Application extends App { $activityManager->registerFilter(SecurityFilter::class); // FIXME move to info.xml $activityManager->registerSetting(SecuritySetting::class); // FIXME move to info.xml $activityManager->registerProvider(SecurityProvider::class); // FIXME move to info.xml + $activityManager->registerSetting(GroupSetting::class); // FIXME move to info.xml + $activityManager->registerProvider(GroupProvider::class); // FIXME move to info.xml Util::connectHook('OC_User', 'post_setPassword', $this, 'onChangePassword'); Util::connectHook('OC_User', 'changeUser', $this, 'onChangeInfo'); + $groupManager = $this->getContainer()->getServer()->getGroupManager(); + $groupManager->listen('\OC\Group', 'postRemoveUser', [$this, 'removeUserFromGroup']); + $groupManager->listen('\OC\Group', 'postAddUser', [$this, 'addUserToGroup']); + Util::connectHook('\OCP\Config', 'js', $this, 'extendJsConfig'); } + public function addUserToGroup(IGroup $group, IUser $user): void { + /** @var Hooks $hooks */ + $hooks = $this->getContainer()->query(Hooks::class); + $hooks->addUserToGroup($group, $user); + + } + + public function removeUserFromGroup(IGroup $group, IUser $user): void { + /** @var Hooks $hooks */ + $hooks = $this->getContainer()->query(Hooks::class); + $hooks->removeUserFromGroup($group, $user); + } + /** * @param array $parameters * @throws \InvalidArgumentException diff --git a/settings/Hooks.php b/settings/Hooks.php index f2b9e4fd08..49189ca082 100644 --- a/settings/Hooks.php +++ b/settings/Hooks.php @@ -25,9 +25,12 @@ namespace OC\Settings; +use OC\Settings\Activity\GroupProvider; use OC\Settings\Activity\Provider; use OCP\Activity\IManager as IActivityManager; use OCP\IConfig; +use OCP\IGroup; +use OCP\IGroupManager; use OCP\IL10N; use OCP\IURLGenerator; use OCP\IUser; @@ -40,6 +43,8 @@ class Hooks { /** @var IActivityManager */ protected $activityManager; + /** @var IGroupManager|\OC\Group\Manager */ + protected $groupManager; /** @var IUserManager */ protected $userManager; /** @var IUserSession */ @@ -56,6 +61,7 @@ class Hooks { protected $l; public function __construct(IActivityManager $activityManager, + IGroupManager $groupManager, IUserManager $userManager, IUserSession $userSession, IURLGenerator $urlGenerator, @@ -64,6 +70,7 @@ class Hooks { IFactory $languageFactory, IL10N $l) { $this->activityManager = $activityManager; + $this->groupManager = $groupManager; $this->userManager = $userManager; $this->userSession = $userSession; $this->urlGenerator = $urlGenerator; @@ -210,4 +217,78 @@ class Hooks { $this->mailer->send($message); } } + + /** + * @param IGroup $group + * @param IUser $user + * @throws \InvalidArgumentException + * @throws \BadMethodCallException + */ + public function addUserToGroup(IGroup $group, IUser $user): void { + $subAdminManager = $this->groupManager->getSubAdmin(); + $usersToNotify = $subAdminManager->getGroupsSubAdmins($group); + $usersToNotify[] = $user; + + + $event = $this->activityManager->generateEvent(); + $event->setApp('settings') + ->setType('group_settings'); + + $actor = $this->userSession->getUser(); + if ($actor instanceof IUser) { + $event->setAuthor($actor->getUID()) + ->setSubject(GroupProvider::ADDED_TO_GROUP, [ + 'user' => $user->getUID(), + 'group' => $group->getGID(), + 'actor' => $actor->getUID(), + ]); + } else { + $event->setSubject(GroupProvider::ADDED_TO_GROUP, [ + 'user' => $user->getUID(), + 'group' => $group->getGID(), + ]); + } + + foreach ($usersToNotify as $userToNotify) { + $event->setAffectedUser($userToNotify->getUID()); + $this->activityManager->publish($event); + } + } + + /** + * @param IGroup $group + * @param IUser $user + * @throws \InvalidArgumentException + * @throws \BadMethodCallException + */ + public function removeUserFromGroup(IGroup $group, IUser $user): void { + $subAdminManager = $this->groupManager->getSubAdmin(); + $usersToNotify = $subAdminManager->getGroupsSubAdmins($group); + $usersToNotify[] = $user; + + + $event = $this->activityManager->generateEvent(); + $event->setApp('settings') + ->setType('group_settings'); + + $actor = $this->userSession->getUser(); + if ($actor instanceof IUser) { + $event->setAuthor($actor->getUID()) + ->setSubject(GroupProvider::REMOVED_FROM_GROUP, [ + 'user' => $user->getUID(), + 'group' => $group->getGID(), + 'actor' => $actor->getUID(), + ]); + } else { + $event->setSubject(GroupProvider::REMOVED_FROM_GROUP, [ + 'user' => $user->getUID(), + 'group' => $group->getGID(), + ]); + } + + foreach ($usersToNotify as $userToNotify) { + $event->setAffectedUser($userToNotify->getUID()); + $this->activityManager->publish($event); + } + } }