nextcloud / server

lib/private/AppFramework/App.php

Indentation +172 added lines, -172 removed lines

@@ -48,181 +48,181 @@
  */
 class App {
 
-	/** @var string[] */
-	private static $nameSpaceCache = [];
-
-	/**
-	 * Turns an app id into a namespace by either reading the appinfo.xml's
-	 * namespace tag or uppercasing the appid's first letter
-	 * @param string $appId the app id
-	 * @param string $topNamespace the namespace which should be prepended to
-	 * the transformed app id, defaults to OCA\
-	 * @return string the starting namespace for the app
-	 */
-	public static function buildAppNamespace(string $appId, string $topNamespace='OCA\\'): string {
-		// Hit the cache!
-		if (isset(self::$nameSpaceCache[$appId])) {
-			return $topNamespace . self::$nameSpaceCache[$appId];
-		}
-
-		$appInfo = \OC_App::getAppInfo($appId);
-		if (isset($appInfo['namespace'])) {
-			self::$nameSpaceCache[$appId] = trim($appInfo['namespace']);
-		} else {
-			if ($appId !== 'spreed') {
-				// if the tag is not found, fall back to uppercasing the first letter
-				self::$nameSpaceCache[$appId] = ucfirst($appId);
-			} else {
-				// For the Talk app (appid spreed) the above fallback doesn't work.
-				// This leads to a problem when trying to install it freshly,
-				// because the apps namespace is already registered before the
-				// app is downloaded from the appstore, because of the hackish
-				// global route index.php/call/{token} which is registered via
-				// the core/routes.php so it does not have the app namespace.
-				// @ref https://github.com/nextcloud/server/pull/19433
-				self::$nameSpaceCache[$appId] = 'Talk';
-			}
-		}
-
-		return $topNamespace . self::$nameSpaceCache[$appId];
-	}
-
-	public static function getAppIdForClass(string $className, string $topNamespace='OCA\\'): ?string {
-		if (strpos($className, $topNamespace) !== 0) {
-			return null;
-		}
-
-		foreach (self::$nameSpaceCache as $appId => $namespace) {
-			if (strpos($className, $topNamespace . $namespace . '\\') === 0) {
-				return $appId;
-			}
-		}
-
-		return null;
-	}
-
-
-	/**
-	 * Shortcut for calling a controller method and printing the result
-	 * @param string $controllerName the name of the controller under which it is
-	 *                               stored in the DI container
-	 * @param string $methodName the method that you want to call
-	 * @param DIContainer $container an instance of a pimple container.
-	 * @param array $urlParams list of URL parameters (optional)
-	 * @throws HintException
-	 */
-	public static function main(string $controllerName, string $methodName, DIContainer $container, array $urlParams = null) {
-		if (!is_null($urlParams)) {
-			$container->query(IRequest::class)->setUrlParameters($urlParams);
-		} elseif (isset($container['urlParams']) && !is_null($container['urlParams'])) {
-			$container->query(IRequest::class)->setUrlParameters($container['urlParams']);
-		}
-		$appName = $container['AppName'];
-
-		// first try $controllerName then go for \OCA\AppName\Controller\$controllerName
-		try {
-			$controller = $container->query($controllerName);
-		} catch (QueryException $e) {
-			if (strpos($controllerName, '\\Controller\\') !== false) {
-				// This is from a global registered app route that is not enabled.
-				[/*OC(A)*/, $app, /* Controller/Name*/] = explode('\\', $controllerName, 3);
-				throw new HintException('App ' . strtolower($app) . ' is not enabled');
-			}
-
-			if ($appName === 'core') {
-				$appNameSpace = 'OC\\Core';
-			} else {
-				$appNameSpace = self::buildAppNamespace($appName);
-			}
-			$controllerName = $appNameSpace . '\\Controller\\' . $controllerName;
-			$controller = $container->query($controllerName);
-		}
-
-		// initialize the dispatcher and run all the middleware before the controller
-		/** @var Dispatcher $dispatcher */
-		$dispatcher = $container['Dispatcher'];
-
-		list(
-			$httpHeaders,
-			$responseHeaders,
-			$responseCookies,
-			$output,
-			$response
-		) = $dispatcher->dispatch($controller, $methodName);
-
-		$io = $container[IOutput::class];
-
-		if (!is_null($httpHeaders)) {
-			$io->setHeader($httpHeaders);
-		}
-
-		foreach ($responseHeaders as $name => $value) {
-			$io->setHeader($name . ': ' . $value);
-		}
-
-		foreach ($responseCookies as $name => $value) {
-			$expireDate = null;
-			if ($value['expireDate'] instanceof \DateTime) {
-				$expireDate = $value['expireDate']->getTimestamp();
-			}
-			$sameSite = $value['sameSite'] ?? 'Lax';
-
-			$io->setCookie(
-				$name,
-				$value['value'],
-				$expireDate,
-				$container->getServer()->getWebRoot(),
-				null,
-				$container->getServer()->getRequest()->getServerProtocol() === 'https',
-				true,
-				$sameSite
-			);
-		}
-
-		/*
+    /** @var string[] */
+    private static $nameSpaceCache = [];
+
+    /**
+     * Turns an app id into a namespace by either reading the appinfo.xml's
+     * namespace tag or uppercasing the appid's first letter
+     * @param string $appId the app id
+     * @param string $topNamespace the namespace which should be prepended to
+     * the transformed app id, defaults to OCA\
+     * @return string the starting namespace for the app
+     */
+    public static function buildAppNamespace(string $appId, string $topNamespace='OCA\\'): string {
+        // Hit the cache!
+        if (isset(self::$nameSpaceCache[$appId])) {
+            return $topNamespace . self::$nameSpaceCache[$appId];
+        }
+
+        $appInfo = \OC_App::getAppInfo($appId);
+        if (isset($appInfo['namespace'])) {
+            self::$nameSpaceCache[$appId] = trim($appInfo['namespace']);
+        } else {
+            if ($appId !== 'spreed') {
+                // if the tag is not found, fall back to uppercasing the first letter
+                self::$nameSpaceCache[$appId] = ucfirst($appId);
+            } else {
+                // For the Talk app (appid spreed) the above fallback doesn't work.
+                // This leads to a problem when trying to install it freshly,
+                // because the apps namespace is already registered before the
+                // app is downloaded from the appstore, because of the hackish
+                // global route index.php/call/{token} which is registered via
+                // the core/routes.php so it does not have the app namespace.
+                // @ref https://github.com/nextcloud/server/pull/19433
+                self::$nameSpaceCache[$appId] = 'Talk';
+            }
+        }
+
+        return $topNamespace . self::$nameSpaceCache[$appId];
+    }
+
+    public static function getAppIdForClass(string $className, string $topNamespace='OCA\\'): ?string {
+        if (strpos($className, $topNamespace) !== 0) {
+            return null;
+        }
+
+        foreach (self::$nameSpaceCache as $appId => $namespace) {
+            if (strpos($className, $topNamespace . $namespace . '\\') === 0) {
+                return $appId;
+            }
+        }
+
+        return null;
+    }
+
+
+    /**
+     * Shortcut for calling a controller method and printing the result
+     * @param string $controllerName the name of the controller under which it is
+     *                               stored in the DI container
+     * @param string $methodName the method that you want to call
+     * @param DIContainer $container an instance of a pimple container.
+     * @param array $urlParams list of URL parameters (optional)
+     * @throws HintException
+     */
+    public static function main(string $controllerName, string $methodName, DIContainer $container, array $urlParams = null) {
+        if (!is_null($urlParams)) {
+            $container->query(IRequest::class)->setUrlParameters($urlParams);
+        } elseif (isset($container['urlParams']) && !is_null($container['urlParams'])) {
+            $container->query(IRequest::class)->setUrlParameters($container['urlParams']);
+        }
+        $appName = $container['AppName'];
+
+        // first try $controllerName then go for \OCA\AppName\Controller\$controllerName
+        try {
+            $controller = $container->query($controllerName);
+        } catch (QueryException $e) {
+            if (strpos($controllerName, '\\Controller\\') !== false) {
+                // This is from a global registered app route that is not enabled.
+                [/*OC(A)*/, $app, /* Controller/Name*/] = explode('\\', $controllerName, 3);
+                throw new HintException('App ' . strtolower($app) . ' is not enabled');
+            }
+
+            if ($appName === 'core') {
+                $appNameSpace = 'OC\\Core';
+            } else {
+                $appNameSpace = self::buildAppNamespace($appName);
+            }
+            $controllerName = $appNameSpace . '\\Controller\\' . $controllerName;
+            $controller = $container->query($controllerName);
+        }
+
+        // initialize the dispatcher and run all the middleware before the controller
+        /** @var Dispatcher $dispatcher */
+        $dispatcher = $container['Dispatcher'];
+
+        list(
+            $httpHeaders,
+            $responseHeaders,
+            $responseCookies,
+            $output,
+            $response
+        ) = $dispatcher->dispatch($controller, $methodName);
+
+        $io = $container[IOutput::class];
+
+        if (!is_null($httpHeaders)) {
+            $io->setHeader($httpHeaders);
+        }
+
+        foreach ($responseHeaders as $name => $value) {
+            $io->setHeader($name . ': ' . $value);
+        }
+
+        foreach ($responseCookies as $name => $value) {
+            $expireDate = null;
+            if ($value['expireDate'] instanceof \DateTime) {
+                $expireDate = $value['expireDate']->getTimestamp();
+            }
+            $sameSite = $value['sameSite'] ?? 'Lax';
+
+            $io->setCookie(
+                $name,
+                $value['value'],
+                $expireDate,
+                $container->getServer()->getWebRoot(),
+                null,
+                $container->getServer()->getRequest()->getServerProtocol() === 'https',
+                true,
+                $sameSite
+            );
+        }
+
+        /*
 		 * Status 204 does not have a body and no Content Length
 		 * Status 304 does not have a body and does not need a Content Length
 		 * https://tools.ietf.org/html/rfc7230#section-3.3
 		 * https://tools.ietf.org/html/rfc7230#section-3.3.2
 		 */
-		$emptyResponse = false;
-		if (preg_match('/^HTTP\/\d\.\d (\d{3}) .*$/', $httpHeaders, $matches)) {
-			$status = (int)$matches[1];
-			if ($status === Http::STATUS_NO_CONTENT || $status === Http::STATUS_NOT_MODIFIED) {
-				$emptyResponse = true;
-			}
-		}
-
-		if (!$emptyResponse) {
-			if ($response instanceof ICallbackResponse) {
-				$response->callback($io);
-			} elseif (!is_null($output)) {
-				$io->setHeader('Content-Length: ' . strlen($output));
-				$io->setOutput($output);
-			}
-		}
-	}
-
-	/**
-	 * Shortcut for calling a controller method and printing the result.
-	 * Similar to App:main except that no headers will be sent.
-	 * This should be used for example when registering sections via
-	 * \OC\AppFramework\Core\API::registerAdmin()
-	 *
-	 * @param string $controllerName the name of the controller under which it is
-	 *                               stored in the DI container
-	 * @param string $methodName the method that you want to call
-	 * @param array $urlParams an array with variables extracted from the routes
-	 * @param DIContainer $container an instance of a pimple container.
-	 */
-	public static function part(string $controllerName, string $methodName, array $urlParams,
-								DIContainer $container) {
-		$container['urlParams'] = $urlParams;
-		$controller = $container[$controllerName];
-
-		$dispatcher = $container['Dispatcher'];
-
-		list(, , $output) =  $dispatcher->dispatch($controller, $methodName);
-		return $output;
-	}
+        $emptyResponse = false;
+        if (preg_match('/^HTTP\/\d\.\d (\d{3}) .*$/', $httpHeaders, $matches)) {
+            $status = (int)$matches[1];
+            if ($status === Http::STATUS_NO_CONTENT || $status === Http::STATUS_NOT_MODIFIED) {
+                $emptyResponse = true;
+            }
+        }
+
+        if (!$emptyResponse) {
+            if ($response instanceof ICallbackResponse) {
+                $response->callback($io);
+            } elseif (!is_null($output)) {
+                $io->setHeader('Content-Length: ' . strlen($output));
+                $io->setOutput($output);
+            }
+        }
+    }
+
+    /**
+     * Shortcut for calling a controller method and printing the result.
+     * Similar to App:main except that no headers will be sent.
+     * This should be used for example when registering sections via
+     * \OC\AppFramework\Core\API::registerAdmin()
+     *
+     * @param string $controllerName the name of the controller under which it is
+     *                               stored in the DI container
+     * @param string $methodName the method that you want to call
+     * @param array $urlParams an array with variables extracted from the routes
+     * @param DIContainer $container an instance of a pimple container.
+     */
+    public static function part(string $controllerName, string $methodName, array $urlParams,
+                                DIContainer $container) {
+        $container['urlParams'] = $urlParams;
+        $controller = $container[$controllerName];
+
+        $dispatcher = $container['Dispatcher'];
+
+        list(, , $output) =  $dispatcher->dispatch($controller, $methodName);
+        return $output;
+    }
 }

Spacing +11 added lines, -11 removed lines

@@ -59,10 +59,10 @@ 
 	 * the transformed app id, defaults to OCA\
 	 * @return string the starting namespace for the app
 	 */
-	public static function buildAppNamespace(string $appId, string $topNamespace='OCA\\'): string {
+	public static function buildAppNamespace(string $appId, string $topNamespace = 'OCA\\'): string {
 		// Hit the cache!
 		if (isset(self::$nameSpaceCache[$appId])) {
-			return $topNamespace . self::$nameSpaceCache[$appId];
+			return $topNamespace.self::$nameSpaceCache[$appId];
 		}
 
 		$appInfo = \OC_App::getAppInfo($appId);
@@ -84,16 +84,16 @@ 
 			}
 		}
 
-		return $topNamespace . self::$nameSpaceCache[$appId];
+		return $topNamespace.self::$nameSpaceCache[$appId];
 	}
 
-	public static function getAppIdForClass(string $className, string $topNamespace='OCA\\'): ?string {
+	public static function getAppIdForClass(string $className, string $topNamespace = 'OCA\\'): ?string {
 		if (strpos($className, $topNamespace) !== 0) {
 			return null;
 		}
 
 		foreach (self::$nameSpaceCache as $appId => $namespace) {
-			if (strpos($className, $topNamespace . $namespace . '\\') === 0) {
+			if (strpos($className, $topNamespace.$namespace.'\\') === 0) {
 				return $appId;
 			}
 		}
@@ -126,7 +126,7 @@ 
 			if (strpos($controllerName, '\\Controller\\') !== false) {
 				// This is from a global registered app route that is not enabled.
 				[/*OC(A)*/, $app, /* Controller/Name*/] = explode('\\', $controllerName, 3);
-				throw new HintException('App ' . strtolower($app) . ' is not enabled');
+				throw new HintException('App '.strtolower($app).' is not enabled');
 			}
 
 			if ($appName === 'core') {
@@ -134,7 +134,7 @@ 
 			} else {
 				$appNameSpace = self::buildAppNamespace($appName);
 			}
-			$controllerName = $appNameSpace . '\\Controller\\' . $controllerName;
+			$controllerName = $appNameSpace.'\\Controller\\'.$controllerName;
 			$controller = $container->query($controllerName);
 		}
 
@@ -157,7 +157,7 @@ 
 		}
 
 		foreach ($responseHeaders as $name => $value) {
-			$io->setHeader($name . ': ' . $value);
+			$io->setHeader($name.': '.$value);
 		}
 
 		foreach ($responseCookies as $name => $value) {
@@ -187,7 +187,7 @@ 
 		 */
 		$emptyResponse = false;
 		if (preg_match('/^HTTP\/\d\.\d (\d{3}) .*$/', $httpHeaders, $matches)) {
-			$status = (int)$matches[1];
+			$status = (int) $matches[1];
 			if ($status === Http::STATUS_NO_CONTENT || $status === Http::STATUS_NOT_MODIFIED) {
 				$emptyResponse = true;
 			}
@@ -197,7 +197,7 @@ 
 			if ($response instanceof ICallbackResponse) {
 				$response->callback($io);
 			} elseif (!is_null($output)) {
-				$io->setHeader('Content-Length: ' . strlen($output));
+				$io->setHeader('Content-Length: '.strlen($output));
 				$io->setOutput($output);
 			}
 		}
@@ -222,7 +222,7 @@ 
 
 		$dispatcher = $container['Dispatcher'];
 
-		list(, , $output) =  $dispatcher->dispatch($controller, $methodName);
+		list(,, $output) = $dispatcher->dispatch($controller, $methodName);
 		return $output;
 	}
 }

lib/private/Activity/Event.php

Indentation +509 added lines, -509 removed lines

@@ -34,513 +34,513 @@
 
 class Event implements IEvent {
 
-	/** @var string */
-	protected $app = '';
-	/** @var string */
-	protected $type = '';
-	/** @var string */
-	protected $affectedUser = '';
-	/** @var string */
-	protected $author = '';
-	/** @var int */
-	protected $timestamp = 0;
-	/** @var string */
-	protected $subject = '';
-	/** @var array */
-	protected $subjectParameters = [];
-	/** @var string */
-	protected $subjectParsed = '';
-	/** @var string */
-	protected $subjectRich = '';
-	/** @var array */
-	protected $subjectRichParameters = [];
-	/** @var string */
-	protected $message = '';
-	/** @var array */
-	protected $messageParameters = [];
-	/** @var string */
-	protected $messageParsed = '';
-	/** @var string */
-	protected $messageRich = '';
-	/** @var array */
-	protected $messageRichParameters = [];
-	/** @var string */
-	protected $objectType = '';
-	/** @var int */
-	protected $objectId = 0;
-	/** @var string */
-	protected $objectName = '';
-	/** @var string */
-	protected $link = '';
-	/** @var string */
-	protected $icon = '';
-	/** @var bool */
-	protected $generateNotification = true;
-
-	/** @var IEvent|null */
-	protected $child;
-	/** @var IValidator */
-	protected $richValidator;
-
-	/**
-	 * @param IValidator $richValidator
-	 */
-	public function __construct(IValidator $richValidator) {
-		$this->richValidator = $richValidator;
-	}
-
-	/**
-	 * Set the app of the activity
-	 *
-	 * @param string $app
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the app id is invalid
-	 * @since 8.2.0
-	 */
-	public function setApp(string $app): IEvent {
-		if ($app === '' || isset($app[32])) {
-			throw new \InvalidArgumentException('The given app is invalid');
-		}
-		$this->app = $app;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getApp(): string {
-		return $this->app;
-	}
-
-	/**
-	 * Set the type of the activity
-	 *
-	 * @param string $type
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the type is invalid
-	 * @since 8.2.0
-	 */
-	public function setType(string $type): IEvent {
-		if ($type === '' || isset($type[255])) {
-			throw new \InvalidArgumentException('The given type is invalid');
-		}
-		$this->type = $type;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getType(): string {
-		return $this->type;
-	}
-
-	/**
-	 * Set the affected user of the activity
-	 *
-	 * @param string $affectedUser
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the affected user is invalid
-	 * @since 8.2.0
-	 */
-	public function setAffectedUser(string $affectedUser): IEvent {
-		if ($affectedUser === '' || isset($affectedUser[64])) {
-			throw new \InvalidArgumentException('The given affected user is invalid');
-		}
-		$this->affectedUser = $affectedUser;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getAffectedUser(): string {
-		return $this->affectedUser;
-	}
-
-	/**
-	 * Set the author of the activity
-	 *
-	 * @param string $author
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the author is invalid
-	 * @since 8.2.0
-	 */
-	public function setAuthor(string $author): IEvent {
-		if (isset($author[64])) {
-			throw new \InvalidArgumentException('The given author user is invalid');
-		}
-		$this->author = $author;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getAuthor(): string {
-		return $this->author;
-	}
-
-	/**
-	 * Set the timestamp of the activity
-	 *
-	 * @param int $timestamp
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the timestamp is invalid
-	 * @since 8.2.0
-	 */
-	public function setTimestamp(int $timestamp): IEvent {
-		$this->timestamp = $timestamp;
-		return $this;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getTimestamp(): int {
-		return $this->timestamp;
-	}
-
-	/**
-	 * Set the subject of the activity
-	 *
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setSubject(string $subject, array $parameters = []): IEvent {
-		if (isset($subject[255])) {
-			throw new \InvalidArgumentException('The given subject is invalid');
-		}
-		$this->subject = $subject;
-		$this->subjectParameters = $parameters;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getSubject(): string {
-		return $this->subject;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getSubjectParameters(): array {
-		return $this->subjectParameters;
-	}
-
-	/**
-	 * @param string $subject
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject is invalid
-	 * @since 11.0.0
-	 */
-	public function setParsedSubject(string $subject): IEvent {
-		if ($subject === '') {
-			throw new \InvalidArgumentException('The given parsed subject is invalid');
-		}
-		$this->subjectParsed = $subject;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getParsedSubject(): string {
-		return $this->subjectParsed;
-	}
-
-	/**
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichSubject(string $subject, array $parameters = []): IEvent {
-		if ($subject === '') {
-			throw new \InvalidArgumentException('The given parsed subject is invalid');
-		}
-		$this->subjectRich = $subject;
-		$this->subjectRichParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichSubject(): string {
-		return $this->subjectRich;
-	}
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichSubjectParameters(): array {
-		return $this->subjectRichParameters;
-	}
-
-	/**
-	 * Set the message of the activity
-	 *
-	 * @param string $message
-	 * @param array $parameters
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setMessage(string $message, array $parameters = []): IEvent {
-		if (isset($message[255])) {
-			throw new \InvalidArgumentException('The given message is invalid');
-		}
-		$this->message = $message;
-		$this->messageParameters = $parameters;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getMessage(): string {
-		return $this->message;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getMessageParameters(): array {
-		return $this->messageParameters;
-	}
-
-	/**
-	 * @param string $message
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message is invalid
-	 * @since 11.0.0
-	 */
-	public function setParsedMessage(string $message): IEvent {
-		$this->messageParsed = $message;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getParsedMessage(): string {
-		return $this->messageParsed;
-	}
-
-	/**
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichMessage(string $message, array $parameters = []): IEvent {
-		$this->messageRich = $message;
-		$this->messageRichParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichMessage(): string {
-		return $this->messageRich;
-	}
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichMessageParameters(): array {
-		return $this->messageRichParameters;
-	}
-
-	/**
-	 * Set the object of the activity
-	 *
-	 * @param string $objectType
-	 * @param int $objectId
-	 * @param string $objectName
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the object is invalid
-	 * @since 8.2.0
-	 */
-	public function setObject(string $objectType, int $objectId, string $objectName = ''): IEvent {
-		if (isset($objectType[255])) {
-			throw new \InvalidArgumentException('The given object type is invalid');
-		}
-		if (isset($objectName[4000])) {
-			throw new \InvalidArgumentException('The given object name is invalid');
-		}
-		$this->objectType = $objectType;
-		$this->objectId = $objectId;
-		$this->objectName = $objectName;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getObjectType(): string {
-		return $this->objectType;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getObjectId(): int {
-		return $this->objectId;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getObjectName(): string {
-		return $this->objectName;
-	}
-
-	/**
-	 * Set the link of the activity
-	 *
-	 * @param string $link
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
-	 */
-	public function setLink(string $link): IEvent {
-		if (isset($link[4000])) {
-			throw new \InvalidArgumentException('The given link is invalid');
-		}
-		$this->link = $link;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getLink(): string {
-		return $this->link;
-	}
-
-	/**
-	 * @param string $icon
-	 * @return $this
-	 * @throws \InvalidArgumentException if the icon is invalid
-	 * @since 11.0.0
-	 */
-	public function setIcon(string $icon): IEvent {
-		if (isset($icon[4000])) {
-			throw new \InvalidArgumentException('The given icon is invalid');
-		}
-		$this->icon = $icon;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getIcon(): string {
-		return $this->icon;
-	}
-
-	/**
-	 * @param IEvent $child
-	 * @return $this
-	 * @since 11.0.0 - Since 15.0.0 returns $this
-	 */
-	public function setChildEvent(IEvent $child): IEvent {
-		$this->child = $child;
-		return $this;
-	}
-
-	/**
-	 * @return IEvent|null
-	 * @since 11.0.0
-	 */
-	public function getChildEvent() {
-		return $this->child;
-	}
-
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isValid(): bool {
-		return
-			$this->isValidCommon()
-			&&
-			$this->getSubject() !== ''
-		;
-	}
-
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isValidParsed(): bool {
-		if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
-			try {
-				$this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
-			} catch (InvalidObjectExeption $e) {
-				return false;
-			}
-		}
-
-		if ($this->getRichMessage() !== '' || !empty($this->getRichMessageParameters())) {
-			try {
-				$this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters());
-			} catch (InvalidObjectExeption $e) {
-				return false;
-			}
-		}
-
-		return
-			$this->isValidCommon()
-			&&
-			$this->getParsedSubject() !== ''
-		;
-	}
-
-	protected function isValidCommon(): bool {
-		return
-			$this->getApp() !== ''
-			&&
-			$this->getType() !== ''
-			&&
-			$this->getAffectedUser() !== ''
-			&&
-			$this->getTimestamp() !== 0
-			/**
-			 * Disabled for BC with old activities
-			 * &&
-			 * $this->getObjectType() !== ''
-			 * &&
-			 * $this->getObjectId() !== 0
-			 */
-		;
-	}
-
-	public function setGenerateNotification(bool $generate): IEvent {
-		$this->generateNotification = $generate;
-		return $this;
-	}
-
-	public function getGenerateNotification(): bool {
-		return $this->generateNotification;
-	}
+    /** @var string */
+    protected $app = '';
+    /** @var string */
+    protected $type = '';
+    /** @var string */
+    protected $affectedUser = '';
+    /** @var string */
+    protected $author = '';
+    /** @var int */
+    protected $timestamp = 0;
+    /** @var string */
+    protected $subject = '';
+    /** @var array */
+    protected $subjectParameters = [];
+    /** @var string */
+    protected $subjectParsed = '';
+    /** @var string */
+    protected $subjectRich = '';
+    /** @var array */
+    protected $subjectRichParameters = [];
+    /** @var string */
+    protected $message = '';
+    /** @var array */
+    protected $messageParameters = [];
+    /** @var string */
+    protected $messageParsed = '';
+    /** @var string */
+    protected $messageRich = '';
+    /** @var array */
+    protected $messageRichParameters = [];
+    /** @var string */
+    protected $objectType = '';
+    /** @var int */
+    protected $objectId = 0;
+    /** @var string */
+    protected $objectName = '';
+    /** @var string */
+    protected $link = '';
+    /** @var string */
+    protected $icon = '';
+    /** @var bool */
+    protected $generateNotification = true;
+
+    /** @var IEvent|null */
+    protected $child;
+    /** @var IValidator */
+    protected $richValidator;
+
+    /**
+     * @param IValidator $richValidator
+     */
+    public function __construct(IValidator $richValidator) {
+        $this->richValidator = $richValidator;
+    }
+
+    /**
+     * Set the app of the activity
+     *
+     * @param string $app
+     * @return IEvent
+     * @throws \InvalidArgumentException if the app id is invalid
+     * @since 8.2.0
+     */
+    public function setApp(string $app): IEvent {
+        if ($app === '' || isset($app[32])) {
+            throw new \InvalidArgumentException('The given app is invalid');
+        }
+        $this->app = $app;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getApp(): string {
+        return $this->app;
+    }
+
+    /**
+     * Set the type of the activity
+     *
+     * @param string $type
+     * @return IEvent
+     * @throws \InvalidArgumentException if the type is invalid
+     * @since 8.2.0
+     */
+    public function setType(string $type): IEvent {
+        if ($type === '' || isset($type[255])) {
+            throw new \InvalidArgumentException('The given type is invalid');
+        }
+        $this->type = $type;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getType(): string {
+        return $this->type;
+    }
+
+    /**
+     * Set the affected user of the activity
+     *
+     * @param string $affectedUser
+     * @return IEvent
+     * @throws \InvalidArgumentException if the affected user is invalid
+     * @since 8.2.0
+     */
+    public function setAffectedUser(string $affectedUser): IEvent {
+        if ($affectedUser === '' || isset($affectedUser[64])) {
+            throw new \InvalidArgumentException('The given affected user is invalid');
+        }
+        $this->affectedUser = $affectedUser;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAffectedUser(): string {
+        return $this->affectedUser;
+    }
+
+    /**
+     * Set the author of the activity
+     *
+     * @param string $author
+     * @return IEvent
+     * @throws \InvalidArgumentException if the author is invalid
+     * @since 8.2.0
+     */
+    public function setAuthor(string $author): IEvent {
+        if (isset($author[64])) {
+            throw new \InvalidArgumentException('The given author user is invalid');
+        }
+        $this->author = $author;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAuthor(): string {
+        return $this->author;
+    }
+
+    /**
+     * Set the timestamp of the activity
+     *
+     * @param int $timestamp
+     * @return IEvent
+     * @throws \InvalidArgumentException if the timestamp is invalid
+     * @since 8.2.0
+     */
+    public function setTimestamp(int $timestamp): IEvent {
+        $this->timestamp = $timestamp;
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getTimestamp(): int {
+        return $this->timestamp;
+    }
+
+    /**
+     * Set the subject of the activity
+     *
+     * @param string $subject
+     * @param array $parameters
+     * @return IEvent
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setSubject(string $subject, array $parameters = []): IEvent {
+        if (isset($subject[255])) {
+            throw new \InvalidArgumentException('The given subject is invalid');
+        }
+        $this->subject = $subject;
+        $this->subjectParameters = $parameters;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSubject(): string {
+        return $this->subject;
+    }
+
+    /**
+     * @return array
+     */
+    public function getSubjectParameters(): array {
+        return $this->subjectParameters;
+    }
+
+    /**
+     * @param string $subject
+     * @return $this
+     * @throws \InvalidArgumentException if the subject is invalid
+     * @since 11.0.0
+     */
+    public function setParsedSubject(string $subject): IEvent {
+        if ($subject === '') {
+            throw new \InvalidArgumentException('The given parsed subject is invalid');
+        }
+        $this->subjectParsed = $subject;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getParsedSubject(): string {
+        return $this->subjectParsed;
+    }
+
+    /**
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichSubject(string $subject, array $parameters = []): IEvent {
+        if ($subject === '') {
+            throw new \InvalidArgumentException('The given parsed subject is invalid');
+        }
+        $this->subjectRich = $subject;
+        $this->subjectRichParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichSubject(): string {
+        return $this->subjectRich;
+    }
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichSubjectParameters(): array {
+        return $this->subjectRichParameters;
+    }
+
+    /**
+     * Set the message of the activity
+     *
+     * @param string $message
+     * @param array $parameters
+     * @return IEvent
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setMessage(string $message, array $parameters = []): IEvent {
+        if (isset($message[255])) {
+            throw new \InvalidArgumentException('The given message is invalid');
+        }
+        $this->message = $message;
+        $this->messageParameters = $parameters;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMessage(): string {
+        return $this->message;
+    }
+
+    /**
+     * @return array
+     */
+    public function getMessageParameters(): array {
+        return $this->messageParameters;
+    }
+
+    /**
+     * @param string $message
+     * @return $this
+     * @throws \InvalidArgumentException if the message is invalid
+     * @since 11.0.0
+     */
+    public function setParsedMessage(string $message): IEvent {
+        $this->messageParsed = $message;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getParsedMessage(): string {
+        return $this->messageParsed;
+    }
+
+    /**
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichMessage(string $message, array $parameters = []): IEvent {
+        $this->messageRich = $message;
+        $this->messageRichParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichMessage(): string {
+        return $this->messageRich;
+    }
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichMessageParameters(): array {
+        return $this->messageRichParameters;
+    }
+
+    /**
+     * Set the object of the activity
+     *
+     * @param string $objectType
+     * @param int $objectId
+     * @param string $objectName
+     * @return IEvent
+     * @throws \InvalidArgumentException if the object is invalid
+     * @since 8.2.0
+     */
+    public function setObject(string $objectType, int $objectId, string $objectName = ''): IEvent {
+        if (isset($objectType[255])) {
+            throw new \InvalidArgumentException('The given object type is invalid');
+        }
+        if (isset($objectName[4000])) {
+            throw new \InvalidArgumentException('The given object name is invalid');
+        }
+        $this->objectType = $objectType;
+        $this->objectId = $objectId;
+        $this->objectName = $objectName;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getObjectType(): string {
+        return $this->objectType;
+    }
+
+    /**
+     * @return int
+     */
+    public function getObjectId(): int {
+        return $this->objectId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getObjectName(): string {
+        return $this->objectName;
+    }
+
+    /**
+     * Set the link of the activity
+     *
+     * @param string $link
+     * @return IEvent
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 8.2.0
+     */
+    public function setLink(string $link): IEvent {
+        if (isset($link[4000])) {
+            throw new \InvalidArgumentException('The given link is invalid');
+        }
+        $this->link = $link;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getLink(): string {
+        return $this->link;
+    }
+
+    /**
+     * @param string $icon
+     * @return $this
+     * @throws \InvalidArgumentException if the icon is invalid
+     * @since 11.0.0
+     */
+    public function setIcon(string $icon): IEvent {
+        if (isset($icon[4000])) {
+            throw new \InvalidArgumentException('The given icon is invalid');
+        }
+        $this->icon = $icon;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getIcon(): string {
+        return $this->icon;
+    }
+
+    /**
+     * @param IEvent $child
+     * @return $this
+     * @since 11.0.0 - Since 15.0.0 returns $this
+     */
+    public function setChildEvent(IEvent $child): IEvent {
+        $this->child = $child;
+        return $this;
+    }
+
+    /**
+     * @return IEvent|null
+     * @since 11.0.0
+     */
+    public function getChildEvent() {
+        return $this->child;
+    }
+
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isValid(): bool {
+        return
+            $this->isValidCommon()
+            &&
+            $this->getSubject() !== ''
+        ;
+    }
+
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isValidParsed(): bool {
+        if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
+            try {
+                $this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
+            } catch (InvalidObjectExeption $e) {
+                return false;
+            }
+        }
+
+        if ($this->getRichMessage() !== '' || !empty($this->getRichMessageParameters())) {
+            try {
+                $this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters());
+            } catch (InvalidObjectExeption $e) {
+                return false;
+            }
+        }
+
+        return
+            $this->isValidCommon()
+            &&
+            $this->getParsedSubject() !== ''
+        ;
+    }
+
+    protected function isValidCommon(): bool {
+        return
+            $this->getApp() !== ''
+            &&
+            $this->getType() !== ''
+            &&
+            $this->getAffectedUser() !== ''
+            &&
+            $this->getTimestamp() !== 0
+            /**
+             * Disabled for BC with old activities
+             * &&
+             * $this->getObjectType() !== ''
+             * &&
+             * $this->getObjectId() !== 0
+             */
+        ;
+    }
+
+    public function setGenerateNotification(bool $generate): IEvent {
+        $this->generateNotification = $generate;
+        return $this;
+    }
+
+    public function getGenerateNotification(): bool {
+        return $this->generateNotification;
+    }
 }

lib/private/Activity/ActivitySettingsAdapter.php

Indentation +19 added lines, -19 removed lines

@@ -31,29 +31,29 @@
  * class based one
  */
 class ActivitySettingsAdapter extends ActivitySettings {
-	private $oldSettings;
+    private $oldSettings;
 
-	public function __construct(ISetting $oldSettings) {
-		$this->oldSettings = $oldSettings;
-	}
+    public function __construct(ISetting $oldSettings) {
+        $this->oldSettings = $oldSettings;
+    }
 
-	public function getIdentifier() {
-		return $this->oldSettings->getIdentifier();
-	}
+    public function getIdentifier() {
+        return $this->oldSettings->getIdentifier();
+    }
 
-	public function getName() {
-		return $this->oldSettings->getName();
-	}
+    public function getName() {
+        return $this->oldSettings->getName();
+    }
 
-	public function getPriority() {
-		return $this->oldSettings->getPriority();
-	}
+    public function getPriority() {
+        return $this->oldSettings->getPriority();
+    }
 
-	public function canChangeMail() {
-		return $this->oldSettings->canChangeMail();
-	}
+    public function canChangeMail() {
+        return $this->oldSettings->canChangeMail();
+    }
 
-	public function isDefaultEnabledMail() {
-		return $this->oldSettings->isDefaultEnabledMail();
-	}
+    public function isDefaultEnabledMail() {
+        return $this->oldSettings->isDefaultEnabledMail();
+    }
 }

lib/private/Activity/Manager.php

Indentation +348 added lines, -348 removed lines

@@ -42,352 +42,352 @@
 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;
-
-	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 = [];
-
-	/** @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);
-				}
-			} 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);
-	}
+    /** @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;
+
+    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 = [];
+
+    /** @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);
+                }
+            } 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);
+    }
 }

lib/public/Activity/IExtension.php

Indentation +8 added lines, -8 removed lines

@@ -32,13 +32,13 @@
  * @since 8.0.0
  */
 interface IExtension {
-	public const METHOD_STREAM = 'stream';
-	public const METHOD_MAIL = 'email';
-	public const METHOD_NOTIFICATION = 'notification';
+    public const METHOD_STREAM = 'stream';
+    public const METHOD_MAIL = 'email';
+    public const METHOD_NOTIFICATION = 'notification';
 
-	public const PRIORITY_VERYLOW 	= 10;
-	public const PRIORITY_LOW	= 20;
-	public const PRIORITY_MEDIUM	= 30;
-	public const PRIORITY_HIGH	= 40;
-	public const PRIORITY_VERYHIGH	= 50;
+    public const PRIORITY_VERYLOW 	= 10;
+    public const PRIORITY_LOW	= 20;
+    public const PRIORITY_MEDIUM	= 30;
+    public const PRIORITY_HIGH	= 40;
+    public const PRIORITY_VERYHIGH	= 50;
 }

Spacing +5 added lines, -5 removed lines

@@ -36,9 +36,9 @@
 	public const METHOD_MAIL = 'email';
 	public const METHOD_NOTIFICATION = 'notification';
 
-	public const PRIORITY_VERYLOW 	= 10;
-	public const PRIORITY_LOW	= 20;
-	public const PRIORITY_MEDIUM	= 30;
-	public const PRIORITY_HIGH	= 40;
-	public const PRIORITY_VERYHIGH	= 50;
+	public const PRIORITY_VERYLOW = 10;
+	public const PRIORITY_LOW = 20;
+	public const PRIORITY_MEDIUM = 30;
+	public const PRIORITY_HIGH = 40;
+	public const PRIORITY_VERYHIGH = 50;
 }

lib/public/Activity/IEvent.php

Indentation +341 added lines, -341 removed lines

@@ -42,345 +42,345 @@
  * @since 8.2.0
  */
 interface IEvent {
-	/**
-	 * Set the app of the activity
-	 *
-	 * @param string $app
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the app id is invalid
-	 * @since 8.2.0
-	 */
-	public function setApp(string $app): self;
-
-	/**
-	 * Set the type of the activity
-	 *
-	 * @param string $type
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the type is invalid
-	 * @since 8.2.0
-	 */
-	public function setType(string $type): self;
-
-	/**
-	 * Set the affected user of the activity
-	 *
-	 * @param string $user
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the affected user is invalid
-	 * @since 8.2.0
-	 */
-	public function setAffectedUser(string $user): self;
-
-	/**
-	 * Set the author of the activity
-	 *
-	 * @param string $author
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the author is invalid
-	 * @since 8.2.0
-	 */
-	public function setAuthor(string $author): self;
-
-	/**
-	 * Set the author of the activity
-	 *
-	 * @param int $timestamp
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the timestamp is invalid
-	 * @since 8.2.0
-	 */
-	public function setTimestamp(int $timestamp): self;
-
-	/**
-	 * Set the subject of the activity
-	 *
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setSubject(string $subject, array $parameters = []): self;
-
-	/**
-	 * Set a parsed subject
-	 *
-	 * HTML is not allowed in the parsed subject and will be escaped
-	 * automatically by the clients. You can use the RichObjectString system
-	 * provided by the Nextcloud server to highlight important parameters via
-	 * the setRichSubject method, but make sure, that a plain text message is
-	 * always set via setParsedSubject, to support clients which can not handle
-	 * rich strings.
-	 *
-	 * See https://github.com/nextcloud/server/issues/1706 for more information.
-	 *
-	 * @param string $subject
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject is invalid
-	 * @since 11.0.0
-	 */
-	public function setParsedSubject(string $subject): self;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getParsedSubject(): string;
-
-	/**
-	 * Set a RichObjectString subject
-	 *
-	 * HTML is not allowed in the rich subject and will be escaped automatically
-	 * by the clients, but you can use the RichObjectString system provided by
-	 * the Nextcloud server to highlight important parameters.
-	 * Also make sure, that a plain text subject is always set via
-	 * setParsedSubject, to support clients which can not handle rich strings.
-	 *
-	 * See https://github.com/nextcloud/server/issues/1706 for more information.
-	 *
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichSubject(string $subject, array $parameters = []): self;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichSubject(): string;
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichSubjectParameters(): array;
-
-	/**
-	 * Set the message of the activity
-	 *
-	 * @param string $message
-	 * @param array $parameters
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setMessage(string $message, array $parameters = []): self;
-
-	/**
-	 * Set a parsed message
-	 *
-	 * HTML is not allowed in the parsed message and will be escaped
-	 * automatically by the clients. You can use the RichObjectString system
-	 * provided by the Nextcloud server to highlight important parameters via
-	 * the setRichMessage method, but make sure, that a plain text message is
-	 * always set via setParsedMessage, to support clients which can not handle
-	 * rich strings.
-	 *
-	 * See https://github.com/nextcloud/server/issues/1706 for more information.
-	 *
-	 * @param string $message
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message is invalid
-	 * @since 11.0.0
-	 */
-	public function setParsedMessage(string $message): self;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getParsedMessage(): string;
-
-	/**
-	 * Set a RichObjectString message
-	 *
-	 * HTML is not allowed in the rich message and will be escaped automatically
-	 * by the clients, but you can use the RichObjectString system provided by
-	 * the Nextcloud server to highlight important parameters.
-	 * Also make sure, that a plain text message is always set via
-	 * setParsedMessage, to support clients which can not handle rich strings.
-	 *
-	 * See https://github.com/nextcloud/server/issues/1706 for more information.
-	 *
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichMessage(string $message, array $parameters = []): self;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichMessage(): string;
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichMessageParameters(): array;
-
-	/**
-	 * Set the object of the activity
-	 *
-	 * @param string $objectType
-	 * @param int $objectId
-	 * @param string $objectName
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the object is invalid
-	 * @since 8.2.0
-	 */
-	public function setObject(string $objectType, int $objectId, string $objectName = ''): self;
-
-	/**
-	 * Set the link of the activity
-	 *
-	 * @param string $link
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
-	 */
-	public function setLink(string $link): self;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getApp(): string;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getType(): string;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getAffectedUser(): string;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getAuthor(): string;
-
-	/**
-	 * @return int
-	 * @since 8.2.0
-	 */
-	public function getTimestamp(): int;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getSubject(): string;
-
-	/**
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getSubjectParameters(): array;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getMessage(): string;
-
-	/**
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getMessageParameters(): array;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getObjectType(): string;
-
-	/**
-	 * @return int
-	 * @since 8.2.0
-	 */
-	public function getObjectId(): int;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getObjectName(): string;
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getLink(): string;
-
-	/**
-	 * @param string $icon
-	 * @return $this
-	 * @throws \InvalidArgumentException if the icon is invalid
-	 * @since 11.0.0
-	 */
-	public function setIcon(string $icon): self;
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getIcon(): string;
-
-	/**
-	 * @param IEvent $child
-	 * @return $this
-	 * @since 11.0.0 - Since 15.0.0 returns $this
-	 */
-	public function setChildEvent(IEvent $child): self;
-
-	/**
-	 * @return IEvent|null
-	 * @since 11.0.0
-	 */
-	public function getChildEvent();
-
-	/**
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function isValid(): bool;
-
-	/**
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function isValidParsed(): bool;
-
-	/**
-	 * Set whether or not a notification should be automatically generated for this activity.
-	 *
-	 * Set this to `false` if the app already generates a notification for the event.
-	 *
-	 * @param bool $generate
-	 * @return IEvent
-	 * @since 20.0.0
-	 */
-	public function setGenerateNotification(bool $generate): self;
-
-	/**
-	 * whether or not a notification should be automatically generated for this activity.
-	 *
-	 * @return bool
-	 * @since 20.0.0
-	 */
-	public function getGenerateNotification(): bool;
+    /**
+     * Set the app of the activity
+     *
+     * @param string $app
+     * @return IEvent
+     * @throws \InvalidArgumentException if the app id is invalid
+     * @since 8.2.0
+     */
+    public function setApp(string $app): self;
+
+    /**
+     * Set the type of the activity
+     *
+     * @param string $type
+     * @return IEvent
+     * @throws \InvalidArgumentException if the type is invalid
+     * @since 8.2.0
+     */
+    public function setType(string $type): self;
+
+    /**
+     * Set the affected user of the activity
+     *
+     * @param string $user
+     * @return IEvent
+     * @throws \InvalidArgumentException if the affected user is invalid
+     * @since 8.2.0
+     */
+    public function setAffectedUser(string $user): self;
+
+    /**
+     * Set the author of the activity
+     *
+     * @param string $author
+     * @return IEvent
+     * @throws \InvalidArgumentException if the author is invalid
+     * @since 8.2.0
+     */
+    public function setAuthor(string $author): self;
+
+    /**
+     * Set the author of the activity
+     *
+     * @param int $timestamp
+     * @return IEvent
+     * @throws \InvalidArgumentException if the timestamp is invalid
+     * @since 8.2.0
+     */
+    public function setTimestamp(int $timestamp): self;
+
+    /**
+     * Set the subject of the activity
+     *
+     * @param string $subject
+     * @param array $parameters
+     * @return IEvent
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setSubject(string $subject, array $parameters = []): self;
+
+    /**
+     * Set a parsed subject
+     *
+     * HTML is not allowed in the parsed subject and will be escaped
+     * automatically by the clients. You can use the RichObjectString system
+     * provided by the Nextcloud server to highlight important parameters via
+     * the setRichSubject method, but make sure, that a plain text message is
+     * always set via setParsedSubject, to support clients which can not handle
+     * rich strings.
+     *
+     * See https://github.com/nextcloud/server/issues/1706 for more information.
+     *
+     * @param string $subject
+     * @return $this
+     * @throws \InvalidArgumentException if the subject is invalid
+     * @since 11.0.0
+     */
+    public function setParsedSubject(string $subject): self;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getParsedSubject(): string;
+
+    /**
+     * Set a RichObjectString subject
+     *
+     * HTML is not allowed in the rich subject and will be escaped automatically
+     * by the clients, but you can use the RichObjectString system provided by
+     * the Nextcloud server to highlight important parameters.
+     * Also make sure, that a plain text subject is always set via
+     * setParsedSubject, to support clients which can not handle rich strings.
+     *
+     * See https://github.com/nextcloud/server/issues/1706 for more information.
+     *
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichSubject(string $subject, array $parameters = []): self;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichSubject(): string;
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichSubjectParameters(): array;
+
+    /**
+     * Set the message of the activity
+     *
+     * @param string $message
+     * @param array $parameters
+     * @return IEvent
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setMessage(string $message, array $parameters = []): self;
+
+    /**
+     * Set a parsed message
+     *
+     * HTML is not allowed in the parsed message and will be escaped
+     * automatically by the clients. You can use the RichObjectString system
+     * provided by the Nextcloud server to highlight important parameters via
+     * the setRichMessage method, but make sure, that a plain text message is
+     * always set via setParsedMessage, to support clients which can not handle
+     * rich strings.
+     *
+     * See https://github.com/nextcloud/server/issues/1706 for more information.
+     *
+     * @param string $message
+     * @return $this
+     * @throws \InvalidArgumentException if the message is invalid
+     * @since 11.0.0
+     */
+    public function setParsedMessage(string $message): self;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getParsedMessage(): string;
+
+    /**
+     * Set a RichObjectString message
+     *
+     * HTML is not allowed in the rich message and will be escaped automatically
+     * by the clients, but you can use the RichObjectString system provided by
+     * the Nextcloud server to highlight important parameters.
+     * Also make sure, that a plain text message is always set via
+     * setParsedMessage, to support clients which can not handle rich strings.
+     *
+     * See https://github.com/nextcloud/server/issues/1706 for more information.
+     *
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichMessage(string $message, array $parameters = []): self;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichMessage(): string;
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichMessageParameters(): array;
+
+    /**
+     * Set the object of the activity
+     *
+     * @param string $objectType
+     * @param int $objectId
+     * @param string $objectName
+     * @return IEvent
+     * @throws \InvalidArgumentException if the object is invalid
+     * @since 8.2.0
+     */
+    public function setObject(string $objectType, int $objectId, string $objectName = ''): self;
+
+    /**
+     * Set the link of the activity
+     *
+     * @param string $link
+     * @return IEvent
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 8.2.0
+     */
+    public function setLink(string $link): self;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getApp(): string;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getType(): string;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getAffectedUser(): string;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getAuthor(): string;
+
+    /**
+     * @return int
+     * @since 8.2.0
+     */
+    public function getTimestamp(): int;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getSubject(): string;
+
+    /**
+     * @return array
+     * @since 8.2.0
+     */
+    public function getSubjectParameters(): array;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getMessage(): string;
+
+    /**
+     * @return array
+     * @since 8.2.0
+     */
+    public function getMessageParameters(): array;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getObjectType(): string;
+
+    /**
+     * @return int
+     * @since 8.2.0
+     */
+    public function getObjectId(): int;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getObjectName(): string;
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getLink(): string;
+
+    /**
+     * @param string $icon
+     * @return $this
+     * @throws \InvalidArgumentException if the icon is invalid
+     * @since 11.0.0
+     */
+    public function setIcon(string $icon): self;
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getIcon(): string;
+
+    /**
+     * @param IEvent $child
+     * @return $this
+     * @since 11.0.0 - Since 15.0.0 returns $this
+     */
+    public function setChildEvent(IEvent $child): self;
+
+    /**
+     * @return IEvent|null
+     * @since 11.0.0
+     */
+    public function getChildEvent();
+
+    /**
+     * @return bool
+     * @since 11.0.0
+     */
+    public function isValid(): bool;
+
+    /**
+     * @return bool
+     * @since 11.0.0
+     */
+    public function isValidParsed(): bool;
+
+    /**
+     * Set whether or not a notification should be automatically generated for this activity.
+     *
+     * Set this to `false` if the app already generates a notification for the event.
+     *
+     * @param bool $generate
+     * @return IEvent
+     * @since 20.0.0
+     */
+    public function setGenerateNotification(bool $generate): self;
+
+    /**
+     * whether or not a notification should be automatically generated for this activity.
+     *
+     * @return bool
+     * @since 20.0.0
+     */
+    public function getGenerateNotification(): bool;
 }

lib/public/Activity/IManager.php

Indentation +137 added lines, -137 removed lines

@@ -35,141 +35,141 @@
  * @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(): IEvent;
-
-	/**
-	 * 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): void;
-
-	/**
-	 * 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
-	 * @since 6.0.0
-	 */
-	public function registerConsumer(\Closure $callable): void;
-
-	/**
-	 * @param string $filter Class must implement OCA\Activity\IFilter
-	 * @since 11.0.0
-	 */
-	public function registerFilter(string $filter): void;
-
-	/**
-	 * @return IFilter[]
-	 * @since 11.0.0
-	 */
-	public function getFilters(): array;
-
-	/**
-	 * @param string $id
-	 * @return IFilter
-	 * @throws \InvalidArgumentException when the filter was not found
-	 * @since 11.0.0
-	 */
-	public function getFilterById(string $id): IFilter;
-
-	/**
-	 * @param string $setting Class must implement OCA\Activity\ISetting
-	 * @since 11.0.0
-	 */
-	public function registerSetting(string $setting): void;
-
-	/**
-	 * @return ActivitySettings[]
-	 * @since 11.0.0
-	 */
-	public function getSettings(): array;
-
-	/**
-	 * @param string $provider Class must implement OCA\Activity\IProvider
-	 * @since 11.0.0
-	 */
-	public function registerProvider(string $provider): void;
-
-	/**
-	 * @return IProvider[]
-	 * @since 11.0.0
-	 */
-	public function getProviders(): array;
-
-	/**
-	 * @param string $id
-	 * @return ActivitySettings
-	 * @throws \InvalidArgumentException when the setting was not found
-	 * @since 11.0.0
-	 */
-	public function getSettingById(string $id): ActivitySettings;
-
-	/**
-	 * @param string $type
-	 * @param int $id
-	 * @since 8.2.0
-	 */
-	public function setFormattingObject(string $type, int $id): void;
-
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isFormattingFilteredObject(): bool;
-
-	/**
-	 * @param bool $status Set to true, when parsing events should not use SVG icons
-	 * @since 12.0.1
-	 */
-	public function setRequirePNG(bool $status): void;
-
-	/**
-	 * @return bool
-	 * @since 12.0.1
-	 */
-	public function getRequirePNG(): bool;
-
-	/**
-	 * 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(string $currentUserId = null): void;
-
-	/**
-	 * 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(): string;
+    /**
+     * 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(): IEvent;
+
+    /**
+     * 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): void;
+
+    /**
+     * 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
+     * @since 6.0.0
+     */
+    public function registerConsumer(\Closure $callable): void;
+
+    /**
+     * @param string $filter Class must implement OCA\Activity\IFilter
+     * @since 11.0.0
+     */
+    public function registerFilter(string $filter): void;
+
+    /**
+     * @return IFilter[]
+     * @since 11.0.0
+     */
+    public function getFilters(): array;
+
+    /**
+     * @param string $id
+     * @return IFilter
+     * @throws \InvalidArgumentException when the filter was not found
+     * @since 11.0.0
+     */
+    public function getFilterById(string $id): IFilter;
+
+    /**
+     * @param string $setting Class must implement OCA\Activity\ISetting
+     * @since 11.0.0
+     */
+    public function registerSetting(string $setting): void;
+
+    /**
+     * @return ActivitySettings[]
+     * @since 11.0.0
+     */
+    public function getSettings(): array;
+
+    /**
+     * @param string $provider Class must implement OCA\Activity\IProvider
+     * @since 11.0.0
+     */
+    public function registerProvider(string $provider): void;
+
+    /**
+     * @return IProvider[]
+     * @since 11.0.0
+     */
+    public function getProviders(): array;
+
+    /**
+     * @param string $id
+     * @return ActivitySettings
+     * @throws \InvalidArgumentException when the setting was not found
+     * @since 11.0.0
+     */
+    public function getSettingById(string $id): ActivitySettings;
+
+    /**
+     * @param string $type
+     * @param int $id
+     * @since 8.2.0
+     */
+    public function setFormattingObject(string $type, int $id): void;
+
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isFormattingFilteredObject(): bool;
+
+    /**
+     * @param bool $status Set to true, when parsing events should not use SVG icons
+     * @since 12.0.1
+     */
+    public function setRequirePNG(bool $status): void;
+
+    /**
+     * @return bool
+     * @since 12.0.1
+     */
+    public function getRequirePNG(): bool;
+
+    /**
+     * 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(string $currentUserId = null): void;
+
+    /**
+     * 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(): string;
 }

lib/public/Activity/ActivitySettings.php

Indentation +63 added lines, -63 removed lines

@@ -27,75 +27,75 @@
  * @since 20.0.0
  */
 abstract class ActivitySettings implements ISetting {
-	/**
-	 * @return string Lowercase a-z and underscore only identifier
-	 * @since 20.0.0
-	 */
-	abstract public function getIdentifier();
+    /**
+     * @return string Lowercase a-z and underscore only identifier
+     * @since 20.0.0
+     */
+    abstract public function getIdentifier();
 
-	/**
-	 * @return string A translated string
-	 * @since 20.0.0
-	 */
-	abstract public function getName();
+    /**
+     * @return string A translated string
+     * @since 20.0.0
+     */
+    abstract public function getName();
 
-	/**
-	 * @return int whether the filter should be rather on the top or bottom of
-	 * the admin section. The filters are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 * @since 20.0.0
-	 */
-	abstract public function getPriority();
+    /**
+     * @return int whether the filter should be rather on the top or bottom of
+     * the admin section. The filters are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     * @since 20.0.0
+     */
+    abstract public function getPriority();
 
-	/**
-	 * @return bool True when the option can be changed for the mail
-	 * @since 20.0.0
-	 */
-	public function canChangeMail() {
-		return true;
-	}
+    /**
+     * @return bool True when the option can be changed for the mail
+     * @since 20.0.0
+     */
+    public function canChangeMail() {
+        return true;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the notification
-	 * @since 20.0.0
-	 */
-	public function canChangeNotification() {
-		return true;
-	}
+    /**
+     * @return bool True when the option can be changed for the notification
+     * @since 20.0.0
+     */
+    public function canChangeNotification() {
+        return true;
+    }
 
-	/**
-	 * @return bool Whether or not an activity email should be send by default
-	 * @since 20.0.0
-	 */
-	public function isDefaultEnabledMail() {
-		return false;
-	}
+    /**
+     * @return bool Whether or not an activity email should be send by default
+     * @since 20.0.0
+     */
+    public function isDefaultEnabledMail() {
+        return false;
+    }
 
-	/**
-	 * @return bool Whether or not an activity notification should be send by default
-	 * @since 20.0.0
-	 */
-	public function isDefaultEnabledNotification() {
-		return $this->isDefaultEnabledMail() && !$this->canChangeMail();
-	}
+    /**
+     * @return bool Whether or not an activity notification should be send by default
+     * @since 20.0.0
+     */
+    public function isDefaultEnabledNotification() {
+        return $this->isDefaultEnabledMail() && !$this->canChangeMail();
+    }
 
-	/**
-	 * Left in for backwards compatibility
-	 *
-	 * @return bool
-	 * @since 20.0.0
-	 */
-	public function canChangeStream() {
-		return false;
-	}
+    /**
+     * Left in for backwards compatibility
+     *
+     * @return bool
+     * @since 20.0.0
+     */
+    public function canChangeStream() {
+        return false;
+    }
 
-	/**
-	 * Left in for backwards compatibility
-	 *
-	 * @return bool
-	 * @since 20.0.0
-	 */
-	public function isDefaultEnabledStream() {
-		return true;
-	}
+    /**
+     * Left in for backwards compatibility
+     *
+     * @return bool
+     * @since 20.0.0
+     */
+    public function isDefaultEnabledStream() {
+        return true;
+    }
 }