From ddc82b4ca2b75d97d84dd8476e3f6055f341505d Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 29 Nov 2016 15:47:43 +0100 Subject: [PATCH] Move calendar activity parsing to new API Signed-off-by: Joas Schilling --- apps/dav/appinfo/info.xml | 3 + apps/dav/lib/CalDAV/Activity/Extension.php | 73 ----- .../lib/CalDAV/Activity/Provider/Calendar.php | 285 ++++++++++++++++++ 3 files changed, 288 insertions(+), 73 deletions(-) create mode 100644 apps/dav/lib/CalDAV/Activity/Provider/Calendar.php diff --git a/apps/dav/appinfo/info.xml b/apps/dav/appinfo/info.xml index a8c4185f6c1..5335e020344 100644 --- a/apps/dav/appinfo/info.xml +++ b/apps/dav/appinfo/info.xml @@ -44,5 +44,8 @@ OCA\DAV\CalDAV\Activity\Setting\Todo + + OCA\DAV\CalDAV\Activity\Provider\Calendar + diff --git a/apps/dav/lib/CalDAV/Activity/Extension.php b/apps/dav/lib/CalDAV/Activity/Extension.php index 47f4351aa49..b6d4e23b71d 100644 --- a/apps/dav/lib/CalDAV/Activity/Extension.php +++ b/apps/dav/lib/CalDAV/Activity/Extension.php @@ -118,43 +118,6 @@ class Extension implements IExtension { $l = $this->getL10N($languageCode); switch ($text) { - case self::SUBJECT_ADD: - return (string) $l->t('%1$s created calendar %2$s', $params); - case self::SUBJECT_ADD . '_self': - return (string) $l->t('You created calendar %2$s', $params); - case self::SUBJECT_DELETE: - return (string) $l->t('%1$s deleted calendar %2$s', $params); - case self::SUBJECT_DELETE . '_self': - return (string) $l->t('You deleted calendar %2$s', $params); - case self::SUBJECT_UPDATE: - return (string) $l->t('%1$s updated calendar %2$s', $params); - case self::SUBJECT_UPDATE . '_self': - return (string) $l->t('You updated calendar %2$s', $params); - - case self::SUBJECT_SHARE_USER: - return (string) $l->t('%1$s shared calendar %2$s with you', $params); - case self::SUBJECT_SHARE_USER . '_you': - return (string) $l->t('You shared calendar %2$s with %1$s', $params); - case self::SUBJECT_SHARE_USER . '_by': - return (string) $l->t('%3$s shared calendar %2$s with %1$s', $params); - case self::SUBJECT_UNSHARE_USER: - return (string) $l->t('%1$s unshared calendar %2$s from you', $params); - case self::SUBJECT_UNSHARE_USER . '_you': - return (string) $l->t('You unshared calendar %2$s from %1$s', $params); - case self::SUBJECT_UNSHARE_USER . '_by': - return (string) $l->t('%3$s unshared calendar %2$s from %1$s', $params); - case self::SUBJECT_UNSHARE_USER . '_self': - return (string) $l->t('%1$s unshared calendar %2$s from themselves', $params); - - case self::SUBJECT_SHARE_GROUP . '_you': - return (string) $l->t('You shared calendar %2$s with group %1$s', $params); - case self::SUBJECT_SHARE_GROUP . '_by': - return (string) $l->t('%3$s shared calendar %2$s with group %1$s', $params); - case self::SUBJECT_UNSHARE_GROUP . '_you': - return (string) $l->t('You unshared calendar %2$s from group %1$s', $params); - case self::SUBJECT_UNSHARE_GROUP . '_by': - return (string) $l->t('%3$s unshared calendar %2$s from group %1$s', $params); - case self::SUBJECT_OBJECT_ADD . '_event': return (string) $l->t('%1$s created event %3$s in calendar %2$s', $params); case self::SUBJECT_OBJECT_ADD . '_event_self': @@ -209,42 +172,6 @@ class Extension implements IExtension { public function getSpecialParameterList($app, $text) { if ($app === self::APP) { switch ($text) { - 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_SHARE_USER . '_you': - case self::SUBJECT_UNSHARE_USER: - case self::SUBJECT_UNSHARE_USER . '_you': - case self::SUBJECT_UNSHARE_USER . '_self': - return [ - 0 => 'username', - //1 => 'calendar', - ]; - case self::SUBJECT_SHARE_USER . '_by': - case self::SUBJECT_UNSHARE_USER . '_by': - return [ - 0 => 'username', - //1 => 'calendar', - 2 => 'username', - ]; - case self::SUBJECT_SHARE_GROUP . '_you': - case self::SUBJECT_UNSHARE_GROUP . '_you': - return [ - //0 => 'group', - //1 => 'calendar', - ]; - case self::SUBJECT_SHARE_GROUP . '_by': - case self::SUBJECT_UNSHARE_GROUP . '_by': - return [ - //0 => 'group', - //1 => 'calendar', - 2 => 'username', - ]; - case self::SUBJECT_OBJECT_ADD . '_event': case self::SUBJECT_OBJECT_ADD . '_event_self': case self::SUBJECT_OBJECT_DELETE . '_event': diff --git a/apps/dav/lib/CalDAV/Activity/Provider/Calendar.php b/apps/dav/lib/CalDAV/Activity/Provider/Calendar.php new file mode 100644 index 00000000000..2307c2048e0 --- /dev/null +++ b/apps/dav/lib/CalDAV/Activity/Provider/Calendar.php @@ -0,0 +1,285 @@ + + * + * @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 OCA\DAV\CalDAV\Activity\Provider; + +use OCP\Activity\IEvent; +use OCP\Activity\IEventMerger; +use OCP\Activity\IManager; +use OCP\Activity\IProvider; +use OCP\IL10N; +use OCP\IURLGenerator; +use OCP\IUser; +use OCP\IUserManager; + +class Calendar implements IProvider { + + const SUBJECT_ADD = 'calendar_add'; + const SUBJECT_UPDATE = 'calendar_update'; + const SUBJECT_DELETE = 'calendar_delete'; + const SUBJECT_SHARE_USER = 'calendar_user_share'; + const SUBJECT_SHARE_GROUP = 'calendar_group_share'; + const SUBJECT_UNSHARE_USER = 'calendar_user_unshare'; + const SUBJECT_UNSHARE_GROUP = 'calendar_group_unshare'; + + /** @var IL10N */ + protected $l; + + /** @var IURLGenerator */ + protected $url; + + /** @var IManager */ + protected $activityManager; + + /** @var IUserManager */ + protected $userManager; + + /** @var IEventMerger */ + protected $eventMerger; + + /** @var string[] cached displayNames - key is the UID and value the displayname */ + protected $displayNames = []; + + /** + * @param IL10N $l + * @param IURLGenerator $url + * @param IManager $activityManager + * @param IUserManager $userManager + * @param IEventMerger $eventMerger + */ + public function __construct(IL10N $l, IURLGenerator $url, IManager $activityManager, IUserManager $userManager, IEventMerger $eventMerger) { + $this->l = $l; + $this->url = $url; + $this->activityManager = $activityManager; + $this->userManager = $userManager; + $this->eventMerger = $eventMerger; + } + + /** + * @param IEvent $event + * @param IEvent|null $previousEvent + * @return IEvent + * @throws \InvalidArgumentException + * @since 11.0.0 + */ + public function parse(IEvent $event, IEvent $previousEvent = null) { + if ($event->getApp() !== 'dav') { + throw new \InvalidArgumentException(); + } + + if ($event->getSubject() === self::SUBJECT_ADD) { + $subject = $this->l->t('{actor} created calendar {calendar}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_ADD . '_self') { + $subject = $this->l->t('You created calendar {calendar}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_DELETE) { + $subject = $this->l->t('{actor} deleted calendar {calendar}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_DELETE . '_self') { + $subject = $this->l->t('You deleted calendar {calendar}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_UPDATE) { + $subject = $this->l->t('{actor} updated calendar {calendar}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_UPDATE . '_self') { + $subject = $this->l->t('You updated calendar {calendar}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + + } else if ($event->getSubject() === self::SUBJECT_SHARE_USER) { + $subject = $this->l->t('{actor} shared calendar {calendar} with you'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_SHARE_USER . '_you') { + $subject = $this->l->t('You shared calendar {calendar} with {user}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_SHARE_USER . '_by') { + $subject = $this->l->t('{actor} shared calendar {calendar} with {user}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_UNSHARE_USER) { + $subject = $this->l->t('{actor} unshared calendar {calendar} from you'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_UNSHARE_USER . '_you') { + $subject = $this->l->t('You unshared calendar {calendar} from {user}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_UNSHARE_USER . '_by') { + $subject = $this->l->t('{actor} unshared calendar {calendar} from {user}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_UNSHARE_USER . '_self') { + $subject = $this->l->t('{actor} unshared calendar {calendar} from themselves'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + + } else if ($event->getSubject() === self::SUBJECT_SHARE_GROUP . '_you') { + $subject = $this->l->t('You shared calendar {calendar} with group {group}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_SHARE_GROUP . '_by') { + $subject = $this->l->t('{actor} shared calendar {calendar} with group {group}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_UNSHARE_GROUP . '_you') { + $subject = $this->l->t('You unshared calendar {calendar} from group {group}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else if ($event->getSubject() === self::SUBJECT_UNSHARE_GROUP . '_by') { + $subject = $this->l->t('{actor} unshared calendar {calendar} from group {group}'); + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.svg'))); + } else { + throw new \InvalidArgumentException(); + } + + $parsedParameters = $this->getParameters($event); + $this->setSubjects($event, $subject, $parsedParameters); + + $event = $this->eventMerger->mergeEvents('calendar', $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); + } else if (isset($parsedParameters['group'])) { + // Couldn't group by calendar, maybe we can group by groups + $event = $this->eventMerger->mergeEvents('group', $event, $previousEvent); + } + } + + return $event; + } + + /** + * @param IEvent $event + * @param string $subject + * @param array $parameters + */ + protected function setSubjects(IEvent $event, $subject, array $parameters) { + $placeholders = $replacements = []; + foreach ($parameters as $placeholder => $parameter) { + $placeholders[] = '{' . $placeholder . '}'; + $replacements[] = $parameter['name']; + } + + $event->setParsedSubject(str_replace($placeholders, $replacements, $subject)) + ->setRichSubject($subject, $parameters); + } + + /** + * @param IEvent $event + * @return array + */ + protected function getParameters(IEvent $event) { + $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[0]), + 'calendar' => $this->generateCalendarParameter($event->getObjectId(), $parameters[1]), + ]; + case self::SUBJECT_SHARE_USER . '_you': + case self::SUBJECT_UNSHARE_USER . '_you': + return [ + 'user' => $this->generateUserParameter($parameters[0]), + 'calendar' => $this->generateCalendarParameter($event->getObjectId(), $parameters[1]), + ]; + case self::SUBJECT_SHARE_USER . '_by': + case self::SUBJECT_UNSHARE_USER . '_by': + return [ + 'user' => $this->generateUserParameter($parameters[0]), + 'calendar' => $this->generateCalendarParameter($event->getObjectId(), $parameters[1]), + 'actor' => $this->generateUserParameter($parameters[2]), + ]; + case self::SUBJECT_SHARE_GROUP . '_you': + case self::SUBJECT_UNSHARE_GROUP . '_you': + return [ + 'group' => $this->generateGroupParameter($parameters[0]), + 'calendar' => $this->generateCalendarParameter($event->getObjectId(), $parameters[1]), + ]; + case self::SUBJECT_SHARE_GROUP . '_by': + case self::SUBJECT_UNSHARE_GROUP . '_by': + return [ + 'group' => $this->generateGroupParameter($parameters[0]), + 'calendar' => $this->generateCalendarParameter($event->getObjectId(), $parameters[1]), + 'actor' => $this->generateUserParameter($parameters[2]), + ]; + } + + throw new \InvalidArgumentException(); + } + + /** + * @param string $id + * @return array + */ + protected function generateGroupParameter($id) { + return [ + 'type' => 'group', + 'id' => $id, + 'name' => $id, + ]; + } + + /** + * @param int $id + * @param string $name + * @return array + */ + protected function generateCalendarParameter($id, $name) { + return [ + 'type' => 'calendar', + 'id' => $id, + 'name' => $name, + ]; + } + + /** + * @param string $uid + * @return array + */ + protected function generateUserParameter($uid) { + if (!isset($this->displayNames[$uid])) { + $this->displayNames[$uid] = $this->getDisplayName($uid); + } + + return [ + 'type' => 'user', + 'id' => $uid, + 'name' => $this->displayNames[$uid], + ]; + } + + /** + * @param string $uid + * @return string + */ + protected function getDisplayName($uid) { + $user = $this->userManager->get($uid); + if ($user instanceof IUser) { + return $user->getDisplayName(); + } else { + return $uid; + } + } +} -- 2.39.5