402 lines
9.7 KiB
PHP
402 lines
9.7 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
||
|
|
* @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
|
||
|
|
*
|
||
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
||
|
|
* @author Daniel Kesselberg <mail@danielkesselberg.de>
|
||
|
|
* @author Joas Schilling <coding@schilljs.com>
|
||
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
||
|
|
* @author Robin Appelman <robin@icewind.nl>
|
||
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||
|
|
* @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/>
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace OC\Activity;
|
||
|
|
|
||
|
|
use OCP\Activity\ActivitySettings;
|
||
|
|
use OCP\Activity\IConsumer;
|
||
|
|
use OCP\Activity\IEvent;
|
||
|
|
use OCP\Activity\IFilter;
|
||
|
|
use OCP\Activity\IManager;
|
||
|
|
use OCP\Activity\IProvider;
|
||
|
|
use OCP\Activity\ISetting;
|
||
|
|
use OCP\IConfig;
|
||
|
|
use OCP\IL10N;
|
||
|
|
use OCP\IRequest;
|
||
|
|
use OCP\IUser;
|
||
|
|
use OCP\IUserSession;
|
||
|
|
use OCP\RichObjectStrings\IValidator;
|
||
|
|
|
||
|
|
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 = false;
|
||
|
|
|
||
|
|
/** @var string */
|
||
|
|
protected $currentUserId;
|
||
|
|
|
||
|
|
protected $l10n;
|
||
|
|
|
||
|
|
public function __construct(
|
||
|
|
IRequest $request,
|
||
|
|
IUserSession $session,
|
||
|
|
IConfig $config,
|
||
|
|
IValidator $validator,
|
||
|
|
IL10N $l10n
|
||
|
|
) {
|
||
|
|
$this->request = $request;
|
||
|
|
$this->session = $session;
|
||
|
|
$this->config = $config;
|
||
|
|
$this->validator = $validator;
|
||
|
|
$this->l10n = $l10n;
|
||
|
|
}
|
||
|
|
|
||
|
|
/** @var \Closure[] */
|
||
|
|
private $consumersClosures = [];
|
||
|
|
|
||
|
|
/** @var IConsumer[] */
|
||
|
|
private $consumers = [];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return \OCP\Activity\IConsumer[]
|
||
|
|
*/
|
||
|
|
protected function getConsumers(): array {
|
||
|
|
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;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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(): IEvent {
|
||
|
|
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): void {
|
||
|
|
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);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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): void {
|
||
|
|
$this->consumersClosures[] = $callable;
|
||
|
|
$this->consumers = [];
|
||
|
|
}
|
||
|
|
|
||
|
|
/** @var string[] */
|
||
|
|
protected $filterClasses = [];
|
||
|
|
|
||
|
|
/** @var IFilter[] */
|
||
|
|
protected $filters = [];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $filter Class must implement OCA\Activity\IFilter
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function registerFilter(string $filter): void {
|
||
|
|
$this->filterClasses[$filter] = false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return IFilter[]
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
*/
|
||
|
|
public function getFilters(): array {
|
||
|
|
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(string $id): IFilter {
|
||
|
|
$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(string $provider): void {
|
||
|
|
$this->providerClasses[$provider] = false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return IProvider[]
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
*/
|
||
|
|
public function getProviders(): array {
|
||
|
|
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 = [];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $setting Class must implement OCA\Activity\ISetting
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function registerSetting(string $setting): void {
|
||
|
|
$this->settingsClasses[$setting] = false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return ActivitySettings[]
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
*/
|
||
|
|
public function getSettings(): array {
|
||
|
|
foreach ($this->settingsClasses as $class => $false) {
|
||
|
|
/** @var ISetting $setting */
|
||
|
|
$setting = \OC::$server->query($class);
|
||
|
|
|
||
|
|
if ($setting instanceof ISetting) {
|
||
|
|
if (!$setting instanceof ActivitySettings) {
|
||
|
|
$setting = new ActivitySettingsAdapter($setting, $this->l10n);
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
throw new \InvalidArgumentException('Invalid activity filter registered');
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->settings[$setting->getIdentifier()] = $setting;
|
||
|
|
|
||
|
|
unset($this->settingsClasses[$class]);
|
||
|
|
}
|
||
|
|
return $this->settings;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $id
|
||
|
|
* @return ActivitySettings
|
||
|
|
* @throws \InvalidArgumentException when the setting was not found
|
||
|
|
* @since 11.0.0
|
||
|
|
*/
|
||
|
|
public function getSettingById(string $id): ActivitySettings {
|
||
|
|
$settings = $this->getSettings();
|
||
|
|
|
||
|
|
if (isset($settings[$id])) {
|
||
|
|
return $settings[$id];
|
||
|
|
}
|
||
|
|
|
||
|
|
throw new \InvalidArgumentException('Requested setting does not exist');
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $type
|
||
|
|
* @param int $id
|
||
|
|
*/
|
||
|
|
public function setFormattingObject(string $type, int $id): void {
|
||
|
|
$this->formattingObjectType = $type;
|
||
|
|
$this->formattingObjectId = $id;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function isFormattingFilteredObject(): bool {
|
||
|
|
return $this->formattingObjectType !== null && $this->formattingObjectId !== null
|
||
|
|
&& $this->formattingObjectType === $this->request->getParam('object_type')
|
||
|
|
&& $this->formattingObjectId === (int) $this->request->getParam('object_id');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param bool $status Set to true, when parsing events should not use SVG icons
|
||
|
|
*/
|
||
|
|
public function setRequirePNG(bool $status): void {
|
||
|
|
$this->requirePNG = $status;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function getRequirePNG(): bool {
|
||
|
|
return $this->requirePNG;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set the user we need to use
|
||
|
|
*
|
||
|
|
* @param string|null $currentUserId
|
||
|
|
* @throws \UnexpectedValueException If the user is invalid
|
||
|
|
*/
|
||
|
|
public function setCurrentUserId(string $currentUserId = null): void {
|
||
|
|
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(): string {
|
||
|
|
if ($this->currentUserId !== null) {
|
||
|
|
return $this->currentUserId;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$this->session->isLoggedIn()) {
|
||
|
|
return $this->getUserFromToken();
|
||
|
|
}
|
||
|
|
|
||
|
|
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(): string {
|
||
|
|
$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 (count($users) !== 1) {
|
||
|
|
// No unique user found
|
||
|
|
throw new \UnexpectedValueException('The token is invalid');
|
||
|
|
}
|
||
|
|
|
||
|
|
// Token found login as that user
|
||
|
|
return array_shift($users);
|
||
|
|
}
|
||
|
|
}
|