nextcloud / server

lib/private/Activity/Manager.php

Indentation +659 added lines, -659 removed lines

@@ -40,663 +40,663 @@
 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;
-
-	/** @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();
-
-	/** @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;
-	}
-
-	/**
-	 * 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);
-		}
-	}
-
-	/**
-	 * 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) {
-		$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\IExtension
-	 *
-	 * @param \Closure $callable
-	 */
-	public function registerExtension(\Closure $callable) {
-		$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) {
-		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
-	 */
-	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 (count($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) {
-		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
-	 * @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];
-		}
-
-		$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);
-	}
-
-	/**
-	 * 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;
-	}
+    /** @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();
+
+    /** @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;
+    }
+
+    /**
+     * 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);
+        }
+    }
+
+    /**
+     * 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) {
+        $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\IExtension
+     *
+     * @param \Closure $callable
+     */
+    public function registerExtension(\Closure $callable) {
+        $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) {
+        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
+     */
+    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 (count($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) {
+        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
+     * @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];
+        }
+
+        $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);
+    }
+
+    /**
+     * 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;
+    }
 }

lib/public/Activity/IManager.php

Indentation +214 added lines, -214 removed lines

@@ -40,246 +40,246 @@
  * @since 6.0.0
  */
 interface IManager {
-	/**
-	 * 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
-	 * @since 8.2.0
-	 */
-	public function generateEvent();
+    /**
+     * 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
+     * @since 8.2.0
+     */
+    public function generateEvent();
 
-	/**
-	 * 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
-	 * @since 8.2.0
-	 */
-	public function publish(IEvent $event);
+    /**
+     * 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
+     * @since 8.2.0
+     */
+    public function publish(IEvent $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 \OCP\Activity\IConsumer
-	 *
-	 * @param \Closure $callable
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function registerConsumer(\Closure $callable);
+    /**
+     * 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 \OCP\Activity\IConsumer
+     *
+     * @param \Closure $callable
+     * @return void
+     * @since 6.0.0
+     */
+    public function registerConsumer(\Closure $callable);
 
-	/**
-	 * 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 \OCP\Activity\IExtension
-	 *
-	 * @param \Closure $callable
-	 * @return void
-	 * @since 8.0.0
-	 */
-	public function registerExtension(\Closure $callable);
+    /**
+     * 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 \OCP\Activity\IExtension
+     *
+     * @param \Closure $callable
+     * @return void
+     * @since 8.0.0
+     */
+    public function registerExtension(\Closure $callable);
 
-	/**
-	 * @param string $filter Class must implement OCA\Activity\IFilter
-	 * @return void
-	 * @since 11.0.0
-	 */
-	public function registerFilter($filter);
+    /**
+     * @param string $filter Class must implement OCA\Activity\IFilter
+     * @return void
+     * @since 11.0.0
+     */
+    public function registerFilter($filter);
 
-	/**
-	 * @return IFilter[]
-	 * @since 11.0.0
-	 */
-	public function getFilters();
+    /**
+     * @return IFilter[]
+     * @since 11.0.0
+     */
+    public function getFilters();
 
-	/**
-	 * @param string $id
-	 * @return IFilter
-	 * @throws \InvalidArgumentException when the filter was not found
-	 * @since 11.0.0
-	 */
-	public function getFilterById($id);
+    /**
+     * @param string $id
+     * @return IFilter
+     * @throws \InvalidArgumentException when the filter was not found
+     * @since 11.0.0
+     */
+    public function getFilterById($id);
 
-	/**
-	 * @param string $setting Class must implement OCA\Activity\ISetting
-	 * @return void
-	 * @since 11.0.0
-	 */
-	public function registerSetting($setting);
+    /**
+     * @param string $setting Class must implement OCA\Activity\ISetting
+     * @return void
+     * @since 11.0.0
+     */
+    public function registerSetting($setting);
 
-	/**
-	 * @return ISetting[]
-	 * @since 11.0.0
-	 */
-	public function getSettings();
+    /**
+     * @return ISetting[]
+     * @since 11.0.0
+     */
+    public function getSettings();
 
-	/**
-	 * @param string $provider Class must implement OCA\Activity\IProvider
-	 * @return void
-	 * @since 11.0.0
-	 */
-	public function registerProvider($provider);
+    /**
+     * @param string $provider Class must implement OCA\Activity\IProvider
+     * @return void
+     * @since 11.0.0
+     */
+    public function registerProvider($provider);
 
-	/**
-	 * @return IProvider[]
-	 * @since 11.0.0
-	 */
-	public function getProviders();
+    /**
+     * @return IProvider[]
+     * @since 11.0.0
+     */
+    public function getProviders();
 
-	/**
-	 * @param string $id
-	 * @return ISetting
-	 * @throws \InvalidArgumentException when the setting was not found
-	 * @since 11.0.0
-	 */
-	public function getSettingById($id);
+    /**
+     * @param string $id
+     * @return ISetting
+     * @throws \InvalidArgumentException when the setting was not found
+     * @since 11.0.0
+     */
+    public function getSettingById($id);
 
-	/**
-	 * Will return additional notification types as specified by other apps
-	 *
-	 * @param string $languageCode
-	 * @return array Array "stringID of the type" => "translated string description for the setting"
-	 * 				or Array "stringID of the type" => [
-	 * 					'desc' => "translated string description for the setting"
-	 * 					'methods' => [\OCP\Activity\IExtension::METHOD_*],
-	 * 				]
-	 * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
-	 * @deprecated 11.0.0 - Use getSettings() instead
-	 */
-	public function getNotificationTypes($languageCode);
+    /**
+     * Will return additional notification types as specified by other apps
+     *
+     * @param string $languageCode
+     * @return array Array "stringID of the type" => "translated string description for the setting"
+     * 				or Array "stringID of the type" => [
+     * 					'desc' => "translated string description for the setting"
+     * 					'methods' => [\OCP\Activity\IExtension::METHOD_*],
+     * 				]
+     * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
+     * @deprecated 11.0.0 - Use getSettings() instead
+     */
+    public function getNotificationTypes($languageCode);
 
-	/**
-	 * @param string $method
-	 * @return array
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead
-	 */
-	public function getDefaultTypes($method);
+    /**
+     * @param string $method
+     * @return array
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead
+     */
+    public function getDefaultTypes($method);
 
-	/**
-	 * @param string $type
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getTypeIcon($type);
+    /**
+     * @param string $type
+     * @return string
+     * @since 8.0.0
+     */
+    public function getTypeIcon($type);
 
-	/**
-	 * @param string $type
-	 * @param int $id
-	 * @since 8.2.0
-	 */
-	public function setFormattingObject($type, $id);
+    /**
+     * @param string $type
+     * @param int $id
+     * @since 8.2.0
+     */
+    public function setFormattingObject($type, $id);
 
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isFormattingFilteredObject();
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isFormattingFilteredObject();
 
-	/**
-	 * @param bool $status Set to true, when parsing events should not use SVG icons
-	 * @since 12.0.1
-	 */
-	public function setRequirePNG($status);
+    /**
+     * @param bool $status Set to true, when parsing events should not use SVG icons
+     * @since 12.0.1
+     */
+    public function setRequirePNG($status);
 
-	/**
-	 * @return bool
-	 * @since 12.0.1
-	 */
-	public function getRequirePNG();
+    /**
+     * @return bool
+     * @since 12.0.1
+     */
+    public function getRequirePNG();
 
-	/**
-	 * @param string $app
-	 * @param string $text
-	 * @param array $params
-	 * @param boolean $stripPath
-	 * @param boolean $highlightParams
-	 * @param string $languageCode
-	 * @return string|false
-	 * @since 8.0.0
-	 */
-	public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
+    /**
+     * @param string $app
+     * @param string $text
+     * @param array $params
+     * @param boolean $stripPath
+     * @param boolean $highlightParams
+     * @param string $languageCode
+     * @return string|false
+     * @since 8.0.0
+     */
+    public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
 
-	/**
-	 * @param string $app
-	 * @param string $text
-	 * @return array|false
-	 * @since 8.0.0
-	 */
-	public function getSpecialParameterList($app, $text);
+    /**
+     * @param string $app
+     * @param string $text
+     * @return array|false
+     * @since 8.0.0
+     */
+    public function getSpecialParameterList($app, $text);
 
-	/**
-	 * @param array $activity
-	 * @return integer|false
-	 * @since 8.0.0
-	 */
-	public function getGroupParameter($activity);
+    /**
+     * @param array $activity
+     * @return integer|false
+     * @since 8.0.0
+     */
+    public function getGroupParameter($activity);
 
 
-	/**
-	 * Set the user we need to use
-	 *
-	 * @param string|null $currentUserId
-	 * @throws \UnexpectedValueException If the user is invalid
-	 * @since 9.0.1
-	 */
-	public function setCurrentUserId($currentUserId);
+    /**
+     * Set the user we need to use
+     *
+     * @param string|null $currentUserId
+     * @throws \UnexpectedValueException If the user is invalid
+     * @since 9.0.1
+     */
+    public function setCurrentUserId($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
-	 * @since 8.1.0
-	 */
-	public function getCurrentUserId();
+    /**
+     * 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
+     * @since 8.1.0
+     */
+    public function getCurrentUserId();
 
-	/**
-	 * @return array
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Use getFilters() instead
-	 */
-	public function getNavigation();
+    /**
+     * @return array
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Use getFilters() instead
+     */
+    public function getNavigation();
 
-	/**
-	 * @param string $filterValue
-	 * @return boolean
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Use getFilterById() instead
-	 */
-	public function isFilterValid($filterValue);
+    /**
+     * @param string $filterValue
+     * @return boolean
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Use getFilterById() instead
+     */
+    public function isFilterValid($filterValue);
 
-	/**
-	 * @param array $types
-	 * @param string $filter
-	 * @return array
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead
-	 */
-	public function filterNotificationTypes($types, $filter);
+    /**
+     * @param array $types
+     * @param string $filter
+     * @return array
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead
+     */
+    public function filterNotificationTypes($types, $filter);
 
-	/**
-	 * @param string $filter
-	 * @return array
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Use getFilterById() instead
-	 */
-	public function getQueryForFilter($filter);
+    /**
+     * @param string $filter
+     * @return array
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Use getFilterById() instead
+     */
+    public function getQueryForFilter($filter);
 }