diff options
Diffstat (limited to 'apps/dav/lib/CardDAV/Activity')
-rw-r--r-- | apps/dav/lib/CardDAV/Activity/Backend.php | 472 | ||||
-rw-r--r-- | apps/dav/lib/CardDAV/Activity/Filter.php | 65 | ||||
-rw-r--r-- | apps/dav/lib/CardDAV/Activity/Provider/Addressbook.php | 165 | ||||
-rw-r--r-- | apps/dav/lib/CardDAV/Activity/Provider/Base.php | 95 | ||||
-rw-r--r-- | apps/dav/lib/CardDAV/Activity/Provider/Card.php | 114 | ||||
-rw-r--r-- | apps/dav/lib/CardDAV/Activity/Setting.php | 64 |
6 files changed, 975 insertions, 0 deletions
diff --git a/apps/dav/lib/CardDAV/Activity/Backend.php b/apps/dav/lib/CardDAV/Activity/Backend.php new file mode 100644 index 00000000000..b08414d3b02 --- /dev/null +++ b/apps/dav/lib/CardDAV/Activity/Backend.php @@ -0,0 +1,472 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OCA\DAV\CardDAV\Activity; + +use OCA\DAV\CardDAV\Activity\Provider\Addressbook; +use OCP\Activity\IEvent; +use OCP\Activity\IManager as IActivityManager; +use OCP\App\IAppManager; +use OCP\IGroup; +use OCP\IGroupManager; +use OCP\IUser; +use OCP\IUserManager; +use OCP\IUserSession; +use Sabre\CardDAV\Plugin; +use Sabre\VObject\Reader; + +class Backend { + + public function __construct( + protected IActivityManager $activityManager, + protected IGroupManager $groupManager, + protected IUserSession $userSession, + protected IAppManager $appManager, + protected IUserManager $userManager, + ) { + } + + /** + * Creates activities when an addressbook was creates + * + * @param array $addressbookData + */ + public function onAddressbookCreate(array $addressbookData): void { + $this->triggerAddressbookActivity(Addressbook::SUBJECT_ADD, $addressbookData); + } + + /** + * Creates activities when a calendar was updated + * + * @param array $addressbookData + * @param array $shares + * @param array $properties + */ + public function onAddressbookUpdate(array $addressbookData, array $shares, array $properties): void { + $this->triggerAddressbookActivity(Addressbook::SUBJECT_UPDATE, $addressbookData, $shares, $properties); + } + + /** + * Creates activities when a calendar was deleted + * + * @param array $addressbookData + * @param array $shares + */ + public function onAddressbookDelete(array $addressbookData, array $shares): void { + $this->triggerAddressbookActivity(Addressbook::SUBJECT_DELETE, $addressbookData, $shares); + } + + /** + * Creates activities for all related users when a calendar was touched + * + * @param string $action + * @param array $addressbookData + * @param array $shares + * @param array $changedProperties + */ + protected function triggerAddressbookActivity(string $action, array $addressbookData, array $shares = [], array $changedProperties = []): void { + if (!isset($addressbookData['principaluri'])) { + return; + } + + $principalUri = $addressbookData['principaluri']; + + // We are not interested in changes from the system addressbook + if ($principalUri === 'principals/system/system') { + return; + } + + $principal = explode('/', $principalUri); + $owner = array_pop($principal); + + $currentUser = $this->userSession->getUser(); + if ($currentUser instanceof IUser) { + $currentUser = $currentUser->getUID(); + } else { + $currentUser = $owner; + } + + $event = $this->activityManager->generateEvent(); + $event->setApp('dav') + ->setObject('addressbook', (int)$addressbookData['id']) + ->setType('contacts') + ->setAuthor($currentUser); + + $changedVisibleInformation = array_intersect([ + '{DAV:}displayname', + '{' . Plugin::NS_CARDDAV . '}addressbook-description', + ], array_keys($changedProperties)); + + if (empty($shares) || ($action === Addressbook::SUBJECT_UPDATE && empty($changedVisibleInformation))) { + $users = [$owner]; + } else { + $users = $this->getUsersForShares($shares); + $users[] = $owner; + } + + foreach ($users as $user) { + if ($action === Addressbook::SUBJECT_DELETE && !$this->userManager->userExists($user)) { + // Avoid creating addressbook_delete activities for deleted users + continue; + } + + $event->setAffectedUser($user) + ->setSubject( + $user === $currentUser ? $action . '_self' : $action, + [ + 'actor' => $currentUser, + 'addressbook' => [ + 'id' => (int)$addressbookData['id'], + 'uri' => $addressbookData['uri'], + 'name' => $addressbookData['{DAV:}displayname'], + ], + ] + ); + $this->activityManager->publish($event); + } + } + + /** + * Creates activities for all related users when an addressbook was (un-)shared + * + * @param array $addressbookData + * @param array $shares + * @param array $add + * @param array $remove + */ + public function onAddressbookUpdateShares(array $addressbookData, array $shares, array $add, array $remove): void { + $principal = explode('/', $addressbookData['principaluri']); + $owner = $principal[2]; + + $currentUser = $this->userSession->getUser(); + if ($currentUser instanceof IUser) { + $currentUser = $currentUser->getUID(); + } else { + $currentUser = $owner; + } + + $event = $this->activityManager->generateEvent(); + $event->setApp('dav') + ->setObject('addressbook', (int)$addressbookData['id']) + ->setType('contacts') + ->setAuthor($currentUser); + + foreach ($remove as $principal) { + // principal:principals/users/test + $parts = explode(':', $principal, 2); + if ($parts[0] !== 'principal') { + continue; + } + $principal = explode('/', $parts[1]); + + if ($principal[1] === 'users') { + $this->triggerActivityUser( + $principal[2], + $event, + $addressbookData, + Addressbook::SUBJECT_UNSHARE_USER, + Addressbook::SUBJECT_DELETE . '_self' + ); + + if ($owner !== $principal[2]) { + $parameters = [ + 'actor' => $event->getAuthor(), + 'addressbook' => [ + 'id' => (int)$addressbookData['id'], + 'uri' => $addressbookData['uri'], + 'name' => $addressbookData['{DAV:}displayname'], + ], + 'user' => $principal[2], + ]; + + if ($owner === $event->getAuthor()) { + $subject = Addressbook::SUBJECT_UNSHARE_USER . '_you'; + } elseif ($principal[2] === $event->getAuthor()) { + $subject = Addressbook::SUBJECT_UNSHARE_USER . '_self'; + } else { + $event->setAffectedUser($event->getAuthor()) + ->setSubject(Addressbook::SUBJECT_UNSHARE_USER . '_you', $parameters); + $this->activityManager->publish($event); + + $subject = Addressbook::SUBJECT_UNSHARE_USER . '_by'; + } + + $event->setAffectedUser($owner) + ->setSubject($subject, $parameters); + $this->activityManager->publish($event); + } + } elseif ($principal[1] === 'groups') { + $this->triggerActivityGroup($principal[2], $event, $addressbookData, Addressbook::SUBJECT_UNSHARE_USER); + + $parameters = [ + 'actor' => $event->getAuthor(), + 'addressbook' => [ + 'id' => (int)$addressbookData['id'], + 'uri' => $addressbookData['uri'], + 'name' => $addressbookData['{DAV:}displayname'], + ], + 'group' => $principal[2], + ]; + + if ($owner === $event->getAuthor()) { + $subject = Addressbook::SUBJECT_UNSHARE_GROUP . '_you'; + } else { + $event->setAffectedUser($event->getAuthor()) + ->setSubject(Addressbook::SUBJECT_UNSHARE_GROUP . '_you', $parameters); + $this->activityManager->publish($event); + + $subject = Addressbook::SUBJECT_UNSHARE_GROUP . '_by'; + } + + $event->setAffectedUser($owner) + ->setSubject($subject, $parameters); + $this->activityManager->publish($event); + } + } + + foreach ($add as $share) { + if ($this->isAlreadyShared($share['href'], $shares)) { + continue; + } + + // principal:principals/users/test + $parts = explode(':', $share['href'], 2); + if ($parts[0] !== 'principal') { + continue; + } + $principal = explode('/', $parts[1]); + + if ($principal[1] === 'users') { + $this->triggerActivityUser($principal[2], $event, $addressbookData, Addressbook::SUBJECT_SHARE_USER); + + if ($owner !== $principal[2]) { + $parameters = [ + 'actor' => $event->getAuthor(), + 'addressbook' => [ + 'id' => (int)$addressbookData['id'], + 'uri' => $addressbookData['uri'], + 'name' => $addressbookData['{DAV:}displayname'], + ], + 'user' => $principal[2], + ]; + + if ($owner === $event->getAuthor()) { + $subject = Addressbook::SUBJECT_SHARE_USER . '_you'; + } else { + $event->setAffectedUser($event->getAuthor()) + ->setSubject(Addressbook::SUBJECT_SHARE_USER . '_you', $parameters); + $this->activityManager->publish($event); + + $subject = Addressbook::SUBJECT_SHARE_USER . '_by'; + } + + $event->setAffectedUser($owner) + ->setSubject($subject, $parameters); + $this->activityManager->publish($event); + } + } elseif ($principal[1] === 'groups') { + $this->triggerActivityGroup($principal[2], $event, $addressbookData, Addressbook::SUBJECT_SHARE_USER); + + $parameters = [ + 'actor' => $event->getAuthor(), + 'addressbook' => [ + 'id' => (int)$addressbookData['id'], + 'uri' => $addressbookData['uri'], + 'name' => $addressbookData['{DAV:}displayname'], + ], + 'group' => $principal[2], + ]; + + if ($owner === $event->getAuthor()) { + $subject = Addressbook::SUBJECT_SHARE_GROUP . '_you'; + } else { + $event->setAffectedUser($event->getAuthor()) + ->setSubject(Addressbook::SUBJECT_SHARE_GROUP . '_you', $parameters); + $this->activityManager->publish($event); + + $subject = Addressbook::SUBJECT_SHARE_GROUP . '_by'; + } + + $event->setAffectedUser($owner) + ->setSubject($subject, $parameters); + $this->activityManager->publish($event); + } + } + } + + /** + * Checks if a calendar is already shared with a principal + * + * @param string $principal + * @param array[] $shares + * @return bool + */ + protected function isAlreadyShared(string $principal, array $shares): bool { + foreach ($shares as $share) { + if ($principal === $share['href']) { + return true; + } + } + + return false; + } + + /** + * Creates the given activity for all members of the given group + * + * @param string $gid + * @param IEvent $event + * @param array $properties + * @param string $subject + */ + protected function triggerActivityGroup(string $gid, IEvent $event, array $properties, string $subject): void { + $group = $this->groupManager->get($gid); + + if ($group instanceof IGroup) { + foreach ($group->getUsers() as $user) { + // Exclude current user + if ($user->getUID() !== $event->getAuthor()) { + $this->triggerActivityUser($user->getUID(), $event, $properties, $subject); + } + } + } + } + + /** + * Creates the given activity for the given user + * + * @param string $user + * @param IEvent $event + * @param array $properties + * @param string $subject + * @param string $subjectSelf + */ + protected function triggerActivityUser(string $user, IEvent $event, array $properties, string $subject, string $subjectSelf = ''): void { + $event->setAffectedUser($user) + ->setSubject( + $user === $event->getAuthor() && $subjectSelf ? $subjectSelf : $subject, + [ + 'actor' => $event->getAuthor(), + 'addressbook' => [ + 'id' => (int)$properties['id'], + 'uri' => $properties['uri'], + 'name' => $properties['{DAV:}displayname'], + ], + ] + ); + + $this->activityManager->publish($event); + } + + /** + * Creates activities when a card was created/updated/deleted + * + * @param string $action + * @param array $addressbookData + * @param array $shares + * @param array $cardData + */ + public function triggerCardActivity(string $action, array $addressbookData, array $shares, array $cardData): void { + if (!isset($addressbookData['principaluri'])) { + return; + } + + $principalUri = $addressbookData['principaluri']; + + // We are not interested in changes from the system addressbook + if ($principalUri === 'principals/system/system') { + return; + } + + $principal = explode('/', $principalUri); + $owner = array_pop($principal); + + $currentUser = $this->userSession->getUser(); + if ($currentUser instanceof IUser) { + $currentUser = $currentUser->getUID(); + } else { + $currentUser = $owner; + } + + $card = $this->getCardNameAndId($cardData); + + $event = $this->activityManager->generateEvent(); + $event->setApp('dav') + ->setObject('addressbook', (int)$addressbookData['id']) + ->setType('contacts') + ->setAuthor($currentUser); + + $users = $this->getUsersForShares($shares); + $users[] = $owner; + + // Users for share can return the owner itself if the calendar is published + foreach (array_unique($users) as $user) { + $params = [ + 'actor' => $event->getAuthor(), + 'addressbook' => [ + 'id' => (int)$addressbookData['id'], + 'uri' => $addressbookData['uri'], + 'name' => $addressbookData['{DAV:}displayname'], + ], + 'card' => [ + 'id' => $card['id'], + 'name' => $card['name'], + ], + ]; + + + $event->setAffectedUser($user) + ->setSubject( + $user === $currentUser ? $action . '_self' : $action, + $params + ); + + $this->activityManager->publish($event); + } + } + + /** + * @param array $cardData + * @return string[] + */ + protected function getCardNameAndId(array $cardData): array { + $vObject = Reader::read($cardData['carddata']); + return ['id' => (string)$vObject->UID, 'name' => (string)($vObject->FN ?? '')]; + } + + /** + * Get all users that have access to a given calendar + * + * @param array $shares + * @return string[] + */ + protected function getUsersForShares(array $shares): array { + $users = $groups = []; + foreach ($shares as $share) { + $principal = explode('/', $share['{http://owncloud.org/ns}principal']); + if ($principal[1] === 'users') { + $users[] = $principal[2]; + } elseif ($principal[1] === 'groups') { + $groups[] = $principal[2]; + } + } + + if (!empty($groups)) { + foreach ($groups as $gid) { + $group = $this->groupManager->get($gid); + if ($group instanceof IGroup) { + foreach ($group->getUsers() as $user) { + $users[] = $user->getUID(); + } + } + } + } + + return array_unique($users); + } +} diff --git a/apps/dav/lib/CardDAV/Activity/Filter.php b/apps/dav/lib/CardDAV/Activity/Filter.php new file mode 100644 index 00000000000..8b221a29ff0 --- /dev/null +++ b/apps/dav/lib/CardDAV/Activity/Filter.php @@ -0,0 +1,65 @@ +<?php + +/** + * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OCA\DAV\CardDAV\Activity; + +use OCP\Activity\IFilter; +use OCP\IL10N; +use OCP\IURLGenerator; + +class Filter implements IFilter { + + public function __construct( + protected IL10N $l, + protected IURLGenerator $url, + ) { + } + + /** + * @return string Lowercase a-z and underscore only identifier + */ + public function getIdentifier(): string { + return 'contacts'; + } + + /** + * @return string A translated string + */ + public function getName(): string { + return $this->l->t('Contacts'); + } + + /** + * @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. + */ + public function getPriority(): int { + return 40; + } + + /** + * @return string Full URL to an icon, empty string when none is given + */ + public function getIcon(): string { + return $this->url->getAbsoluteURL($this->url->imagePath('core', 'places/contacts.svg')); + } + + /** + * @param string[] $types + * @return string[] An array of allowed apps from which activities should be displayed + */ + public function filterTypes(array $types): array { + return array_intersect(['contacts'], $types); + } + + /** + * @return string[] An array of allowed apps from which activities should be displayed + */ + public function allowedApps(): array { + return []; + } +} diff --git a/apps/dav/lib/CardDAV/Activity/Provider/Addressbook.php b/apps/dav/lib/CardDAV/Activity/Provider/Addressbook.php new file mode 100644 index 00000000000..cdb9769401f --- /dev/null +++ b/apps/dav/lib/CardDAV/Activity/Provider/Addressbook.php @@ -0,0 +1,165 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OCA\DAV\CardDAV\Activity\Provider; + +use OCP\Activity\Exceptions\UnknownActivityException; +use OCP\Activity\IEvent; +use OCP\Activity\IEventMerger; +use OCP\Activity\IManager; +use OCP\IGroupManager; +use OCP\IL10N; +use OCP\IURLGenerator; +use OCP\IUserManager; +use OCP\L10N\IFactory; + +class Addressbook extends Base { + public const SUBJECT_ADD = 'addressbook_add'; + public const SUBJECT_UPDATE = 'addressbook_update'; + public const SUBJECT_DELETE = 'addressbook_delete'; + public const SUBJECT_SHARE_USER = 'addressbook_user_share'; + public const SUBJECT_SHARE_GROUP = 'addressbook_group_share'; + public const SUBJECT_UNSHARE_USER = 'addressbook_user_unshare'; + public const SUBJECT_UNSHARE_GROUP = 'addressbook_group_unshare'; + + public function __construct( + protected IFactory $languageFactory, + IURLGenerator $url, + protected IManager $activityManager, + IUserManager $userManager, + IGroupManager $groupManager, + protected IEventMerger $eventMerger, + ) { + parent::__construct($userManager, $groupManager, $url); + } + + /** + * @param string $language + * @param IEvent $event + * @param IEvent|null $previousEvent + * @return IEvent + * @throws UnknownActivityException + */ + public function parse($language, IEvent $event, ?IEvent $previousEvent = null): IEvent { + if ($event->getApp() !== 'dav' || $event->getType() !== 'contacts') { + throw new UnknownActivityException(); + } + + $l = $this->languageFactory->get('dav', $language); + + if ($this->activityManager->getRequirePNG()) { + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/contacts-dark.png'))); + } else { + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/contacts.svg'))); + } + + if ($event->getSubject() === self::SUBJECT_ADD) { + $subject = $l->t('{actor} created address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_ADD . '_self') { + $subject = $l->t('You created address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_DELETE) { + $subject = $l->t('{actor} deleted address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_DELETE . '_self') { + $subject = $l->t('You deleted address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_UPDATE) { + $subject = $l->t('{actor} updated address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_UPDATE . '_self') { + $subject = $l->t('You updated address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_SHARE_USER) { + $subject = $l->t('{actor} shared address book {addressbook} with you'); + } elseif ($event->getSubject() === self::SUBJECT_SHARE_USER . '_you') { + $subject = $l->t('You shared address book {addressbook} with {user}'); + } elseif ($event->getSubject() === self::SUBJECT_SHARE_USER . '_by') { + $subject = $l->t('{actor} shared address book {addressbook} with {user}'); + } elseif ($event->getSubject() === self::SUBJECT_UNSHARE_USER) { + $subject = $l->t('{actor} unshared address book {addressbook} from you'); + } elseif ($event->getSubject() === self::SUBJECT_UNSHARE_USER . '_you') { + $subject = $l->t('You unshared address book {addressbook} from {user}'); + } elseif ($event->getSubject() === self::SUBJECT_UNSHARE_USER . '_by') { + $subject = $l->t('{actor} unshared address book {addressbook} from {user}'); + } elseif ($event->getSubject() === self::SUBJECT_UNSHARE_USER . '_self') { + $subject = $l->t('{actor} unshared address book {addressbook} from themselves'); + } elseif ($event->getSubject() === self::SUBJECT_SHARE_GROUP . '_you') { + $subject = $l->t('You shared address book {addressbook} with group {group}'); + } elseif ($event->getSubject() === self::SUBJECT_SHARE_GROUP . '_by') { + $subject = $l->t('{actor} shared address book {addressbook} with group {group}'); + } elseif ($event->getSubject() === self::SUBJECT_UNSHARE_GROUP . '_you') { + $subject = $l->t('You unshared address book {addressbook} from group {group}'); + } elseif ($event->getSubject() === self::SUBJECT_UNSHARE_GROUP . '_by') { + $subject = $l->t('{actor} unshared address book {addressbook} from group {group}'); + } else { + throw new UnknownActivityException(); + } + + $parsedParameters = $this->getParameters($event, $l); + $this->setSubjects($event, $subject, $parsedParameters); + + $event = $this->eventMerger->mergeEvents('addressbook', $event, $previousEvent); + + if ($event->getChildEvent() === null) { + if (isset($parsedParameters['user'])) { + // Couldn't group by calendar, maybe we can group by users + $event = $this->eventMerger->mergeEvents('user', $event, $previousEvent); + } elseif (isset($parsedParameters['group'])) { + // Couldn't group by calendar, maybe we can group by groups + $event = $this->eventMerger->mergeEvents('group', $event, $previousEvent); + } + } + + return $event; + } + + protected function getParameters(IEvent $event, IL10N $l): array { + $subject = $event->getSubject(); + $parameters = $event->getSubjectParameters(); + + switch ($subject) { + case self::SUBJECT_ADD: + case self::SUBJECT_ADD . '_self': + case self::SUBJECT_DELETE: + case self::SUBJECT_DELETE . '_self': + case self::SUBJECT_UPDATE: + case self::SUBJECT_UPDATE . '_self': + case self::SUBJECT_SHARE_USER: + case self::SUBJECT_UNSHARE_USER: + case self::SUBJECT_UNSHARE_USER . '_self': + return [ + 'actor' => $this->generateUserParameter($parameters['actor']), + 'addressbook' => $this->generateAddressbookParameter($parameters['addressbook'], $l), + ]; + case self::SUBJECT_SHARE_USER . '_you': + case self::SUBJECT_UNSHARE_USER . '_you': + return [ + 'addressbook' => $this->generateAddressbookParameter($parameters['addressbook'], $l), + 'user' => $this->generateUserParameter($parameters['user']), + ]; + case self::SUBJECT_SHARE_USER . '_by': + case self::SUBJECT_UNSHARE_USER . '_by': + return [ + 'actor' => $this->generateUserParameter($parameters['actor']), + 'addressbook' => $this->generateAddressbookParameter($parameters['addressbook'], $l), + 'user' => $this->generateUserParameter($parameters['user']), + ]; + case self::SUBJECT_SHARE_GROUP . '_you': + case self::SUBJECT_UNSHARE_GROUP . '_you': + return [ + 'addressbook' => $this->generateAddressbookParameter($parameters['addressbook'], $l), + 'group' => $this->generateGroupParameter($parameters['group']), + ]; + case self::SUBJECT_SHARE_GROUP . '_by': + case self::SUBJECT_UNSHARE_GROUP . '_by': + return [ + 'actor' => $this->generateUserParameter($parameters['actor']), + 'addressbook' => $this->generateAddressbookParameter($parameters['addressbook'], $l), + 'group' => $this->generateGroupParameter($parameters['group']), + ]; + } + + throw new \InvalidArgumentException(); + } +} diff --git a/apps/dav/lib/CardDAV/Activity/Provider/Base.php b/apps/dav/lib/CardDAV/Activity/Provider/Base.php new file mode 100644 index 00000000000..ea7680aed60 --- /dev/null +++ b/apps/dav/lib/CardDAV/Activity/Provider/Base.php @@ -0,0 +1,95 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OCA\DAV\CardDAV\Activity\Provider; + +use OCA\DAV\CardDAV\CardDavBackend; +use OCP\Activity\IEvent; +use OCP\Activity\IProvider; +use OCP\IGroup; +use OCP\IGroupManager; +use OCP\IL10N; +use OCP\IURLGenerator; +use OCP\IUserManager; + +abstract class Base implements IProvider { + /** @var string[] */ + protected $userDisplayNames = []; + + /** @var string[] */ + protected $groupDisplayNames = []; + + public function __construct( + protected IUserManager $userManager, + protected IGroupManager $groupManager, + protected IURLGenerator $url, + ) { + } + + protected function setSubjects(IEvent $event, string $subject, array $parameters): void { + $event->setRichSubject($subject, $parameters); + } + + /** + * @param array $data + * @param IL10N $l + * @return array + */ + protected function generateAddressbookParameter(array $data, IL10N $l): array { + if ($data['uri'] === CardDavBackend::PERSONAL_ADDRESSBOOK_URI + && $data['name'] === CardDavBackend::PERSONAL_ADDRESSBOOK_NAME) { + return [ + 'type' => 'addressbook', + 'id' => (string)$data['id'], + 'name' => $l->t('Personal'), + ]; + } + + return [ + 'type' => 'addressbook', + 'id' => (string)$data['id'], + 'name' => $data['name'], + ]; + } + + protected function generateUserParameter(string $uid): array { + return [ + 'type' => 'user', + 'id' => $uid, + 'name' => $this->userManager->getDisplayName($uid) ?? $uid, + ]; + } + + /** + * @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; + } +} diff --git a/apps/dav/lib/CardDAV/Activity/Provider/Card.php b/apps/dav/lib/CardDAV/Activity/Provider/Card.php new file mode 100644 index 00000000000..acf23c00531 --- /dev/null +++ b/apps/dav/lib/CardDAV/Activity/Provider/Card.php @@ -0,0 +1,114 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OCA\DAV\CardDAV\Activity\Provider; + +use OCP\Activity\Exceptions\UnknownActivityException; +use OCP\Activity\IEvent; +use OCP\Activity\IEventMerger; +use OCP\Activity\IManager; +use OCP\App\IAppManager; +use OCP\IGroupManager; +use OCP\IL10N; +use OCP\IURLGenerator; +use OCP\IUserManager; +use OCP\L10N\IFactory; + +class Card extends Base { + public const SUBJECT_ADD = 'card_add'; + public const SUBJECT_UPDATE = 'card_update'; + public const SUBJECT_DELETE = 'card_delete'; + + public function __construct( + protected IFactory $languageFactory, + IURLGenerator $url, + protected IManager $activityManager, + IUserManager $userManager, + IGroupManager $groupManager, + protected IEventMerger $eventMerger, + protected IAppManager $appManager, + ) { + parent::__construct($userManager, $groupManager, $url); + } + + /** + * @param string $language + * @param IEvent $event + * @param IEvent|null $previousEvent + * @return IEvent + * @throws UnknownActivityException + */ + public function parse($language, IEvent $event, ?IEvent $previousEvent = null): IEvent { + if ($event->getApp() !== 'dav' || $event->getType() !== 'contacts') { + throw new UnknownActivityException(); + } + + $l = $this->languageFactory->get('dav', $language); + + if ($this->activityManager->getRequirePNG()) { + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/contacts-dark.png'))); + } else { + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/contacts.svg'))); + } + + if ($event->getSubject() === self::SUBJECT_ADD) { + $subject = $l->t('{actor} created contact {card} in address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_ADD . '_self') { + $subject = $l->t('You created contact {card} in address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_DELETE) { + $subject = $l->t('{actor} deleted contact {card} from address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_DELETE . '_self') { + $subject = $l->t('You deleted contact {card} from address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_UPDATE) { + $subject = $l->t('{actor} updated contact {card} in address book {addressbook}'); + } elseif ($event->getSubject() === self::SUBJECT_UPDATE . '_self') { + $subject = $l->t('You updated contact {card} in address book {addressbook}'); + } else { + throw new UnknownActivityException(); + } + + $parsedParameters = $this->getParameters($event, $l); + $this->setSubjects($event, $subject, $parsedParameters); + + $event = $this->eventMerger->mergeEvents('card', $event, $previousEvent); + return $event; + } + + protected function getParameters(IEvent $event, IL10N $l): array { + $subject = $event->getSubject(); + $parameters = $event->getSubjectParameters(); + + switch ($subject) { + case self::SUBJECT_ADD: + case self::SUBJECT_DELETE: + case self::SUBJECT_UPDATE: + return [ + 'actor' => $this->generateUserParameter($parameters['actor']), + 'addressbook' => $this->generateAddressbookParameter($parameters['addressbook'], $l), + 'card' => $this->generateCardParameter($parameters['card']), + ]; + case self::SUBJECT_ADD . '_self': + case self::SUBJECT_DELETE . '_self': + case self::SUBJECT_UPDATE . '_self': + return [ + 'addressbook' => $this->generateAddressbookParameter($parameters['addressbook'], $l), + 'card' => $this->generateCardParameter($parameters['card']), + ]; + } + + throw new \InvalidArgumentException(); + } + + private function generateCardParameter(array $cardData): array { + return [ + 'type' => 'addressbook-contact', + 'id' => $cardData['id'], + 'name' => $cardData['name'], + ]; + } +} diff --git a/apps/dav/lib/CardDAV/Activity/Setting.php b/apps/dav/lib/CardDAV/Activity/Setting.php new file mode 100644 index 00000000000..cc68cf87c83 --- /dev/null +++ b/apps/dav/lib/CardDAV/Activity/Setting.php @@ -0,0 +1,64 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OCA\DAV\CardDAV\Activity; + +use OCA\DAV\CalDAV\Activity\Setting\CalDAVSetting; + +class Setting extends CalDAVSetting { + /** + * @return string Lowercase a-z and underscore only identifier + */ + public function getIdentifier(): string { + return 'contacts'; + } + + /** + * @return string A translated string + */ + public function getName(): string { + return $this->l->t('A <strong>contact</strong> or <strong>address book</strong> was 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. + */ + public function getPriority(): int { + return 50; + } + + /** + * @return bool True when the option can be changed for the stream + */ + public function canChangeStream(): bool { + return true; + } + + /** + * @return bool True when the option can be changed for the stream + */ + public function isDefaultEnabledStream(): bool { + return true; + } + + /** + * @return bool True when the option can be changed for the mail + */ + public function canChangeMail(): bool { + return true; + } + + /** + * @return bool True when the option can be changed for the stream + */ + public function isDefaultEnabledMail(): bool { + return false; + } +} |