* * @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\Files_Sharing\Activity\Providers; use OCP\Activity\IEvent; use OCP\Activity\IManager; use OCP\Activity\IProvider; use OCP\IL10N; use OCP\IURLGenerator; use OCP\IUser; use OCP\IUserManager; class Users implements IProvider { /** @var IL10N */ protected $l; /** @var IURLGenerator */ protected $url; /** @var IManager */ protected $activityManager; /** @var IUserManager */ protected $userManager; /** @var array */ protected $displayNames = []; const SUBJECT_SHARED_USER_SELF = 'shared_user_self'; const SUBJECT_RESHARED_USER_BY = 'reshared_user_by'; const SUBJECT_UNSHARED_USER_SELF = 'unshared_user_self'; const SUBJECT_UNSHARED_USER_BY = 'unshared_user_by'; const SUBJECT_SHARED_WITH_BY = 'shared_with_by'; const SUBJECT_UNSHARED_BY = 'unshared_by'; /** * @param IL10N $l * @param IURLGenerator $url * @param IManager $activityManager * @param IUserManager $userManager */ public function __construct(IL10N $l, IURLGenerator $url, IManager $activityManager, IUserManager $userManager) { $this->l = $l; $this->url = $url; $this->activityManager = $activityManager; $this->userManager = $userManager; } /** * @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() !== 'files_sharing') { throw new \InvalidArgumentException(); } if ($this->activityManager->isFormattingFilteredObject()) { try { return $this->parseShortVersion($event); } catch (\InvalidArgumentException $e) { // Ignore and simply use the long version... } } return $this->parseLongVersion($event); } /** * @param IEvent $event * @return IEvent * @throws \InvalidArgumentException * @since 11.0.0 */ public function parseShortVersion(IEvent $event) { $parsedParameters = $this->getParsedParameters($event); if ($event->getSubject() === self::SUBJECT_SHARED_USER_SELF) { $event->setParsedSubject($this->l->t('Shared with %1$s', [$parsedParameters['user']['name']])) ->setRichSubject($this->l->t('Shared with {user}'), [ 'user' => $parsedParameters['user'], ]) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else if ($event->getSubject() === self::SUBJECT_UNSHARED_USER_SELF) { $event->setParsedSubject($this->l->t('Removed share for %1$s', [$parsedParameters['user']['name']])) ->setRichSubject($this->l->t('Removed share for {user}'), [ 'user' => $parsedParameters['user'], ]) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else if ($event->getSubject() === self::SUBJECT_RESHARED_USER_BY) { $event->setParsedSubject($this->l->t('%2$s shared with %1$s by', [ $parsedParameters['user']['name'], $parsedParameters['actor']['name'], ])) ->setRichSubject($this->l->t('{actor} shared with {user}'), [ 'user' => $parsedParameters['user'], 'actor' => $parsedParameters['actor'], ]) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else if ($event->getSubject() === self::SUBJECT_UNSHARED_USER_BY) { $event->setParsedSubject($this->l->t('%2$s removed share for %1$s', [ $parsedParameters['user']['name'], $parsedParameters['actor']['name'], ])) ->setRichSubject($this->l->t('{actor} removed share for {user}'), [ 'user' => $parsedParameters['user'], 'actor' => $parsedParameters['actor'], ]) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else if ($event->getSubject() === self::SUBJECT_SHARED_WITH_BY) { $event->setParsedSubject($this->l->t('Shared by %1$s', [$parsedParameters['actor']['name']])) ->setRichSubject($this->l->t('Shared by {actor}'), [ 'actor' => $parsedParameters['actor'], ]) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else if ($event->getSubject() === self::SUBJECT_UNSHARED_BY) { $event->setParsedSubject($this->l->t('%1$s removed share', [$parsedParameters['actor']['name']])) ->setRichSubject($this->l->t('{actor} removed share'), [ 'actor' => $parsedParameters['actor'], ]) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else { throw new \InvalidArgumentException(); } return $event; } /** * @param IEvent $event * @return IEvent * @throws \InvalidArgumentException * @since 11.0.0 */ public function parseLongVersion(IEvent $event) { $parsedParameters = $this->getParsedParameters($event); if ($event->getSubject() === self::SUBJECT_SHARED_USER_SELF) { $event->setParsedSubject($this->l->t('You shared %1$s with %2$s', [ $parsedParameters['file']['path'], $parsedParameters['user']['name'], ])) ->setRichSubject($this->l->t('You shared {file} with {user}'), $parsedParameters) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else if ($event->getSubject() === self::SUBJECT_UNSHARED_USER_SELF) { $event->setParsedSubject($this->l->t('You removed %2$s from %1$s', [ $parsedParameters['file']['path'], $parsedParameters['user']['name'], ])) ->setRichSubject($this->l->t('You removed {user} from {file}'), $parsedParameters) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else if ($event->getSubject() === self::SUBJECT_RESHARED_USER_BY) { $event->setParsedSubject($this->l->t('%3$s shared %1$s with %2$s', [ $parsedParameters['file']['path'], $parsedParameters['user']['name'], $parsedParameters['actor']['name'], ])) ->setRichSubject($this->l->t('{actor} removed {user} from {file}'), $parsedParameters) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else if ($event->getSubject() === self::SUBJECT_UNSHARED_USER_BY) { $event->setParsedSubject($this->l->t('%3$s removed %2$s from %1$s', [ $parsedParameters['file']['path'], $parsedParameters['user']['name'], $parsedParameters['actor']['name'], ])) ->setRichSubject($this->l->t('{actor} removed {user} from {file}'), $parsedParameters) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else if ($event->getSubject() === self::SUBJECT_SHARED_WITH_BY) { $event->setParsedSubject($this->l->t('%2$s shared %1$s with you', [ $parsedParameters['file']['path'], $parsedParameters['actor']['name'], ])) ->setRichSubject($this->l->t('{actor} shared {file} with you'), $parsedParameters) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else if ($event->getSubject() === self::SUBJECT_UNSHARED_BY) { $event->setParsedSubject($this->l->t('%2$s removed you from %1$s', [ $parsedParameters['file']['path'], $parsedParameters['actor']['name'], ])) ->setRichSubject($this->l->t('{actor} removed you from {file}'), $parsedParameters) ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg'))); } else { throw new \InvalidArgumentException(); } return $event; } protected function getParsedParameters(IEvent $event) { $subject = $event->getSubject(); $parameters = $event->getSubjectParameters(); switch ($subject) { case self::SUBJECT_SHARED_USER_SELF: case self::SUBJECT_UNSHARED_USER_SELF: $id = key($parameters[0]); return [ 'file' => $this->generateFileParameter($id, $parameters[0][$id]), 'user' => $this->generateUserParameter($parameters[1]), ]; case self::SUBJECT_SHARED_WITH_BY: case self::SUBJECT_UNSHARED_BY: $id = key($parameters[0]); return [ 'file' => $this->generateFileParameter($id, $parameters[0][$id]), 'actor' => $this->generateUserParameter($parameters[1]), ]; case self::SUBJECT_RESHARED_USER_BY: case self::SUBJECT_UNSHARED_USER_BY: $id = key($parameters[0]); return [ 'file' => $this->generateFileParameter($id, $parameters[0][$id]), 'user' => $this->generateUserParameter($parameters[2]), 'actor' => $this->generateUserParameter($parameters[1]), ]; } return []; } /** * @param int $id * @param string $path * @return array */ protected function generateFileParameter($id, $path) { return [ 'type' => 'file', 'id' => $id, 'name' => basename($path), 'path' => $path, 'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]), ]; } /** * @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; } } }