nextcloud/lib/private/Activity/Manager.php

727 lines
18 KiB
PHP
Raw Normal View History

<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
2016-07-21 18:07:57 +03:00
*
2016-05-26 20:56:05 +03:00
* @author Björn Schießle <bjoern@schiessle.org>
2016-07-21 18:07:57 +03:00
* @author Joas Schilling <coding@schilljs.com>
2015-03-26 13:44:34 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @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 <http://www.gnu.org/licenses/>
*
*/
2016-05-02 12:57:24 +03:00
namespace OC\Activity;
use OCP\Activity\IConsumer;
use OCP\Activity\IEvent;
use OCP\Activity\IExtension;
use OCP\Activity\IFilter;
2013-10-09 20:06:21 +04:00
use OCP\Activity\IManager;
use OCP\Activity\IProvider;
use OCP\Activity\ISetting;
use OCP\IConfig;
use OCP\IRequest;
use OCP\IUser;
use OCP\IUserSession;
use OCP\RichObjectStrings\IValidator;
2016-05-02 12:57:24 +03:00
class Manager implements IManager {
/** @var IRequest */
protected $request;
/** @var IUserSession */
protected $session;
/** @var IConfig */
protected $config;
/** @var IValidator */
protected $validator;
/** @var string */
protected $formattingObjectType;
/** @var int */
protected $formattingObjectId;
/** @var bool */
protected $requirePNG;
/** @var string */
protected $currentUserId;
/**
* constructor of the controller
*
* @param IRequest $request
* @param IUserSession $session
* @param IConfig $config
* @param IValidator $validator
*/
public function __construct(IRequest $request,
IUserSession $session,
IConfig $config,
IValidator $validator) {
$this->request = $request;
$this->session = $session;
$this->config = $config;
$this->validator = $validator;
}
/** @var \Closure[] */
private $consumersClosures = array();
/** @var IConsumer[] */
private $consumers = array();
/** @var \Closure[] */
private $extensionsClosures = array();
/** @var IExtension[] */
private $extensions = array();
2015-01-23 17:37:15 +03:00
/** @var array list of filters "name" => "is valid" */
protected $validFilters = array(
'all' => true,
'by' => true,
'self' => true,
);
2015-01-23 17:37:15 +03:00
/** @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;
}
/**
* Generates a new IEvent object
*
* Make sure to call at least the following methods before sending it to the
* app with via the publish() method:
* - setApp()
* - setType()
* - setAffectedUser()
* - setSubject()
*
* @return IEvent
*/
public function generateEvent() {
return new Event($this->validator);
}
/**
* Publish an event to the activity consumers
*
* Make sure to call at least the following methods before sending an Event:
* - setApp()
* - setType()
* - setAffectedUser()
* - setSubject()
*
* @param IEvent $event
* @throws \BadMethodCallException if required values have not been set
*/
public function publish(IEvent $event) {
if ($event->getAuthor() === '') {
if ($this->session->getUser() instanceof IUser) {
$event->setAuthor($this->session->getUser()->getUID());
}
}
if (!$event->getTimestamp()) {
$event->setTimestamp(time());
}
if (!$event->isValid()) {
throw new \BadMethodCallException('The given event is invalid');
}
foreach ($this->getConsumers() as $c) {
$c->receive($event);
}
}
/**
* @param string $app The app where this event is associated with
* @param string $subject A short description of the event
* @param array $subjectParams Array with parameters that are filled in the subject
* @param string $message A longer description of the event
* @param array $messageParams Array with parameters that are filled in the message
* @param string $file The file including path where this event is associated with
* @param string $link A link where this event is associated with
* @param string $affectedUser Recipient of the activity
* @param string $type Type of the notification
* @param int $priority Priority of the notification
*/
public function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority) {
$event = $this->generateEvent();
$event->setApp($app)
->setType($type)
->setAffectedUser($affectedUser)
->setSubject($subject, $subjectParams)
->setMessage($message, $messageParams)
->setObject('', 0, $file)
->setLink($link);
$this->publish($event);
}
/**
* 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
*/
public function registerConsumer(\Closure $callable) {
array_push($this->consumersClosures, $callable);
$this->consumers = [];
}
2013-10-09 20:06:21 +04:00
/**
* 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\IExtension
*
* @param \Closure $callable
*/
public function registerExtension(\Closure $callable) {
array_push($this->extensionsClosures, $callable);
$this->extensions = [];
}
/** @var string[] */
protected $filterClasses = [];
/** @var IFilter[] */
protected $filters = [];
/** @var bool */
protected $loadedLegacyFilters = false;
/**
* @param string $filter Class must implement OCA\Activity\IFilter
* @return void
*/
public function registerFilter($filter) {
$this->filterClasses[$filter] = false;
}
/**
* @return IFilter[]
* @throws \InvalidArgumentException
*/
public function getFilters() {
if (!$this->loadedLegacyFilters) {
$legacyFilters = $this->getNavigation();
foreach ($legacyFilters['top'] as $filter => $data) {
$this->filters[$filter] = new LegacyFilter(
$this, $filter, $data['name'], true
);
}
foreach ($legacyFilters['apps'] as $filter => $data) {
$this->filters[$filter] = new LegacyFilter(
$this, $filter, $data['name'], false
);
}
$this->loadedLegacyFilters = true;
}
foreach ($this->filterClasses as $class => $false) {
/** @var IFilter $filter */
$filter = \OC::$server->query($class);
if (!$filter instanceof IFilter) {
throw new \InvalidArgumentException('Invalid activity filter registered');
}
$this->filters[$filter->getIdentifier()] = $filter;
unset($this->filterClasses[$class]);
}
return $this->filters;
}
/**
* @param string $id
* @return IFilter
* @throws \InvalidArgumentException when the filter was not found
* @since 11.0.0
*/
public function getFilterById($id) {
$filters = $this->getFilters();
if (isset($filters[$id])) {
return $filters[$id];
}
throw new \InvalidArgumentException('Requested filter does not exist');
}
/** @var string[] */
protected $providerClasses = [];
/** @var IProvider[] */
protected $providers = [];
/**
* @param string $provider Class must implement OCA\Activity\IProvider
* @return void
*/
public function registerProvider($provider) {
$this->providerClasses[$provider] = false;
}
/**
* @return IProvider[]
* @throws \InvalidArgumentException
*/
public function getProviders() {
foreach ($this->providerClasses as $class => $false) {
/** @var IProvider $provider */
$provider = \OC::$server->query($class);
if (!$provider instanceof IProvider) {
throw new \InvalidArgumentException('Invalid activity provider registered');
}
$this->providers[] = $provider;
unset($this->providerClasses[$class]);
}
return $this->providers;
}
/** @var string[] */
protected $settingsClasses = [];
/** @var ISetting[] */
protected $settings = [];
/** @var bool */
protected $loadedLegacyTypes = false;
/**
* @param string $setting Class must implement OCA\Activity\ISetting
* @return void
*/
public function registerSetting($setting) {
$this->settingsClasses[$setting] = false;
}
/**
* @return ISetting[]
* @throws \InvalidArgumentException
*/
public function getSettings() {
if (!$this->loadedLegacyTypes) {
$l = \OC::$server->getL10N('core');
$legacyTypes = $this->getNotificationTypes($l->getLanguageCode());
$streamTypes = $this->getDefaultTypes(IExtension::METHOD_STREAM);
$mailTypes = $this->getDefaultTypes(IExtension::METHOD_MAIL);
foreach ($legacyTypes as $type => $data) {
if (is_string($data)) {
$desc = $data;
$canChangeStream = true;
$canChangeMail = true;
} else {
$desc = $data['desc'];
$canChangeStream = in_array(IExtension::METHOD_STREAM, $data['methods']);
$canChangeMail = in_array(IExtension::METHOD_MAIL, $data['methods']);
}
$this->settings[$type] = new LegacySetting(
$type, $desc,
$canChangeStream, in_array($type, $streamTypes),
$canChangeMail, in_array($type, $mailTypes)
);
}
$this->loadedLegacyTypes = true;
}
foreach ($this->settingsClasses as $class => $false) {
/** @var ISetting $setting */
$setting = \OC::$server->query($class);
if (!$setting instanceof ISetting) {
throw new \InvalidArgumentException('Invalid activity filter registered');
}
$this->settings[$setting->getIdentifier()] = $setting;
unset($this->settingsClasses[$class]);
}
return $this->settings;
}
/**
* @param string $id
* @return ISetting
* @throws \InvalidArgumentException when the setting was not found
* @since 11.0.0
*/
public function getSettingById($id) {
$settings = $this->getSettings();
if (isset($settings[$id])) {
return $settings[$id];
}
throw new \InvalidArgumentException('Requested setting does not exist');
}
/**
* @param string $type
* @return string
*/
public 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 $type
* @param string $id
*/
public function setFormattingObject($type, $id) {
$this->formattingObjectType = $type;
$this->formattingObjectId = (string) $id;
}
/**
* @return bool
*/
public function isFormattingFilteredObject() {
return $this->formattingObjectType !== null && $this->formattingObjectId !== null
&& $this->formattingObjectType === $this->request->getParam('object_type')
&& $this->formattingObjectId === $this->request->getParam('object_id');
}
/**
* @param bool $status Set to true, when parsing events should not use SVG icons
*/
public function setRequirePNG($status) {
$this->requirePNG = $status;
}
/**
* @return bool
*/
public function getRequirePNG() {
return $this->requirePNG;
}
/**
* @param string $app
* @param string $text
* @param array $params
* @param boolean $stripPath
* @param boolean $highlightParams
* @param string $languageCode
* @return string|false
*/
public 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
*/
public function getSpecialParameterList($app, $text) {
2015-01-23 17:37:15 +03:00
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;
}
}
2015-01-23 17:37:15 +03:00
$this->specialParameters[$app][$text] = false;
return false;
}
/**
* @param array $activity
* @return integer|false
*/
public function getGroupParameter($activity) {
foreach ($this->getExtensions() as $c) {
$parameter = $c->getGroupParameter($activity);
if ($parameter !== false) {
return $parameter;
}
}
return false;
}
/**
* Set the user we need to use
*
* @param string|null $currentUserId
* @throws \UnexpectedValueException If the user is invalid
*/
public function setCurrentUserId($currentUserId) {
if (!is_string($currentUserId) && $currentUserId !== null) {
throw new \UnexpectedValueException('The given current user is invalid');
}
$this->currentUserId = $currentUserId;
}
/**
* 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->currentUserId !== null) {
return $this->currentUserId;
} else 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);
}
/**
* @return array
* @deprecated 11.0.0 - Use getFilters() instead
*/
public 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
* @deprecated 11.0.0 - Use getFilterById() instead
*/
public function isFilterValid($filterValue) {
2015-01-23 17:37:15 +03:00
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;
}
}
2015-01-23 17:37:15 +03:00
$this->validFilters[$filterValue] = false;
return false;
}
/**
* @param array $types
* @param string $filter
* @return array
* @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead
*/
public 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
* @deprecated 11.0.0 - Use getFilterById() instead
*/
public function getQueryForFilter($filter) {
if (!$this->isFilterValid($filter)) {
return [null, null];
}
2014-11-28 13:18:15 +03:00
$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);
}
}
}
2014-11-28 13:18:15 +03:00
if (empty($conditions)) {
return array(null, null);
}
return array(' and ((' . implode(') or (', $conditions) . '))', $parameters);
}
/**
* Will return additional notification types as specified by other apps
*
* @param string $languageCode
* @return array
* @deprecated 11.0.0 - Use getSettings() instead
*/
public function getNotificationTypes($languageCode) {
$notificationTypes = $sharingNotificationTypes = [];
foreach ($this->getExtensions() as $c) {
$result = $c->getNotificationTypes($languageCode);
if (is_array($result)) {
$notificationTypes = array_merge($notificationTypes, $result);
}
}
return array_merge($sharingNotificationTypes, $notificationTypes);
}
/**
* @param string $method
* @return array
* @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead
*/
public 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;
}
}