* @author Joas Schilling * @author Lukas Reschke * @author Thomas Müller * * @copyright Copyright (c) 2015, 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 OC; use OCP\Activity\IConsumer; use OCP\Activity\IExtension; use OCP\Activity\IManager; use OCP\IConfig; use OCP\IRequest; use OCP\IUserSession; class ActivityManager implements IManager { /** @var IRequest */ protected $request; /** @var IUserSession */ protected $session; /** @var IConfig */ protected $config; /** * constructor of the controller * * @param IRequest $request * @param IUserSession $session * @param IConfig $config */ public function __construct(IRequest $request, IUserSession $session, IConfig $config) { $this->request = $request; $this->session = $session; $this->config = $config; } /** @var \Closure[] */ private $consumersClosures = array(); /** @var IConsumer[] */ private $consumers = array(); /** @var \Closure[] */ private $extensionsClosures = array(); /** @var IExtension[] */ private $extensions = array(); /** @var array list of filters "name" => "is valid" */ protected $validFilters = array( 'all' => true, 'by' => true, 'self' => true, ); /** @var array list of type icons "type" => "css class" */ protected $typeIcons = array(); /** @var array list of special parameters "app" => ["text" => ["parameter" => "type"]] */ protected $specialParameters = array(); /** * @return \OCP\Activity\IConsumer[] */ protected function getConsumers() { if (!empty($this->consumers)) { return $this->consumers; } $this->consumers = []; foreach($this->consumersClosures as $consumer) { $c = $consumer(); if ($c instanceof IConsumer) { $this->consumers[] = $c; } else { throw new \InvalidArgumentException('The given consumer does not implement the \OCP\Activity\IConsumer interface'); } } return $this->consumers; } /** * @return \OCP\Activity\IExtension[] */ protected function getExtensions() { if (!empty($this->extensions)) { return $this->extensions; } $this->extensions = []; foreach($this->extensionsClosures as $extension) { $e = $extension(); if ($e instanceof IExtension) { $this->extensions[] = $e; } else { throw new \InvalidArgumentException('The given extension does not implement the \OCP\Activity\IExtension interface'); } } return $this->extensions; } /** * @param $app * @param $subject * @param $subjectParams * @param $message * @param $messageParams * @param $file * @param $link * @param $affectedUser * @param $type * @param $priority * @return mixed */ function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority) { foreach($this->getConsumers() as $c) { try { $c->receive( $app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority); } catch (\Exception $ex) { // TODO: log the exception } } } /** * In order to improve lazy loading a closure can be registered which will be called in case * activity consumers are actually requested * * $callable has to return an instance of OCA\Activity\IConsumer * * @param \Closure $callable */ function registerConsumer(\Closure $callable) { array_push($this->consumersClosures, $callable); $this->consumers = []; } /** * In order to improve lazy loading a closure can be registered which will be called in case * activity consumers are actually requested * * $callable has to return an instance of OCA\Activity\IConsumer * * @param \Closure $callable * @return void */ function registerExtension(\Closure $callable) { array_push($this->extensionsClosures, $callable); $this->extensions = []; } /** * Will return additional notification types as specified by other apps * * @param string $languageCode * @return array */ function getNotificationTypes($languageCode) { $notificationTypes = array(); foreach ($this->getExtensions() as $c) { $result = $c->getNotificationTypes($languageCode); if (is_array($result)) { $notificationTypes = array_merge($notificationTypes, $result); } } return $notificationTypes; } /** * @param string $method * @return array */ function getDefaultTypes($method) { $defaultTypes = array(); foreach ($this->getExtensions() as $c) { $types = $c->getDefaultTypes($method); if (is_array($types)) { $defaultTypes = array_merge($types, $defaultTypes); } } return $defaultTypes; } /** * @param string $type * @return string */ function getTypeIcon($type) { if (isset($this->typeIcons[$type])) { return $this->typeIcons[$type]; } foreach ($this->getExtensions() as $c) { $icon = $c->getTypeIcon($type); if (is_string($icon)) { $this->typeIcons[$type] = $icon; return $icon; } } $this->typeIcons[$type] = ''; return ''; } /** * @param string $app * @param string $text * @param array $params * @param boolean $stripPath * @param boolean $highlightParams * @param string $languageCode * @return string|false */ function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) { foreach ($this->getExtensions() as $c) { $translation = $c->translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); if (is_string($translation)) { return $translation; } } return false; } /** * @param string $app * @param string $text * @return array|false */ function getSpecialParameterList($app, $text) { if (isset($this->specialParameters[$app][$text])) { return $this->specialParameters[$app][$text]; } if (!isset($this->specialParameters[$app])) { $this->specialParameters[$app] = array(); } foreach ($this->getExtensions() as $c) { $specialParameter = $c->getSpecialParameterList($app, $text); if (is_array($specialParameter)) { $this->specialParameters[$app][$text] = $specialParameter; return $specialParameter; } } $this->specialParameters[$app][$text] = false; return false; } /** * @param array $activity * @return integer|false */ function getGroupParameter($activity) { foreach ($this->getExtensions() as $c) { $parameter = $c->getGroupParameter($activity); if ($parameter !== false) { return $parameter; } } return false; } /** * @return array */ function getNavigation() { $entries = array( 'apps' => array(), 'top' => array(), ); foreach ($this->getExtensions() as $c) { $additionalEntries = $c->getNavigation(); if (is_array($additionalEntries)) { $entries['apps'] = array_merge($entries['apps'], $additionalEntries['apps']); $entries['top'] = array_merge($entries['top'], $additionalEntries['top']); } } return $entries; } /** * @param string $filterValue * @return boolean */ function isFilterValid($filterValue) { if (isset($this->validFilters[$filterValue])) { return $this->validFilters[$filterValue]; } foreach ($this->getExtensions() as $c) { if ($c->isFilterValid($filterValue) === true) { $this->validFilters[$filterValue] = true; return true; } } $this->validFilters[$filterValue] = false; return false; } /** * @param array $types * @param string $filter * @return array */ function filterNotificationTypes($types, $filter) { if (!$this->isFilterValid($filter)) { return $types; } foreach ($this->getExtensions() as $c) { $result = $c->filterNotificationTypes($types, $filter); if (is_array($result)) { $types = $result; } } return $types; } /** * @param string $filter * @return array */ function getQueryForFilter($filter) { if (!$this->isFilterValid($filter)) { return [null, null]; } $conditions = array(); $parameters = array(); foreach ($this->getExtensions() as $c) { $result = $c->getQueryForFilter($filter); if (is_array($result)) { list($condition, $parameter) = $result; if ($condition && is_array($parameter)) { $conditions[] = $condition; $parameters = array_merge($parameters, $parameter); } } } if (empty($conditions)) { return array(null, null); } return array(' and ((' . implode(') or (', $conditions) . '))', $parameters); } /** * Get the user we need to use * * Either the user is logged in, or we try to get it from the token * * @return string * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique */ public function getCurrentUserId() { if (!$this->session->isLoggedIn()) { return $this->getUserFromToken(); } else { return $this->session->getUser()->getUID(); } } /** * Get the user for the token * * @return string * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique */ protected function getUserFromToken() { $token = (string) $this->request->getParam('token', ''); if (strlen($token) !== 30) { throw new \UnexpectedValueException('The token is invalid'); } $users = $this->config->getUsersForUserValue('activity', 'rsstoken', $token); if (sizeof($users) !== 1) { // No unique user found throw new \UnexpectedValueException('The token is invalid'); } // Token found login as that user return array_shift($users); } }