nextcloud / server

lib/private/AppFramework/Http/Dispatcher.php

Indentation +189 added lines, -189 removed lines

@@ -49,193 +49,193 @@
  */
 class Dispatcher {
 
-	/** @var MiddlewareDispatcher */
-	private $middlewareDispatcher;
-
-	/** @var Http */
-	private $protocol;
-
-	/** @var ControllerMethodReflector */
-	private $reflector;
-
-	/** @var IRequest */
-	private $request;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var ConnectionAdapter */
-	private $connection;
-
-	/** @var LoggerInterface */
-	private $logger;
-
-	/**
-	 * @param Http $protocol the http protocol with contains all status headers
-	 * @param MiddlewareDispatcher $middlewareDispatcher the dispatcher which
-	 * runs the middleware
-	 * @param ControllerMethodReflector $reflector the reflector that is used to inject
-	 * the arguments for the controller
-	 * @param IRequest $request the incoming request
-	 * @param IConfig $config
-	 * @param ConnectionAdapter $connection
-	 * @param LoggerInterface $logger
-	 */
-	public function __construct(Http $protocol,
-								MiddlewareDispatcher $middlewareDispatcher,
-								ControllerMethodReflector $reflector,
-								IRequest $request,
-								IConfig $config,
-								ConnectionAdapter $connection,
-								LoggerInterface $logger) {
-		$this->protocol = $protocol;
-		$this->middlewareDispatcher = $middlewareDispatcher;
-		$this->reflector = $reflector;
-		$this->request = $request;
-		$this->config = $config;
-		$this->connection = $connection;
-		$this->logger = $logger;
-	}
-
-
-	/**
-	 * Handles a request and calls the dispatcher on the controller
-	 * @param Controller $controller the controller which will be called
-	 * @param string $methodName the method name which will be called on
-	 * the controller
-	 * @return array $array[0] contains a string with the http main header,
-	 * $array[1] contains headers in the form: $key => value, $array[2] contains
-	 * the response output
-	 * @throws \Exception
-	 */
-	public function dispatch(Controller $controller, string $methodName): array {
-		$out = [null, [], null];
-
-		try {
-			// prefill reflector with everything thats needed for the
-			// middlewares
-			$this->reflector->reflect($controller, $methodName);
-
-			$this->middlewareDispatcher->beforeController($controller,
-				$methodName);
-
-			$databaseStatsBefore = [];
-			if ($this->config->getSystemValueBool('debug', false)) {
-				$databaseStatsBefore = $this->connection->getInner()->getStats();
-			}
-
-			$response = $this->executeController($controller, $methodName);
-
-			if (!empty($databaseStatsBefore)) {
-				$databaseStatsAfter = $this->connection->getInner()->getStats();
-				$numBuilt = $databaseStatsAfter['built'] - $databaseStatsBefore['built'];
-				$numExecuted = $databaseStatsAfter['executed'] - $databaseStatsBefore['executed'];
-
-				if ($numBuilt > 50) {
-					$this->logger->debug('Controller {class}::{method} created {count} QueryBuilder objects, please check if they are created inside a loop by accident.' , [
-						'class' => get_class($controller),
-						'method' => $methodName,
-						'count' => $numBuilt,
-					]);
-				}
-
-				if ($numExecuted > 100) {
-					$this->logger->warning('Controller {class}::{method} executed {count} queries.' , [
-						'class' => get_class($controller),
-						'method' => $methodName,
-						'count' => $numExecuted,
-					]);
-				}
-			}
-
-			// if an exception appears, the middleware checks if it can handle the
-			// exception and creates a response. If no response is created, it is
-			// assumed that theres no middleware who can handle it and the error is
-			// thrown again
-		} catch (\Exception $exception) {
-			$response = $this->middlewareDispatcher->afterException(
-				$controller, $methodName, $exception);
-		} catch (\Throwable $throwable) {
-			$exception = new \Exception($throwable->getMessage(), $throwable->getCode(), $throwable);
-			$response = $this->middlewareDispatcher->afterException(
-			$controller, $methodName, $exception);
-		}
-
-		$response = $this->middlewareDispatcher->afterController(
-			$controller, $methodName, $response);
-
-		// depending on the cache object the headers need to be changed
-		$out[0] = $this->protocol->getStatusHeader($response->getStatus());
-		$out[1] = array_merge($response->getHeaders());
-		$out[2] = $response->getCookies();
-		$out[3] = $this->middlewareDispatcher->beforeOutput(
-			$controller, $methodName, $response->render()
-		);
-		$out[4] = $response;
-
-		return $out;
-	}
-
-
-	/**
-	 * Uses the reflected parameters, types and request parameters to execute
-	 * the controller
-	 * @param Controller $controller the controller to be executed
-	 * @param string $methodName the method on the controller that should be executed
-	 * @return Response
-	 */
-	private function executeController(Controller $controller, string $methodName): Response {
-		$arguments = [];
-
-		// valid types that will be casted
-		$types = ['int', 'integer', 'bool', 'boolean', 'float'];
-
-		foreach ($this->reflector->getParameters() as $param => $default) {
-
-			// try to get the parameter from the request object and cast
-			// it to the type annotated in the @param annotation
-			$value = $this->request->getParam($param, $default);
-			$type = $this->reflector->getType($param);
-
-			// if this is submitted using GET or a POST form, 'false' should be
-			// converted to false
-			if (($type === 'bool' || $type === 'boolean') &&
-				$value === 'false' &&
-				(
-					$this->request->method === 'GET' ||
-					strpos($this->request->getHeader('Content-Type'),
-						'application/x-www-form-urlencoded') !== false
-				)
-			) {
-				$value = false;
-			} elseif ($value !== null && \in_array($type, $types, true)) {
-				settype($value, $type);
-			}
-
-			$arguments[] = $value;
-		}
-
-		$response = \call_user_func_array([$controller, $methodName], $arguments);
-
-		// format response
-		if ($response instanceof DataResponse || !($response instanceof Response)) {
-
-			// get format from the url format or request format parameter
-			$format = $this->request->getParam('format');
-
-			// if none is given try the first Accept header
-			if ($format === null) {
-				$headers = $this->request->getHeader('Accept');
-				$format = $controller->getResponderByHTTPHeader($headers, null);
-			}
-
-			if ($format !== null) {
-				$response = $controller->buildResponse($response, $format);
-			} else {
-				$response = $controller->buildResponse($response);
-			}
-		}
-
-		return $response;
-	}
+    /** @var MiddlewareDispatcher */
+    private $middlewareDispatcher;
+
+    /** @var Http */
+    private $protocol;
+
+    /** @var ControllerMethodReflector */
+    private $reflector;
+
+    /** @var IRequest */
+    private $request;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var ConnectionAdapter */
+    private $connection;
+
+    /** @var LoggerInterface */
+    private $logger;
+
+    /**
+     * @param Http $protocol the http protocol with contains all status headers
+     * @param MiddlewareDispatcher $middlewareDispatcher the dispatcher which
+     * runs the middleware
+     * @param ControllerMethodReflector $reflector the reflector that is used to inject
+     * the arguments for the controller
+     * @param IRequest $request the incoming request
+     * @param IConfig $config
+     * @param ConnectionAdapter $connection
+     * @param LoggerInterface $logger
+     */
+    public function __construct(Http $protocol,
+                                MiddlewareDispatcher $middlewareDispatcher,
+                                ControllerMethodReflector $reflector,
+                                IRequest $request,
+                                IConfig $config,
+                                ConnectionAdapter $connection,
+                                LoggerInterface $logger) {
+        $this->protocol = $protocol;
+        $this->middlewareDispatcher = $middlewareDispatcher;
+        $this->reflector = $reflector;
+        $this->request = $request;
+        $this->config = $config;
+        $this->connection = $connection;
+        $this->logger = $logger;
+    }
+
+
+    /**
+     * Handles a request and calls the dispatcher on the controller
+     * @param Controller $controller the controller which will be called
+     * @param string $methodName the method name which will be called on
+     * the controller
+     * @return array $array[0] contains a string with the http main header,
+     * $array[1] contains headers in the form: $key => value, $array[2] contains
+     * the response output
+     * @throws \Exception
+     */
+    public function dispatch(Controller $controller, string $methodName): array {
+        $out = [null, [], null];
+
+        try {
+            // prefill reflector with everything thats needed for the
+            // middlewares
+            $this->reflector->reflect($controller, $methodName);
+
+            $this->middlewareDispatcher->beforeController($controller,
+                $methodName);
+
+            $databaseStatsBefore = [];
+            if ($this->config->getSystemValueBool('debug', false)) {
+                $databaseStatsBefore = $this->connection->getInner()->getStats();
+            }
+
+            $response = $this->executeController($controller, $methodName);
+
+            if (!empty($databaseStatsBefore)) {
+                $databaseStatsAfter = $this->connection->getInner()->getStats();
+                $numBuilt = $databaseStatsAfter['built'] - $databaseStatsBefore['built'];
+                $numExecuted = $databaseStatsAfter['executed'] - $databaseStatsBefore['executed'];
+
+                if ($numBuilt > 50) {
+                    $this->logger->debug('Controller {class}::{method} created {count} QueryBuilder objects, please check if they are created inside a loop by accident.' , [
+                        'class' => get_class($controller),
+                        'method' => $methodName,
+                        'count' => $numBuilt,
+                    ]);
+                }
+
+                if ($numExecuted > 100) {
+                    $this->logger->warning('Controller {class}::{method} executed {count} queries.' , [
+                        'class' => get_class($controller),
+                        'method' => $methodName,
+                        'count' => $numExecuted,
+                    ]);
+                }
+            }
+
+            // if an exception appears, the middleware checks if it can handle the
+            // exception and creates a response. If no response is created, it is
+            // assumed that theres no middleware who can handle it and the error is
+            // thrown again
+        } catch (\Exception $exception) {
+            $response = $this->middlewareDispatcher->afterException(
+                $controller, $methodName, $exception);
+        } catch (\Throwable $throwable) {
+            $exception = new \Exception($throwable->getMessage(), $throwable->getCode(), $throwable);
+            $response = $this->middlewareDispatcher->afterException(
+            $controller, $methodName, $exception);
+        }
+
+        $response = $this->middlewareDispatcher->afterController(
+            $controller, $methodName, $response);
+
+        // depending on the cache object the headers need to be changed
+        $out[0] = $this->protocol->getStatusHeader($response->getStatus());
+        $out[1] = array_merge($response->getHeaders());
+        $out[2] = $response->getCookies();
+        $out[3] = $this->middlewareDispatcher->beforeOutput(
+            $controller, $methodName, $response->render()
+        );
+        $out[4] = $response;
+
+        return $out;
+    }
+
+
+    /**
+     * Uses the reflected parameters, types and request parameters to execute
+     * the controller
+     * @param Controller $controller the controller to be executed
+     * @param string $methodName the method on the controller that should be executed
+     * @return Response
+     */
+    private function executeController(Controller $controller, string $methodName): Response {
+        $arguments = [];
+
+        // valid types that will be casted
+        $types = ['int', 'integer', 'bool', 'boolean', 'float'];
+
+        foreach ($this->reflector->getParameters() as $param => $default) {
+
+            // try to get the parameter from the request object and cast
+            // it to the type annotated in the @param annotation
+            $value = $this->request->getParam($param, $default);
+            $type = $this->reflector->getType($param);
+
+            // if this is submitted using GET or a POST form, 'false' should be
+            // converted to false
+            if (($type === 'bool' || $type === 'boolean') &&
+                $value === 'false' &&
+                (
+                    $this->request->method === 'GET' ||
+                    strpos($this->request->getHeader('Content-Type'),
+                        'application/x-www-form-urlencoded') !== false
+                )
+            ) {
+                $value = false;
+            } elseif ($value !== null && \in_array($type, $types, true)) {
+                settype($value, $type);
+            }
+
+            $arguments[] = $value;
+        }
+
+        $response = \call_user_func_array([$controller, $methodName], $arguments);
+
+        // format response
+        if ($response instanceof DataResponse || !($response instanceof Response)) {
+
+            // get format from the url format or request format parameter
+            $format = $this->request->getParam('format');
+
+            // if none is given try the first Accept header
+            if ($format === null) {
+                $headers = $this->request->getHeader('Accept');
+                $format = $controller->getResponderByHTTPHeader($headers, null);
+            }
+
+            if ($format !== null) {
+                $response = $controller->buildResponse($response, $format);
+            } else {
+                $response = $controller->buildResponse($response);
+            }
+        }
+
+        return $response;
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -132,7 +132,7 @@ 
 				$numExecuted = $databaseStatsAfter['executed'] - $databaseStatsBefore['executed'];
 
 				if ($numBuilt > 50) {
-					$this->logger->debug('Controller {class}::{method} created {count} QueryBuilder objects, please check if they are created inside a loop by accident.' , [
+					$this->logger->debug('Controller {class}::{method} created {count} QueryBuilder objects, please check if they are created inside a loop by accident.', [
 						'class' => get_class($controller),
 						'method' => $methodName,
 						'count' => $numBuilt,
@@ -140,7 +140,7 @@ 
 				}
 
 				if ($numExecuted > 100) {
-					$this->logger->warning('Controller {class}::{method} executed {count} queries.' , [
+					$this->logger->warning('Controller {class}::{method} executed {count} queries.', [
 						'class' => get_class($controller),
 						'method' => $methodName,
 						'count' => $numExecuted,

lib/private/AppFramework/Routing/RouteConfig.php

Indentation +252 added lines, -252 removed lines

@@ -39,258 +39,258 @@
  * @package OC\AppFramework\routing
  */
 class RouteConfig {
-	/** @var DIContainer */
-	private $container;
-
-	/** @var Router */
-	private $router;
-
-	/** @var array */
-	private $routes;
-
-	/** @var string */
-	private $appName;
-
-	/** @var string[] */
-	private $controllerNameCache = [];
-
-	protected $rootUrlApps = [
-		'cloud_federation_api',
-		'core',
-		'files_sharing',
-		'files',
-		'settings',
-		'spreed',
-	];
-
-	/**
-	 * @param \OC\AppFramework\DependencyInjection\DIContainer $container
-	 * @param \OC\Route\Router $router
-	 * @param array $routes
-	 * @internal param $appName
-	 */
-	public function __construct(DIContainer $container, Router $router, $routes) {
-		$this->routes = $routes;
-		$this->container = $container;
-		$this->router = $router;
-		$this->appName = $container['AppName'];
-	}
-
-	/**
-	 * The routes and resource will be registered to the \OCP\Route\IRouter
-	 */
-	public function register() {
-
-		// parse simple
-		$this->processIndexRoutes($this->routes);
-
-		// parse resources
-		$this->processIndexResources($this->routes);
-
-		/*
+    /** @var DIContainer */
+    private $container;
+
+    /** @var Router */
+    private $router;
+
+    /** @var array */
+    private $routes;
+
+    /** @var string */
+    private $appName;
+
+    /** @var string[] */
+    private $controllerNameCache = [];
+
+    protected $rootUrlApps = [
+        'cloud_federation_api',
+        'core',
+        'files_sharing',
+        'files',
+        'settings',
+        'spreed',
+    ];
+
+    /**
+     * @param \OC\AppFramework\DependencyInjection\DIContainer $container
+     * @param \OC\Route\Router $router
+     * @param array $routes
+     * @internal param $appName
+     */
+    public function __construct(DIContainer $container, Router $router, $routes) {
+        $this->routes = $routes;
+        $this->container = $container;
+        $this->router = $router;
+        $this->appName = $container['AppName'];
+    }
+
+    /**
+     * The routes and resource will be registered to the \OCP\Route\IRouter
+     */
+    public function register() {
+
+        // parse simple
+        $this->processIndexRoutes($this->routes);
+
+        // parse resources
+        $this->processIndexResources($this->routes);
+
+        /*
 		 * OCS routes go into a different collection
 		 */
-		$oldCollection = $this->router->getCurrentCollection();
-		$this->router->useCollection($oldCollection . '.ocs');
-
-		// parse ocs simple routes
-		$this->processOCS($this->routes);
-
-		// parse ocs simple routes
-		$this->processOCSResources($this->routes);
-
-		$this->router->useCollection($oldCollection);
-	}
-
-	private function processOCS(array $routes): void {
-		$ocsRoutes = $routes['ocs'] ?? [];
-		foreach ($ocsRoutes as $ocsRoute) {
-			$this->processRoute($ocsRoute, 'ocs.');
-		}
-	}
-
-	/**
-	 * Creates one route base on the give configuration
-	 * @param array $routes
-	 * @throws \UnexpectedValueException
-	 */
-	private function processIndexRoutes(array $routes): void {
-		$simpleRoutes = $routes['routes'] ?? [];
-		foreach ($simpleRoutes as $simpleRoute) {
-			$this->processRoute($simpleRoute);
-		}
-	}
-
-	protected function processRoute(array $route, string $routeNamePrefix = ''): void {
-		$name = $route['name'];
-		$postfix = $route['postfix'] ?? '';
-		$root = $this->buildRootPrefix($route, $routeNamePrefix);
-
-		$url = $root . '/' . ltrim($route['url'], '/');
-		$verb = strtoupper($route['verb'] ?? 'GET');
-
-		$split = explode('#', $name, 2);
-		if (count($split) !== 2) {
-			throw new \UnexpectedValueException('Invalid route name');
-		}
-		list($controller, $action) = $split;
-
-		$controllerName = $this->buildControllerName($controller);
-		$actionName = $this->buildActionName($action);
-
-		$routeName = $routeNamePrefix . $this->appName . '.' . $controller . '.' . $action . $postfix;
-
-		$router = $this->router->create($routeName, $url)
-			->method($verb);
-
-		// optionally register requirements for route. This is used to
-		// tell the route parser how url parameters should be matched
-		if (array_key_exists('requirements', $route)) {
-			$router->requirements($route['requirements']);
-		}
-
-		// optionally register defaults for route. This is used to
-		// tell the route parser how url parameters should be default valued
-		$defaults = [];
-		if (array_key_exists('defaults', $route)) {
-			$defaults = $route['defaults'];
-		}
-
-		$defaults['caller'] = [$this->appName, $controllerName, $actionName];
-		$router->defaults($defaults);
-	}
-
-	/**
-	 * For a given name and url restful OCS routes are created:
-	 *  - index
-	 *  - show
-	 *  - create
-	 *  - update
-	 *  - destroy
-	 *
-	 * @param array $routes
-	 */
-	private function processOCSResources(array $routes): void {
-		$this->processResources($routes['ocs-resources'] ?? [], 'ocs.');
-	}
-
-	/**
-	 * For a given name and url restful routes are created:
-	 *  - index
-	 *  - show
-	 *  - create
-	 *  - update
-	 *  - destroy
-	 *
-	 * @param array $routes
-	 */
-	private function processIndexResources(array $routes): void {
-		$this->processResources($routes['resources'] ?? []);
-	}
-
-	/**
-	 * For a given name and url restful routes are created:
-	 *  - index
-	 *  - show
-	 *  - create
-	 *  - update
-	 *  - destroy
-	 *
-	 * @param array $resources
-	 * @param string $routeNamePrefix
-	 */
-	protected function processResources(array $resources, string $routeNamePrefix = ''): void {
-		// declaration of all restful actions
-		$actions = [
-			['name' => 'index', 'verb' => 'GET', 'on-collection' => true],
-			['name' => 'show', 'verb' => 'GET'],
-			['name' => 'create', 'verb' => 'POST', 'on-collection' => true],
-			['name' => 'update', 'verb' => 'PUT'],
-			['name' => 'destroy', 'verb' => 'DELETE'],
-		];
-
-		foreach ($resources as $resource => $config) {
-			$root = $this->buildRootPrefix($config, $routeNamePrefix);
-
-			// the url parameter used as id to the resource
-			foreach ($actions as $action) {
-				$url = $root . '/' . ltrim($config['url'], '/');
-				$method = $action['name'];
-
-				$verb = strtoupper($action['verb'] ?? 'GET');
-				$collectionAction = $action['on-collection'] ?? false;
-				if (!$collectionAction) {
-					$url .= '/{id}';
-				}
-				if (isset($action['url-postfix'])) {
-					$url .= '/' . $action['url-postfix'];
-				}
-
-				$controller = $resource;
-
-				$controllerName = $this->buildControllerName($controller);
-				$actionName = $this->buildActionName($method);
-
-				$routeName = $routeNamePrefix . $this->appName . '.' . strtolower($resource) . '.' . $method;
-
-				$route = $this->router->create($routeName, $url)
-					->method($verb);
-
-				$route->defaults(['caller' => [$this->appName, $controllerName, $actionName]]);
-			}
-		}
-	}
-
-	private function buildRootPrefix(array $route, string $routeNamePrefix): string {
-		$defaultRoot = $this->appName === 'core' ? '' : '/apps/' . $this->appName;
-		$root = $route['root'] ?? $defaultRoot;
-
-		if ($routeNamePrefix !== '') {
-			// In OCS all apps are whitelisted
-			return $root;
-		}
-
-		if (!\in_array($this->appName, $this->rootUrlApps, true)) {
-			// Only allow root URLS for some apps
-			return  $defaultRoot;
-		}
-
-		return $root;
-	}
-
-	/**
-	 * Based on a given route name the controller name is generated
-	 * @param string $controller
-	 * @return string
-	 */
-	private function buildControllerName(string $controller): string {
-		if (!isset($this->controllerNameCache[$controller])) {
-			$this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
-		}
-		return $this->controllerNameCache[$controller];
-	}
-
-	/**
-	 * Based on the action part of the route name the controller method name is generated
-	 * @param string $action
-	 * @return string
-	 */
-	private function buildActionName(string $action): string {
-		return $this->underScoreToCamelCase($action);
-	}
-
-	/**
-	 * Underscored strings are converted to camel case strings
-	 * @param string $str
-	 * @return string
-	 */
-	private function underScoreToCamelCase(string $str): string {
-		$pattern = '/_[a-z]?/';
-		return preg_replace_callback(
-			$pattern,
-			function ($matches) {
-				return strtoupper(ltrim($matches[0], '_'));
-			},
-			$str);
-	}
+        $oldCollection = $this->router->getCurrentCollection();
+        $this->router->useCollection($oldCollection . '.ocs');
+
+        // parse ocs simple routes
+        $this->processOCS($this->routes);
+
+        // parse ocs simple routes
+        $this->processOCSResources($this->routes);
+
+        $this->router->useCollection($oldCollection);
+    }
+
+    private function processOCS(array $routes): void {
+        $ocsRoutes = $routes['ocs'] ?? [];
+        foreach ($ocsRoutes as $ocsRoute) {
+            $this->processRoute($ocsRoute, 'ocs.');
+        }
+    }
+
+    /**
+     * Creates one route base on the give configuration
+     * @param array $routes
+     * @throws \UnexpectedValueException
+     */
+    private function processIndexRoutes(array $routes): void {
+        $simpleRoutes = $routes['routes'] ?? [];
+        foreach ($simpleRoutes as $simpleRoute) {
+            $this->processRoute($simpleRoute);
+        }
+    }
+
+    protected function processRoute(array $route, string $routeNamePrefix = ''): void {
+        $name = $route['name'];
+        $postfix = $route['postfix'] ?? '';
+        $root = $this->buildRootPrefix($route, $routeNamePrefix);
+
+        $url = $root . '/' . ltrim($route['url'], '/');
+        $verb = strtoupper($route['verb'] ?? 'GET');
+
+        $split = explode('#', $name, 2);
+        if (count($split) !== 2) {
+            throw new \UnexpectedValueException('Invalid route name');
+        }
+        list($controller, $action) = $split;
+
+        $controllerName = $this->buildControllerName($controller);
+        $actionName = $this->buildActionName($action);
+
+        $routeName = $routeNamePrefix . $this->appName . '.' . $controller . '.' . $action . $postfix;
+
+        $router = $this->router->create($routeName, $url)
+            ->method($verb);
+
+        // optionally register requirements for route. This is used to
+        // tell the route parser how url parameters should be matched
+        if (array_key_exists('requirements', $route)) {
+            $router->requirements($route['requirements']);
+        }
+
+        // optionally register defaults for route. This is used to
+        // tell the route parser how url parameters should be default valued
+        $defaults = [];
+        if (array_key_exists('defaults', $route)) {
+            $defaults = $route['defaults'];
+        }
+
+        $defaults['caller'] = [$this->appName, $controllerName, $actionName];
+        $router->defaults($defaults);
+    }
+
+    /**
+     * For a given name and url restful OCS routes are created:
+     *  - index
+     *  - show
+     *  - create
+     *  - update
+     *  - destroy
+     *
+     * @param array $routes
+     */
+    private function processOCSResources(array $routes): void {
+        $this->processResources($routes['ocs-resources'] ?? [], 'ocs.');
+    }
+
+    /**
+     * For a given name and url restful routes are created:
+     *  - index
+     *  - show
+     *  - create
+     *  - update
+     *  - destroy
+     *
+     * @param array $routes
+     */
+    private function processIndexResources(array $routes): void {
+        $this->processResources($routes['resources'] ?? []);
+    }
+
+    /**
+     * For a given name and url restful routes are created:
+     *  - index
+     *  - show
+     *  - create
+     *  - update
+     *  - destroy
+     *
+     * @param array $resources
+     * @param string $routeNamePrefix
+     */
+    protected function processResources(array $resources, string $routeNamePrefix = ''): void {
+        // declaration of all restful actions
+        $actions = [
+            ['name' => 'index', 'verb' => 'GET', 'on-collection' => true],
+            ['name' => 'show', 'verb' => 'GET'],
+            ['name' => 'create', 'verb' => 'POST', 'on-collection' => true],
+            ['name' => 'update', 'verb' => 'PUT'],
+            ['name' => 'destroy', 'verb' => 'DELETE'],
+        ];
+
+        foreach ($resources as $resource => $config) {
+            $root = $this->buildRootPrefix($config, $routeNamePrefix);
+
+            // the url parameter used as id to the resource
+            foreach ($actions as $action) {
+                $url = $root . '/' . ltrim($config['url'], '/');
+                $method = $action['name'];
+
+                $verb = strtoupper($action['verb'] ?? 'GET');
+                $collectionAction = $action['on-collection'] ?? false;
+                if (!$collectionAction) {
+                    $url .= '/{id}';
+                }
+                if (isset($action['url-postfix'])) {
+                    $url .= '/' . $action['url-postfix'];
+                }
+
+                $controller = $resource;
+
+                $controllerName = $this->buildControllerName($controller);
+                $actionName = $this->buildActionName($method);
+
+                $routeName = $routeNamePrefix . $this->appName . '.' . strtolower($resource) . '.' . $method;
+
+                $route = $this->router->create($routeName, $url)
+                    ->method($verb);
+
+                $route->defaults(['caller' => [$this->appName, $controllerName, $actionName]]);
+            }
+        }
+    }
+
+    private function buildRootPrefix(array $route, string $routeNamePrefix): string {
+        $defaultRoot = $this->appName === 'core' ? '' : '/apps/' . $this->appName;
+        $root = $route['root'] ?? $defaultRoot;
+
+        if ($routeNamePrefix !== '') {
+            // In OCS all apps are whitelisted
+            return $root;
+        }
+
+        if (!\in_array($this->appName, $this->rootUrlApps, true)) {
+            // Only allow root URLS for some apps
+            return  $defaultRoot;
+        }
+
+        return $root;
+    }
+
+    /**
+     * Based on a given route name the controller name is generated
+     * @param string $controller
+     * @return string
+     */
+    private function buildControllerName(string $controller): string {
+        if (!isset($this->controllerNameCache[$controller])) {
+            $this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
+        }
+        return $this->controllerNameCache[$controller];
+    }
+
+    /**
+     * Based on the action part of the route name the controller method name is generated
+     * @param string $action
+     * @return string
+     */
+    private function buildActionName(string $action): string {
+        return $this->underScoreToCamelCase($action);
+    }
+
+    /**
+     * Underscored strings are converted to camel case strings
+     * @param string $str
+     * @return string
+     */
+    private function underScoreToCamelCase(string $str): string {
+        $pattern = '/_[a-z]?/';
+        return preg_replace_callback(
+            $pattern,
+            function ($matches) {
+                return strtoupper(ltrim($matches[0], '_'));
+            },
+            $str);
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -91,7 +91,7 @@ 
 		 * OCS routes go into a different collection
 		 */
 		$oldCollection = $this->router->getCurrentCollection();
-		$this->router->useCollection($oldCollection . '.ocs');
+		$this->router->useCollection($oldCollection.'.ocs');
 
 		// parse ocs simple routes
 		$this->processOCS($this->routes);
@@ -126,7 +126,7 @@ 
 		$postfix = $route['postfix'] ?? '';
 		$root = $this->buildRootPrefix($route, $routeNamePrefix);
 
-		$url = $root . '/' . ltrim($route['url'], '/');
+		$url = $root.'/'.ltrim($route['url'], '/');
 		$verb = strtoupper($route['verb'] ?? 'GET');
 
 		$split = explode('#', $name, 2);
@@ -138,7 +138,7 @@ 
 		$controllerName = $this->buildControllerName($controller);
 		$actionName = $this->buildActionName($action);
 
-		$routeName = $routeNamePrefix . $this->appName . '.' . $controller . '.' . $action . $postfix;
+		$routeName = $routeNamePrefix.$this->appName.'.'.$controller.'.'.$action.$postfix;
 
 		$router = $this->router->create($routeName, $url)
 			->method($verb);
@@ -214,7 +214,7 @@ 
 
 			// the url parameter used as id to the resource
 			foreach ($actions as $action) {
-				$url = $root . '/' . ltrim($config['url'], '/');
+				$url = $root.'/'.ltrim($config['url'], '/');
 				$method = $action['name'];
 
 				$verb = strtoupper($action['verb'] ?? 'GET');
@@ -223,7 +223,7 @@ 
 					$url .= '/{id}';
 				}
 				if (isset($action['url-postfix'])) {
-					$url .= '/' . $action['url-postfix'];
+					$url .= '/'.$action['url-postfix'];
 				}
 
 				$controller = $resource;
@@ -231,7 +231,7 @@ 
 				$controllerName = $this->buildControllerName($controller);
 				$actionName = $this->buildActionName($method);
 
-				$routeName = $routeNamePrefix . $this->appName . '.' . strtolower($resource) . '.' . $method;
+				$routeName = $routeNamePrefix.$this->appName.'.'.strtolower($resource).'.'.$method;
 
 				$route = $this->router->create($routeName, $url)
 					->method($verb);
@@ -242,7 +242,7 @@ 
 	}
 
 	private function buildRootPrefix(array $route, string $routeNamePrefix): string {
-		$defaultRoot = $this->appName === 'core' ? '' : '/apps/' . $this->appName;
+		$defaultRoot = $this->appName === 'core' ? '' : '/apps/'.$this->appName;
 		$root = $route['root'] ?? $defaultRoot;
 
 		if ($routeNamePrefix !== '') {
@@ -265,7 +265,7 @@ 
 	 */
 	private function buildControllerName(string $controller): string {
 		if (!isset($this->controllerNameCache[$controller])) {
-			$this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
+			$this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)).'Controller';
 		}
 		return $this->controllerNameCache[$controller];
 	}
@@ -288,7 +288,7 @@ 
 		$pattern = '/_[a-z]?/';
 		return preg_replace_callback(
 			$pattern,
-			function ($matches) {
+			function($matches) {
 				return strtoupper(ltrim($matches[0], '_'));
 			},
 			$str);

lib/private/Collaboration/Collaborators/Search.php

Indentation +63 added lines, -63 removed lines

@@ -35,79 +35,79 @@
 use OCP\Share;
 
 class Search implements ISearch {
-	/** @var IContainer */
-	private $c;
+    /** @var IContainer */
+    private $c;
 
-	protected $pluginList = [];
+    protected $pluginList = [];
 
-	public function __construct(IContainer $c) {
-		$this->c = $c;
-	}
+    public function __construct(IContainer $c) {
+        $this->c = $c;
+    }
 
-	/**
-	 * @param string $search
-	 * @param array $shareTypes
-	 * @param bool $lookup
-	 * @param int|null $limit
-	 * @param int|null $offset
-	 * @return array
-	 * @throws \OCP\AppFramework\QueryException
-	 */
-	public function search($search, array $shareTypes, $lookup, $limit, $offset) {
-		$hasMoreResults = false;
+    /**
+     * @param string $search
+     * @param array $shareTypes
+     * @param bool $lookup
+     * @param int|null $limit
+     * @param int|null $offset
+     * @return array
+     * @throws \OCP\AppFramework\QueryException
+     */
+    public function search($search, array $shareTypes, $lookup, $limit, $offset) {
+        $hasMoreResults = false;
 
-		// Trim leading and trailing whitespace characters, e.g. when query is copy-pasted
-		$search = trim($search);
+        // Trim leading and trailing whitespace characters, e.g. when query is copy-pasted
+        $search = trim($search);
 
-		/** @var ISearchResult $searchResult */
-		$searchResult = $this->c->resolve(SearchResult::class);
+        /** @var ISearchResult $searchResult */
+        $searchResult = $this->c->resolve(SearchResult::class);
 
-		foreach ($shareTypes as $type) {
-			if (!isset($this->pluginList[$type])) {
-				continue;
-			}
-			foreach ($this->pluginList[$type] as $plugin) {
-				/** @var ISearchPlugin $searchPlugin */
-				$searchPlugin = $this->c->resolve($plugin);
-				$hasMoreResults = $searchPlugin->search($search, $limit, $offset, $searchResult) || $hasMoreResults;
-			}
-		}
+        foreach ($shareTypes as $type) {
+            if (!isset($this->pluginList[$type])) {
+                continue;
+            }
+            foreach ($this->pluginList[$type] as $plugin) {
+                /** @var ISearchPlugin $searchPlugin */
+                $searchPlugin = $this->c->resolve($plugin);
+                $hasMoreResults = $searchPlugin->search($search, $limit, $offset, $searchResult) || $hasMoreResults;
+            }
+        }
 
-		// Get from lookup server, not a separate share type
-		if ($lookup) {
-			$searchPlugin = $this->c->resolve(LookupPlugin::class);
-			$hasMoreResults = $searchPlugin->search($search, $limit, $offset, $searchResult) || $hasMoreResults;
-		}
+        // Get from lookup server, not a separate share type
+        if ($lookup) {
+            $searchPlugin = $this->c->resolve(LookupPlugin::class);
+            $hasMoreResults = $searchPlugin->search($search, $limit, $offset, $searchResult) || $hasMoreResults;
+        }
 
-		// sanitizing, could go into the plugins as well
+        // sanitizing, could go into the plugins as well
 
-		// if we have a exact match, either for the federated cloud id or for the
-		// email address we only return the exact match. It is highly unlikely
-		// that the exact same email address and federated cloud id exists
-		$emailType = new SearchResultType('emails');
-		$remoteType = new SearchResultType('remotes');
-		if ($searchResult->hasExactIdMatch($emailType) && !$searchResult->hasExactIdMatch($remoteType)) {
-			$searchResult->unsetResult($remoteType);
-		} elseif (!$searchResult->hasExactIdMatch($emailType) && $searchResult->hasExactIdMatch($remoteType)) {
-			$searchResult->unsetResult($emailType);
-		}
+        // if we have a exact match, either for the federated cloud id or for the
+        // email address we only return the exact match. It is highly unlikely
+        // that the exact same email address and federated cloud id exists
+        $emailType = new SearchResultType('emails');
+        $remoteType = new SearchResultType('remotes');
+        if ($searchResult->hasExactIdMatch($emailType) && !$searchResult->hasExactIdMatch($remoteType)) {
+            $searchResult->unsetResult($remoteType);
+        } elseif (!$searchResult->hasExactIdMatch($emailType) && $searchResult->hasExactIdMatch($remoteType)) {
+            $searchResult->unsetResult($emailType);
+        }
 
-		// if we have an exact local user match with an email-a-like query,
-		// there is no need to show the remote and email matches.
-		$userType = new SearchResultType('users');
-		if (strpos($search, '@') !== false && $searchResult->hasExactIdMatch($userType)) {
-			$searchResult->unsetResult($remoteType);
-			$searchResult->unsetResult($emailType);
-		}
+        // if we have an exact local user match with an email-a-like query,
+        // there is no need to show the remote and email matches.
+        $userType = new SearchResultType('users');
+        if (strpos($search, '@') !== false && $searchResult->hasExactIdMatch($userType)) {
+            $searchResult->unsetResult($remoteType);
+            $searchResult->unsetResult($emailType);
+        }
 
-		return [$searchResult->asArray(), $hasMoreResults];
-	}
+        return [$searchResult->asArray(), $hasMoreResults];
+    }
 
-	public function registerPlugin(array $pluginInfo) {
-		$shareType = constant(Share::class . '::' . $pluginInfo['shareType']);
-		if ($shareType === null) {
-			throw new \InvalidArgumentException('Provided ShareType is invalid');
-		}
-		$this->pluginList[$shareType][] = $pluginInfo['class'];
-	}
+    public function registerPlugin(array $pluginInfo) {
+        $shareType = constant(Share::class . '::' . $pluginInfo['shareType']);
+        if ($shareType === null) {
+            throw new \InvalidArgumentException('Provided ShareType is invalid');
+        }
+        $this->pluginList[$shareType][] = $pluginInfo['class'];
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -104,7 +104,7 @@
 	}
 
 	public function registerPlugin(array $pluginInfo) {
-		$shareType = constant(Share::class . '::' . $pluginInfo['shareType']);
+		$shareType = constant(Share::class.'::'.$pluginInfo['shareType']);
 		if ($shareType === null) {
 			throw new \InvalidArgumentException('Provided ShareType is invalid');
 		}

lib/private/L10N/Factory.php

Indentation +636 added lines, -636 removed lines

@@ -49,640 +49,640 @@
  */
 class Factory implements IFactory {
 
-	/** @var string */
-	protected $requestLanguage = '';
-
-	/**
-	 * cached instances
-	 * @var array Structure: Lang => App => \OCP\IL10N
-	 */
-	protected $instances = [];
-
-	/**
-	 * @var array Structure: App => string[]
-	 */
-	protected $availableLanguages = [];
-
-	/**
-	 * @var array
-	 */
-	protected $localeCache = [];
-
-	/**
-	 * @var array
-	 */
-	protected $availableLocales = [];
-
-	/**
-	 * @var array Structure: string => callable
-	 */
-	protected $pluralFunctions = [];
-
-	public const COMMON_LANGUAGE_CODES = [
-		'en', 'es', 'fr', 'de', 'de_DE', 'ja', 'ar', 'ru', 'nl', 'it',
-		'pt_BR', 'pt_PT', 'da', 'fi_FI', 'nb_NO', 'sv', 'tr', 'zh_CN', 'ko'
-	];
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IRequest */
-	protected $request;
-
-	/** @var IUserSession */
-	protected $userSession;
-
-	/** @var string */
-	protected $serverRoot;
-
-	/**
-	 * @param IConfig $config
-	 * @param IRequest $request
-	 * @param IUserSession $userSession
-	 * @param string $serverRoot
-	 */
-	public function __construct(IConfig $config,
-								IRequest $request,
-								IUserSession $userSession,
-								$serverRoot) {
-		$this->config = $config;
-		$this->request = $request;
-		$this->userSession = $userSession;
-		$this->serverRoot = $serverRoot;
-	}
-
-	/**
-	 * Get a language instance
-	 *
-	 * @param string $app
-	 * @param string|null $lang
-	 * @param string|null $locale
-	 * @return \OCP\IL10N
-	 */
-	public function get($app, $lang = null, $locale = null) {
-		return new LazyL10N(function () use ($app, $lang, $locale) {
-			$app = \OC_App::cleanAppId($app);
-			if ($lang !== null) {
-				$lang = str_replace(['\0', '/', '\\', '..'], '', $lang);
-			}
-
-			$forceLang = $this->config->getSystemValue('force_language', false);
-			if (is_string($forceLang)) {
-				$lang = $forceLang;
-			}
-
-			$forceLocale = $this->config->getSystemValue('force_locale', false);
-			if (is_string($forceLocale)) {
-				$locale = $forceLocale;
-			}
-
-			if ($lang === null || !$this->languageExists($app, $lang)) {
-				$lang = $this->findLanguage($app);
-			}
-
-			if ($locale === null || !$this->localeExists($locale)) {
-				$locale = $this->findLocale($lang);
-			}
-
-			if (!isset($this->instances[$lang][$app])) {
-				$this->instances[$lang][$app] = new L10N(
-					$this, $app, $lang, $locale,
-					$this->getL10nFilesForApp($app, $lang)
-				);
-			}
-
-			return $this->instances[$lang][$app];
-		});
-	}
-
-	/**
-	 * Find the best language
-	 *
-	 * @param string|null $app App id or null for core
-	 * @return string language If nothing works it returns 'en'
-	 */
-	public function findLanguage($app = null) {
-		$forceLang = $this->config->getSystemValue('force_language', false);
-		if (is_string($forceLang)) {
-			$this->requestLanguage = $forceLang;
-		}
-
-		if ($this->requestLanguage !== '' && $this->languageExists($app, $this->requestLanguage)) {
-			return $this->requestLanguage;
-		}
-
-		/**
-		 * At this point Nextcloud might not yet be installed and thus the lookup
-		 * in the preferences table might fail. For this reason we need to check
-		 * whether the instance has already been installed
-		 *
-		 * @link https://github.com/owncloud/core/issues/21955
-		 */
-		if ($this->config->getSystemValue('installed', false)) {
-			$userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() :  null;
-			if (!is_null($userId)) {
-				$userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
-			} else {
-				$userLang = null;
-			}
-		} else {
-			$userId = null;
-			$userLang = null;
-		}
-
-		if ($userLang) {
-			$this->requestLanguage = $userLang;
-			if ($this->languageExists($app, $userLang)) {
-				return $userLang;
-			}
-		}
-
-		try {
-			// Try to get the language from the Request
-			$lang = $this->getLanguageFromRequest($app);
-			if ($userId !== null && $app === null && !$userLang) {
-				$this->config->setUserValue($userId, 'core', 'lang', $lang);
-			}
-			return $lang;
-		} catch (LanguageNotFoundException $e) {
-			// Finding language from request failed fall back to default language
-			$defaultLanguage = $this->config->getSystemValue('default_language', false);
-			if ($defaultLanguage !== false && $this->languageExists($app, $defaultLanguage)) {
-				return $defaultLanguage;
-			}
-		}
-
-		// We could not find any language so fall back to english
-		return 'en';
-	}
-
-	/**
-	 * find the best locale
-	 *
-	 * @param string $lang
-	 * @return null|string
-	 */
-	public function findLocale($lang = null) {
-		$forceLocale = $this->config->getSystemValue('force_locale', false);
-		if (is_string($forceLocale) && $this->localeExists($forceLocale)) {
-			return $forceLocale;
-		}
-
-		if ($this->config->getSystemValue('installed', false)) {
-			$userId = null !== $this->userSession->getUser() ? $this->userSession->getUser()->getUID() :  null;
-			$userLocale = null;
-			if (null !== $userId) {
-				$userLocale = $this->config->getUserValue($userId, 'core', 'locale', null);
-			}
-		} else {
-			$userId = null;
-			$userLocale = null;
-		}
-
-		if ($userLocale && $this->localeExists($userLocale)) {
-			return $userLocale;
-		}
-
-		// Default : use system default locale
-		$defaultLocale = $this->config->getSystemValue('default_locale', false);
-		if ($defaultLocale !== false && $this->localeExists($defaultLocale)) {
-			return $defaultLocale;
-		}
-
-		// If no user locale set, use lang as locale
-		if (null !== $lang && $this->localeExists($lang)) {
-			return $lang;
-		}
-
-		// At last, return USA
-		return 'en_US';
-	}
-
-	/**
-	 * find the matching lang from the locale
-	 *
-	 * @param string $app
-	 * @param string $locale
-	 * @return null|string
-	 */
-	public function findLanguageFromLocale(string $app = 'core', string $locale = null) {
-		if ($this->languageExists($app, $locale)) {
-			return $locale;
-		}
-
-		// Try to split e.g: fr_FR => fr
-		$locale = explode('_', $locale)[0];
-		if ($this->languageExists($app, $locale)) {
-			return $locale;
-		}
-	}
-
-	/**
-	 * Find all available languages for an app
-	 *
-	 * @param string|null $app App id or null for core
-	 * @return array an array of available languages
-	 */
-	public function findAvailableLanguages($app = null) {
-		$key = $app;
-		if ($key === null) {
-			$key = 'null';
-		}
-
-		// also works with null as key
-		if (!empty($this->availableLanguages[$key])) {
-			return $this->availableLanguages[$key];
-		}
-
-		$available = ['en']; //english is always available
-		$dir = $this->findL10nDir($app);
-		if (is_dir($dir)) {
-			$files = scandir($dir);
-			if ($files !== false) {
-				foreach ($files as $file) {
-					if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
-						$available[] = substr($file, 0, -5);
-					}
-				}
-			}
-		}
-
-		// merge with translations from theme
-		$theme = $this->config->getSystemValue('theme');
-		if (!empty($theme)) {
-			$themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
-
-			if (is_dir($themeDir)) {
-				$files = scandir($themeDir);
-				if ($files !== false) {
-					foreach ($files as $file) {
-						if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
-							$available[] = substr($file, 0, -5);
-						}
-					}
-				}
-			}
-		}
-
-		$this->availableLanguages[$key] = $available;
-		return $available;
-	}
-
-	/**
-	 * @return array|mixed
-	 */
-	public function findAvailableLocales() {
-		if (!empty($this->availableLocales)) {
-			return $this->availableLocales;
-		}
-
-		$localeData = file_get_contents(\OC::$SERVERROOT . '/resources/locales.json');
-		$this->availableLocales = \json_decode($localeData, true);
-
-		return $this->availableLocales;
-	}
-
-	/**
-	 * @param string|null $app App id or null for core
-	 * @param string $lang
-	 * @return bool
-	 */
-	public function languageExists($app, $lang) {
-		if ($lang === 'en') {//english is always available
-			return true;
-		}
-
-		$languages = $this->findAvailableLanguages($app);
-		return array_search($lang, $languages) !== false;
-	}
-
-	public function getLanguageIterator(IUser $user = null): ILanguageIterator {
-		$user = $user ?? $this->userSession->getUser();
-		if ($user === null) {
-			throw new \RuntimeException('Failed to get an IUser instance');
-		}
-		return new LanguageIterator($user, $this->config);
-	}
-
-	/**
-	 * Return the language to use when sending something to a user
-	 *
-	 * @param IUser|null $user
-	 * @return string
-	 * @since 20.0.0
-	 */
-	public function getUserLanguage(IUser $user = null): string {
-		$language = $this->config->getSystemValue('force_language', false);
-		if ($language !== false) {
-			return $language;
-		}
-
-		if ($user instanceof IUser) {
-			$language = $this->config->getUserValue($user->getUID(), 'core', 'lang', null);
-			if ($language !== null) {
-				return $language;
-			}
-		}
-
-		return $this->config->getSystemValue('default_language', 'en');
-	}
-
-	/**
-	 * @param string $locale
-	 * @return bool
-	 */
-	public function localeExists($locale) {
-		if ($locale === 'en') { //english is always available
-			return true;
-		}
-
-		if ($this->localeCache === []) {
-			$locales = $this->findAvailableLocales();
-			foreach ($locales as $l) {
-				$this->localeCache[$l['code']] = true;
-			}
-		}
-
-		return isset($this->localeCache[$locale]);
-	}
-
-	/**
-	 * @param string|null $app
-	 * @return string
-	 * @throws LanguageNotFoundException
-	 */
-	private function getLanguageFromRequest($app) {
-		$header = $this->request->getHeader('ACCEPT_LANGUAGE');
-		if ($header !== '') {
-			$available = $this->findAvailableLanguages($app);
-
-			// E.g. make sure that 'de' is before 'de_DE'.
-			sort($available);
-
-			$preferences = preg_split('/,\s*/', strtolower($header));
-			foreach ($preferences as $preference) {
-				list($preferred_language) = explode(';', $preference);
-				$preferred_language = str_replace('-', '_', $preferred_language);
-
-				foreach ($available as $available_language) {
-					if ($preferred_language === strtolower($available_language)) {
-						return $this->respectDefaultLanguage($app, $available_language);
-					}
-				}
-
-				// Fallback from de_De to de
-				foreach ($available as $available_language) {
-					if (substr($preferred_language, 0, 2) === $available_language) {
-						return $available_language;
-					}
-				}
-			}
-		}
-
-		throw new LanguageNotFoundException();
-	}
-
-	/**
-	 * if default language is set to de_DE (formal German) this should be
-	 * preferred to 'de' (non-formal German) if possible
-	 *
-	 * @param string|null $app
-	 * @param string $lang
-	 * @return string
-	 */
-	protected function respectDefaultLanguage($app, $lang) {
-		$result = $lang;
-		$defaultLanguage = $this->config->getSystemValue('default_language', false);
-
-		// use formal version of german ("Sie" instead of "Du") if the default
-		// language is set to 'de_DE' if possible
-		if (is_string($defaultLanguage) &&
-			strtolower($lang) === 'de' &&
-			strtolower($defaultLanguage) === 'de_de' &&
-			$this->languageExists($app, 'de_DE')
-		) {
-			$result = 'de_DE';
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Checks if $sub is a subdirectory of $parent
-	 *
-	 * @param string $sub
-	 * @param string $parent
-	 * @return bool
-	 */
-	private function isSubDirectory($sub, $parent) {
-		// Check whether $sub contains no ".."
-		if (strpos($sub, '..') !== false) {
-			return false;
-		}
-
-		// Check whether $sub is a subdirectory of $parent
-		if (strpos($sub, $parent) === 0) {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get a list of language files that should be loaded
-	 *
-	 * @param string $app
-	 * @param string $lang
-	 * @return string[]
-	 */
-	// FIXME This method is only public, until OC_L10N does not need it anymore,
-	// FIXME This is also the reason, why it is not in the public interface
-	public function getL10nFilesForApp($app, $lang) {
-		$languageFiles = [];
-
-		$i18nDir = $this->findL10nDir($app);
-		$transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';
-
-		if (($this->isSubDirectory($transFile, $this->serverRoot . '/core/l10n/')
-				|| $this->isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/')
-				|| $this->isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/')
-			)
-			&& file_exists($transFile)) {
-			// load the translations file
-			$languageFiles[] = $transFile;
-		}
-
-		// merge with translations from theme
-		$theme = $this->config->getSystemValue('theme');
-		if (!empty($theme)) {
-			$transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
-			if (file_exists($transFile)) {
-				$languageFiles[] = $transFile;
-			}
-		}
-
-		return $languageFiles;
-	}
-
-	/**
-	 * find the l10n directory
-	 *
-	 * @param string $app App id or empty string for core
-	 * @return string directory
-	 */
-	protected function findL10nDir($app = null) {
-		if (in_array($app, ['core', 'lib'])) {
-			if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
-				return $this->serverRoot . '/' . $app . '/l10n/';
-			}
-		} elseif ($app && \OC_App::getAppPath($app) !== false) {
-			// Check if the app is in the app folder
-			return \OC_App::getAppPath($app) . '/l10n/';
-		}
-		return $this->serverRoot . '/core/l10n/';
-	}
-
-
-	/**
-	 * Creates a function from the plural string
-	 *
-	 * Parts of the code is copied from Habari:
-	 * https://github.com/habari/system/blob/master/classes/locale.php
-	 * @param string $string
-	 * @return string
-	 */
-	public function createPluralFunction($string) {
-		if (isset($this->pluralFunctions[$string])) {
-			return $this->pluralFunctions[$string];
-		}
-
-		if (preg_match('/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) {
-			// sanitize
-			$nplurals = preg_replace('/[^0-9]/', '', $matches[1]);
-			$plural = preg_replace('#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2]);
-
-			$body = str_replace(
-				[ 'plural', 'n', '$n$plurals', ],
-				[ '$plural', '$n', '$nplurals', ],
-				'nplurals='. $nplurals . '; plural=' . $plural
-			);
-
-			// add parents
-			// important since PHP's ternary evaluates from left to right
-			$body .= ';';
-			$res = '';
-			$p = 0;
-			$length = strlen($body);
-			for ($i = 0; $i < $length; $i++) {
-				$ch = $body[$i];
-				switch ($ch) {
-					case '?':
-						$res .= ' ? (';
-						$p++;
-						break;
-					case ':':
-						$res .= ') : (';
-						break;
-					case ';':
-						$res .= str_repeat(')', $p) . ';';
-						$p = 0;
-						break;
-					default:
-						$res .= $ch;
-				}
-			}
-
-			$body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);';
-			$function = create_function('$n', $body);
-			$this->pluralFunctions[$string] = $function;
-			return $function;
-		} else {
-			// default: one plural form for all cases but n==1 (english)
-			$function = create_function(
-				'$n',
-				'$nplurals=2;$plural=($n==1?0:1);return ($plural>=$nplurals?$nplurals-1:$plural);'
-			);
-			$this->pluralFunctions[$string] = $function;
-			return $function;
-		}
-	}
-
-	/**
-	 * returns the common language and other languages in an
-	 * associative array
-	 *
-	 * @return array
-	 */
-	public function getLanguages() {
-		$forceLanguage = $this->config->getSystemValue('force_language', false);
-		if ($forceLanguage !== false) {
-			$l = $this->get('lib', $forceLanguage);
-			$potentialName = $l->t('__language_name__');
-
-			return [
-				'commonlanguages' => [[
-					'code' => $forceLanguage,
-					'name' => $potentialName,
-				]],
-				'languages' => [],
-			];
-		}
-
-		$languageCodes = $this->findAvailableLanguages();
-
-		$commonLanguages = [];
-		$languages = [];
-
-		foreach ($languageCodes as $lang) {
-			$l = $this->get('lib', $lang);
-			// TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
-			$potentialName = $l->t('__language_name__');
-			if ($l->getLanguageCode() === $lang && $potentialName[0] !== '_') {//first check if the language name is in the translation file
-				$ln = [
-					'code' => $lang,
-					'name' => $potentialName
-				];
-			} elseif ($lang === 'en') {
-				$ln = [
-					'code' => $lang,
-					'name' => 'English (US)'
-				];
-			} else {//fallback to language code
-				$ln = [
-					'code' => $lang,
-					'name' => $lang
-				];
-			}
-
-			// put appropriate languages into appropriate arrays, to print them sorted
-			// common languages -> divider -> other languages
-			if (in_array($lang, self::COMMON_LANGUAGE_CODES)) {
-				$commonLanguages[array_search($lang, self::COMMON_LANGUAGE_CODES)] = $ln;
-			} else {
-				$languages[] = $ln;
-			}
-		}
-
-		ksort($commonLanguages);
-
-		// sort now by displayed language not the iso-code
-		usort($languages, function ($a, $b) {
-			if ($a['code'] === $a['name'] && $b['code'] !== $b['name']) {
-				// If a doesn't have a name, but b does, list b before a
-				return 1;
-			}
-			if ($a['code'] !== $a['name'] && $b['code'] === $b['name']) {
-				// If a does have a name, but b doesn't, list a before b
-				return -1;
-			}
-			// Otherwise compare the names
-			return strcmp($a['name'], $b['name']);
-		});
-
-		return [
-			// reset indexes
-			'commonlanguages' => array_values($commonLanguages),
-			'languages' => $languages
-		];
-	}
+    /** @var string */
+    protected $requestLanguage = '';
+
+    /**
+     * cached instances
+     * @var array Structure: Lang => App => \OCP\IL10N
+     */
+    protected $instances = [];
+
+    /**
+     * @var array Structure: App => string[]
+     */
+    protected $availableLanguages = [];
+
+    /**
+     * @var array
+     */
+    protected $localeCache = [];
+
+    /**
+     * @var array
+     */
+    protected $availableLocales = [];
+
+    /**
+     * @var array Structure: string => callable
+     */
+    protected $pluralFunctions = [];
+
+    public const COMMON_LANGUAGE_CODES = [
+        'en', 'es', 'fr', 'de', 'de_DE', 'ja', 'ar', 'ru', 'nl', 'it',
+        'pt_BR', 'pt_PT', 'da', 'fi_FI', 'nb_NO', 'sv', 'tr', 'zh_CN', 'ko'
+    ];
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IRequest */
+    protected $request;
+
+    /** @var IUserSession */
+    protected $userSession;
+
+    /** @var string */
+    protected $serverRoot;
+
+    /**
+     * @param IConfig $config
+     * @param IRequest $request
+     * @param IUserSession $userSession
+     * @param string $serverRoot
+     */
+    public function __construct(IConfig $config,
+                                IRequest $request,
+                                IUserSession $userSession,
+                                $serverRoot) {
+        $this->config = $config;
+        $this->request = $request;
+        $this->userSession = $userSession;
+        $this->serverRoot = $serverRoot;
+    }
+
+    /**
+     * Get a language instance
+     *
+     * @param string $app
+     * @param string|null $lang
+     * @param string|null $locale
+     * @return \OCP\IL10N
+     */
+    public function get($app, $lang = null, $locale = null) {
+        return new LazyL10N(function () use ($app, $lang, $locale) {
+            $app = \OC_App::cleanAppId($app);
+            if ($lang !== null) {
+                $lang = str_replace(['\0', '/', '\\', '..'], '', $lang);
+            }
+
+            $forceLang = $this->config->getSystemValue('force_language', false);
+            if (is_string($forceLang)) {
+                $lang = $forceLang;
+            }
+
+            $forceLocale = $this->config->getSystemValue('force_locale', false);
+            if (is_string($forceLocale)) {
+                $locale = $forceLocale;
+            }
+
+            if ($lang === null || !$this->languageExists($app, $lang)) {
+                $lang = $this->findLanguage($app);
+            }
+
+            if ($locale === null || !$this->localeExists($locale)) {
+                $locale = $this->findLocale($lang);
+            }
+
+            if (!isset($this->instances[$lang][$app])) {
+                $this->instances[$lang][$app] = new L10N(
+                    $this, $app, $lang, $locale,
+                    $this->getL10nFilesForApp($app, $lang)
+                );
+            }
+
+            return $this->instances[$lang][$app];
+        });
+    }
+
+    /**
+     * Find the best language
+     *
+     * @param string|null $app App id or null for core
+     * @return string language If nothing works it returns 'en'
+     */
+    public function findLanguage($app = null) {
+        $forceLang = $this->config->getSystemValue('force_language', false);
+        if (is_string($forceLang)) {
+            $this->requestLanguage = $forceLang;
+        }
+
+        if ($this->requestLanguage !== '' && $this->languageExists($app, $this->requestLanguage)) {
+            return $this->requestLanguage;
+        }
+
+        /**
+         * At this point Nextcloud might not yet be installed and thus the lookup
+         * in the preferences table might fail. For this reason we need to check
+         * whether the instance has already been installed
+         *
+         * @link https://github.com/owncloud/core/issues/21955
+         */
+        if ($this->config->getSystemValue('installed', false)) {
+            $userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() :  null;
+            if (!is_null($userId)) {
+                $userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
+            } else {
+                $userLang = null;
+            }
+        } else {
+            $userId = null;
+            $userLang = null;
+        }
+
+        if ($userLang) {
+            $this->requestLanguage = $userLang;
+            if ($this->languageExists($app, $userLang)) {
+                return $userLang;
+            }
+        }
+
+        try {
+            // Try to get the language from the Request
+            $lang = $this->getLanguageFromRequest($app);
+            if ($userId !== null && $app === null && !$userLang) {
+                $this->config->setUserValue($userId, 'core', 'lang', $lang);
+            }
+            return $lang;
+        } catch (LanguageNotFoundException $e) {
+            // Finding language from request failed fall back to default language
+            $defaultLanguage = $this->config->getSystemValue('default_language', false);
+            if ($defaultLanguage !== false && $this->languageExists($app, $defaultLanguage)) {
+                return $defaultLanguage;
+            }
+        }
+
+        // We could not find any language so fall back to english
+        return 'en';
+    }
+
+    /**
+     * find the best locale
+     *
+     * @param string $lang
+     * @return null|string
+     */
+    public function findLocale($lang = null) {
+        $forceLocale = $this->config->getSystemValue('force_locale', false);
+        if (is_string($forceLocale) && $this->localeExists($forceLocale)) {
+            return $forceLocale;
+        }
+
+        if ($this->config->getSystemValue('installed', false)) {
+            $userId = null !== $this->userSession->getUser() ? $this->userSession->getUser()->getUID() :  null;
+            $userLocale = null;
+            if (null !== $userId) {
+                $userLocale = $this->config->getUserValue($userId, 'core', 'locale', null);
+            }
+        } else {
+            $userId = null;
+            $userLocale = null;
+        }
+
+        if ($userLocale && $this->localeExists($userLocale)) {
+            return $userLocale;
+        }
+
+        // Default : use system default locale
+        $defaultLocale = $this->config->getSystemValue('default_locale', false);
+        if ($defaultLocale !== false && $this->localeExists($defaultLocale)) {
+            return $defaultLocale;
+        }
+
+        // If no user locale set, use lang as locale
+        if (null !== $lang && $this->localeExists($lang)) {
+            return $lang;
+        }
+
+        // At last, return USA
+        return 'en_US';
+    }
+
+    /**
+     * find the matching lang from the locale
+     *
+     * @param string $app
+     * @param string $locale
+     * @return null|string
+     */
+    public function findLanguageFromLocale(string $app = 'core', string $locale = null) {
+        if ($this->languageExists($app, $locale)) {
+            return $locale;
+        }
+
+        // Try to split e.g: fr_FR => fr
+        $locale = explode('_', $locale)[0];
+        if ($this->languageExists($app, $locale)) {
+            return $locale;
+        }
+    }
+
+    /**
+     * Find all available languages for an app
+     *
+     * @param string|null $app App id or null for core
+     * @return array an array of available languages
+     */
+    public function findAvailableLanguages($app = null) {
+        $key = $app;
+        if ($key === null) {
+            $key = 'null';
+        }
+
+        // also works with null as key
+        if (!empty($this->availableLanguages[$key])) {
+            return $this->availableLanguages[$key];
+        }
+
+        $available = ['en']; //english is always available
+        $dir = $this->findL10nDir($app);
+        if (is_dir($dir)) {
+            $files = scandir($dir);
+            if ($files !== false) {
+                foreach ($files as $file) {
+                    if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
+                        $available[] = substr($file, 0, -5);
+                    }
+                }
+            }
+        }
+
+        // merge with translations from theme
+        $theme = $this->config->getSystemValue('theme');
+        if (!empty($theme)) {
+            $themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
+
+            if (is_dir($themeDir)) {
+                $files = scandir($themeDir);
+                if ($files !== false) {
+                    foreach ($files as $file) {
+                        if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
+                            $available[] = substr($file, 0, -5);
+                        }
+                    }
+                }
+            }
+        }
+
+        $this->availableLanguages[$key] = $available;
+        return $available;
+    }
+
+    /**
+     * @return array|mixed
+     */
+    public function findAvailableLocales() {
+        if (!empty($this->availableLocales)) {
+            return $this->availableLocales;
+        }
+
+        $localeData = file_get_contents(\OC::$SERVERROOT . '/resources/locales.json');
+        $this->availableLocales = \json_decode($localeData, true);
+
+        return $this->availableLocales;
+    }
+
+    /**
+     * @param string|null $app App id or null for core
+     * @param string $lang
+     * @return bool
+     */
+    public function languageExists($app, $lang) {
+        if ($lang === 'en') {//english is always available
+            return true;
+        }
+
+        $languages = $this->findAvailableLanguages($app);
+        return array_search($lang, $languages) !== false;
+    }
+
+    public function getLanguageIterator(IUser $user = null): ILanguageIterator {
+        $user = $user ?? $this->userSession->getUser();
+        if ($user === null) {
+            throw new \RuntimeException('Failed to get an IUser instance');
+        }
+        return new LanguageIterator($user, $this->config);
+    }
+
+    /**
+     * Return the language to use when sending something to a user
+     *
+     * @param IUser|null $user
+     * @return string
+     * @since 20.0.0
+     */
+    public function getUserLanguage(IUser $user = null): string {
+        $language = $this->config->getSystemValue('force_language', false);
+        if ($language !== false) {
+            return $language;
+        }
+
+        if ($user instanceof IUser) {
+            $language = $this->config->getUserValue($user->getUID(), 'core', 'lang', null);
+            if ($language !== null) {
+                return $language;
+            }
+        }
+
+        return $this->config->getSystemValue('default_language', 'en');
+    }
+
+    /**
+     * @param string $locale
+     * @return bool
+     */
+    public function localeExists($locale) {
+        if ($locale === 'en') { //english is always available
+            return true;
+        }
+
+        if ($this->localeCache === []) {
+            $locales = $this->findAvailableLocales();
+            foreach ($locales as $l) {
+                $this->localeCache[$l['code']] = true;
+            }
+        }
+
+        return isset($this->localeCache[$locale]);
+    }
+
+    /**
+     * @param string|null $app
+     * @return string
+     * @throws LanguageNotFoundException
+     */
+    private function getLanguageFromRequest($app) {
+        $header = $this->request->getHeader('ACCEPT_LANGUAGE');
+        if ($header !== '') {
+            $available = $this->findAvailableLanguages($app);
+
+            // E.g. make sure that 'de' is before 'de_DE'.
+            sort($available);
+
+            $preferences = preg_split('/,\s*/', strtolower($header));
+            foreach ($preferences as $preference) {
+                list($preferred_language) = explode(';', $preference);
+                $preferred_language = str_replace('-', '_', $preferred_language);
+
+                foreach ($available as $available_language) {
+                    if ($preferred_language === strtolower($available_language)) {
+                        return $this->respectDefaultLanguage($app, $available_language);
+                    }
+                }
+
+                // Fallback from de_De to de
+                foreach ($available as $available_language) {
+                    if (substr($preferred_language, 0, 2) === $available_language) {
+                        return $available_language;
+                    }
+                }
+            }
+        }
+
+        throw new LanguageNotFoundException();
+    }
+
+    /**
+     * if default language is set to de_DE (formal German) this should be
+     * preferred to 'de' (non-formal German) if possible
+     *
+     * @param string|null $app
+     * @param string $lang
+     * @return string
+     */
+    protected function respectDefaultLanguage($app, $lang) {
+        $result = $lang;
+        $defaultLanguage = $this->config->getSystemValue('default_language', false);
+
+        // use formal version of german ("Sie" instead of "Du") if the default
+        // language is set to 'de_DE' if possible
+        if (is_string($defaultLanguage) &&
+            strtolower($lang) === 'de' &&
+            strtolower($defaultLanguage) === 'de_de' &&
+            $this->languageExists($app, 'de_DE')
+        ) {
+            $result = 'de_DE';
+        }
+
+        return $result;
+    }
+
+    /**
+     * Checks if $sub is a subdirectory of $parent
+     *
+     * @param string $sub
+     * @param string $parent
+     * @return bool
+     */
+    private function isSubDirectory($sub, $parent) {
+        // Check whether $sub contains no ".."
+        if (strpos($sub, '..') !== false) {
+            return false;
+        }
+
+        // Check whether $sub is a subdirectory of $parent
+        if (strpos($sub, $parent) === 0) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Get a list of language files that should be loaded
+     *
+     * @param string $app
+     * @param string $lang
+     * @return string[]
+     */
+    // FIXME This method is only public, until OC_L10N does not need it anymore,
+    // FIXME This is also the reason, why it is not in the public interface
+    public function getL10nFilesForApp($app, $lang) {
+        $languageFiles = [];
+
+        $i18nDir = $this->findL10nDir($app);
+        $transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';
+
+        if (($this->isSubDirectory($transFile, $this->serverRoot . '/core/l10n/')
+                || $this->isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/')
+                || $this->isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/')
+            )
+            && file_exists($transFile)) {
+            // load the translations file
+            $languageFiles[] = $transFile;
+        }
+
+        // merge with translations from theme
+        $theme = $this->config->getSystemValue('theme');
+        if (!empty($theme)) {
+            $transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
+            if (file_exists($transFile)) {
+                $languageFiles[] = $transFile;
+            }
+        }
+
+        return $languageFiles;
+    }
+
+    /**
+     * find the l10n directory
+     *
+     * @param string $app App id or empty string for core
+     * @return string directory
+     */
+    protected function findL10nDir($app = null) {
+        if (in_array($app, ['core', 'lib'])) {
+            if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
+                return $this->serverRoot . '/' . $app . '/l10n/';
+            }
+        } elseif ($app && \OC_App::getAppPath($app) !== false) {
+            // Check if the app is in the app folder
+            return \OC_App::getAppPath($app) . '/l10n/';
+        }
+        return $this->serverRoot . '/core/l10n/';
+    }
+
+
+    /**
+     * Creates a function from the plural string
+     *
+     * Parts of the code is copied from Habari:
+     * https://github.com/habari/system/blob/master/classes/locale.php
+     * @param string $string
+     * @return string
+     */
+    public function createPluralFunction($string) {
+        if (isset($this->pluralFunctions[$string])) {
+            return $this->pluralFunctions[$string];
+        }
+
+        if (preg_match('/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) {
+            // sanitize
+            $nplurals = preg_replace('/[^0-9]/', '', $matches[1]);
+            $plural = preg_replace('#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2]);
+
+            $body = str_replace(
+                [ 'plural', 'n', '$n$plurals', ],
+                [ '$plural', '$n', '$nplurals', ],
+                'nplurals='. $nplurals . '; plural=' . $plural
+            );
+
+            // add parents
+            // important since PHP's ternary evaluates from left to right
+            $body .= ';';
+            $res = '';
+            $p = 0;
+            $length = strlen($body);
+            for ($i = 0; $i < $length; $i++) {
+                $ch = $body[$i];
+                switch ($ch) {
+                    case '?':
+                        $res .= ' ? (';
+                        $p++;
+                        break;
+                    case ':':
+                        $res .= ') : (';
+                        break;
+                    case ';':
+                        $res .= str_repeat(')', $p) . ';';
+                        $p = 0;
+                        break;
+                    default:
+                        $res .= $ch;
+                }
+            }
+
+            $body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);';
+            $function = create_function('$n', $body);
+            $this->pluralFunctions[$string] = $function;
+            return $function;
+        } else {
+            // default: one plural form for all cases but n==1 (english)
+            $function = create_function(
+                '$n',
+                '$nplurals=2;$plural=($n==1?0:1);return ($plural>=$nplurals?$nplurals-1:$plural);'
+            );
+            $this->pluralFunctions[$string] = $function;
+            return $function;
+        }
+    }
+
+    /**
+     * returns the common language and other languages in an
+     * associative array
+     *
+     * @return array
+     */
+    public function getLanguages() {
+        $forceLanguage = $this->config->getSystemValue('force_language', false);
+        if ($forceLanguage !== false) {
+            $l = $this->get('lib', $forceLanguage);
+            $potentialName = $l->t('__language_name__');
+
+            return [
+                'commonlanguages' => [[
+                    'code' => $forceLanguage,
+                    'name' => $potentialName,
+                ]],
+                'languages' => [],
+            ];
+        }
+
+        $languageCodes = $this->findAvailableLanguages();
+
+        $commonLanguages = [];
+        $languages = [];
+
+        foreach ($languageCodes as $lang) {
+            $l = $this->get('lib', $lang);
+            // TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
+            $potentialName = $l->t('__language_name__');
+            if ($l->getLanguageCode() === $lang && $potentialName[0] !== '_') {//first check if the language name is in the translation file
+                $ln = [
+                    'code' => $lang,
+                    'name' => $potentialName
+                ];
+            } elseif ($lang === 'en') {
+                $ln = [
+                    'code' => $lang,
+                    'name' => 'English (US)'
+                ];
+            } else {//fallback to language code
+                $ln = [
+                    'code' => $lang,
+                    'name' => $lang
+                ];
+            }
+
+            // put appropriate languages into appropriate arrays, to print them sorted
+            // common languages -> divider -> other languages
+            if (in_array($lang, self::COMMON_LANGUAGE_CODES)) {
+                $commonLanguages[array_search($lang, self::COMMON_LANGUAGE_CODES)] = $ln;
+            } else {
+                $languages[] = $ln;
+            }
+        }
+
+        ksort($commonLanguages);
+
+        // sort now by displayed language not the iso-code
+        usort($languages, function ($a, $b) {
+            if ($a['code'] === $a['name'] && $b['code'] !== $b['name']) {
+                // If a doesn't have a name, but b does, list b before a
+                return 1;
+            }
+            if ($a['code'] !== $a['name'] && $b['code'] === $b['name']) {
+                // If a does have a name, but b doesn't, list a before b
+                return -1;
+            }
+            // Otherwise compare the names
+            return strcmp($a['name'], $b['name']);
+        });
+
+        return [
+            // reset indexes
+            'commonlanguages' => array_values($commonLanguages),
+            'languages' => $languages
+        ];
+    }
 }

Spacing +20 added lines, -20 removed lines

@@ -120,7 +120,7 @@ 
 	 * @return \OCP\IL10N
 	 */
 	public function get($app, $lang = null, $locale = null) {
-		return new LazyL10N(function () use ($app, $lang, $locale) {
+		return new LazyL10N(function() use ($app, $lang, $locale) {
 			$app = \OC_App::cleanAppId($app);
 			if ($lang !== null) {
 				$lang = str_replace(['\0', '/', '\\', '..'], '', $lang);
@@ -179,7 +179,7 @@ 
 		 * @link https://github.com/owncloud/core/issues/21955
 		 */
 		if ($this->config->getSystemValue('installed', false)) {
-			$userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() :  null;
+			$userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() : null;
 			if (!is_null($userId)) {
 				$userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
 			} else {
@@ -229,7 +229,7 @@ 
 		}
 
 		if ($this->config->getSystemValue('installed', false)) {
-			$userId = null !== $this->userSession->getUser() ? $this->userSession->getUser()->getUID() :  null;
+			$userId = null !== $this->userSession->getUser() ? $this->userSession->getUser()->getUID() : null;
 			$userLocale = null;
 			if (null !== $userId) {
 				$userLocale = $this->config->getUserValue($userId, 'core', 'locale', null);
@@ -310,7 +310,7 @@ 
 		// merge with translations from theme
 		$theme = $this->config->getSystemValue('theme');
 		if (!empty($theme)) {
-			$themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
+			$themeDir = $this->serverRoot.'/themes/'.$theme.substr($dir, strlen($this->serverRoot));
 
 			if (is_dir($themeDir)) {
 				$files = scandir($themeDir);
@@ -336,7 +336,7 @@ 
 			return $this->availableLocales;
 		}
 
-		$localeData = file_get_contents(\OC::$SERVERROOT . '/resources/locales.json');
+		$localeData = file_get_contents(\OC::$SERVERROOT.'/resources/locales.json');
 		$this->availableLocales = \json_decode($localeData, true);
 
 		return $this->availableLocales;
@@ -501,11 +501,11 @@ 
 		$languageFiles = [];
 
 		$i18nDir = $this->findL10nDir($app);
-		$transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';
+		$transFile = strip_tags($i18nDir).strip_tags($lang).'.json';
 
-		if (($this->isSubDirectory($transFile, $this->serverRoot . '/core/l10n/')
-				|| $this->isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/')
-				|| $this->isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/')
+		if (($this->isSubDirectory($transFile, $this->serverRoot.'/core/l10n/')
+				|| $this->isSubDirectory($transFile, $this->serverRoot.'/lib/l10n/')
+				|| $this->isSubDirectory($transFile, \OC_App::getAppPath($app).'/l10n/')
 			)
 			&& file_exists($transFile)) {
 			// load the translations file
@@ -515,7 +515,7 @@ 
 		// merge with translations from theme
 		$theme = $this->config->getSystemValue('theme');
 		if (!empty($theme)) {
-			$transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
+			$transFile = $this->serverRoot.'/themes/'.$theme.substr($transFile, strlen($this->serverRoot));
 			if (file_exists($transFile)) {
 				$languageFiles[] = $transFile;
 			}
@@ -532,14 +532,14 @@ 
 	 */
 	protected function findL10nDir($app = null) {
 		if (in_array($app, ['core', 'lib'])) {
-			if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
-				return $this->serverRoot . '/' . $app . '/l10n/';
+			if (file_exists($this->serverRoot.'/'.$app.'/l10n/')) {
+				return $this->serverRoot.'/'.$app.'/l10n/';
 			}
 		} elseif ($app && \OC_App::getAppPath($app) !== false) {
 			// Check if the app is in the app folder
-			return \OC_App::getAppPath($app) . '/l10n/';
+			return \OC_App::getAppPath($app).'/l10n/';
 		}
-		return $this->serverRoot . '/core/l10n/';
+		return $this->serverRoot.'/core/l10n/';
 	}
 
 
@@ -562,9 +562,9 @@ 
 			$plural = preg_replace('#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2]);
 
 			$body = str_replace(
-				[ 'plural', 'n', '$n$plurals', ],
-				[ '$plural', '$n', '$nplurals', ],
-				'nplurals='. $nplurals . '; plural=' . $plural
+				['plural', 'n', '$n$plurals', ],
+				['$plural', '$n', '$nplurals', ],
+				'nplurals='.$nplurals.'; plural='.$plural
 			);
 
 			// add parents
@@ -584,7 +584,7 @@ 
 						$res .= ') : (';
 						break;
 					case ';':
-						$res .= str_repeat(')', $p) . ';';
+						$res .= str_repeat(')', $p).';';
 						$p = 0;
 						break;
 					default:
@@ -592,7 +592,7 @@ 
 				}
 			}
 
-			$body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);';
+			$body = $res.'return ($plural>=$nplurals?$nplurals-1:$plural);';
 			$function = create_function('$n', $body);
 			$this->pluralFunctions[$string] = $function;
 			return $function;
@@ -666,7 +666,7 @@ 
 		ksort($commonLanguages);
 
 		// sort now by displayed language not the iso-code
-		usort($languages, function ($a, $b) {
+		usort($languages, function($a, $b) {
 			if ($a['code'] === $a['name'] && $b['code'] !== $b['name']) {
 				// If a doesn't have a name, but b does, list b before a
 				return 1;

lib/private/Files/Storage/Wrapper/Encoding.php

Indentation +502 added lines, -502 removed lines

@@ -40,506 +40,506 @@
  */
 class Encoding extends Wrapper {
 
-	/**
-	 * @var ICache
-	 */
-	private $namesCache;
-
-	/**
-	 * @param array $parameters
-	 */
-	public function __construct($parameters) {
-		$this->storage = $parameters['storage'];
-		$this->namesCache = new CappedMemoryCache();
-	}
-
-	/**
-	 * Returns whether the given string is only made of ASCII characters
-	 *
-	 * @param string $str string
-	 *
-	 * @return bool true if the string is all ASCII, false otherwise
-	 */
-	private function isAscii($str) {
-		return !preg_match('/[\\x80-\\xff]+/', $str);
-	}
-
-	/**
-	 * Checks whether the given path exists in NFC or NFD form after checking
-	 * each form for each path section and returns the correct form.
-	 * If no existing path found, returns the path as it was given.
-	 *
-	 * @param string $fullPath path to check
-	 *
-	 * @return string original or converted path
-	 */
-	private function findPathToUse($fullPath) {
-		$cachedPath = $this->namesCache[$fullPath];
-		if ($cachedPath !== null) {
-			return $cachedPath;
-		}
-
-		$sections = explode('/', $fullPath);
-		$path = '';
-		foreach ($sections as $section) {
-			$convertedPath = $this->findPathToUseLastSection($path, $section);
-			if ($convertedPath === null) {
-				// no point in continuing if the section was not found, use original path
-				return $fullPath;
-			}
-			$path = $convertedPath . '/';
-		}
-		$path = rtrim($path, '/');
-		return $path;
-	}
-
-	/**
-	 * Checks whether the last path section of the given path exists in NFC or NFD form
-	 * and returns the correct form. If no existing path found, returns null.
-	 *
-	 * @param string $basePath base path to check
-	 * @param string $lastSection last section of the path to check for NFD/NFC variations
-	 *
-	 * @return string|null original or converted path, or null if none of the forms was found
-	 */
-	private function findPathToUseLastSection($basePath, $lastSection) {
-		$fullPath = $basePath . $lastSection;
-		if ($lastSection === '' || $this->isAscii($lastSection) || $this->storage->file_exists($fullPath)) {
-			$this->namesCache[$fullPath] = $fullPath;
-			return $fullPath;
-		}
-
-		// swap encoding
-		if (\Normalizer::isNormalized($lastSection, \Normalizer::FORM_C)) {
-			$otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_D);
-		} else {
-			$otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_C);
-		}
-		$otherFullPath = $basePath . $otherFormPath;
-		if ($this->storage->file_exists($otherFullPath)) {
-			$this->namesCache[$fullPath] = $otherFullPath;
-			return $otherFullPath;
-		}
-
-		// return original path, file did not exist at all
-		$this->namesCache[$fullPath] = $fullPath;
-		return null;
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.mkdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function mkdir($path) {
-		// note: no conversion here, method should not be called with non-NFC names!
-		$result = $this->storage->mkdir($path);
-		if ($result) {
-			$this->namesCache[$path] = $path;
-		}
-		return $result;
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function rmdir($path) {
-		$result = $this->storage->rmdir($this->findPathToUse($path));
-		if ($result) {
-			unset($this->namesCache[$path]);
-		}
-		return $result;
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource|bool
-	 */
-	public function opendir($path) {
-		return $this->storage->opendir($this->findPathToUse($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.is_dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function is_dir($path) {
-		return $this->storage->is_dir($this->findPathToUse($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.is_file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function is_file($path) {
-		return $this->storage->is_file($this->findPathToUse($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.stat.php
-	 * only the following keys are required in the result: size and mtime
-	 *
-	 * @param string $path
-	 * @return array|bool
-	 */
-	public function stat($path) {
-		return $this->storage->stat($this->findPathToUse($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return string|bool
-	 */
-	public function filetype($path) {
-		return $this->storage->filetype($this->findPathToUse($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.filesize.php
-	 * The result for filesize when called on a folder is required to be 0
-	 *
-	 * @param string $path
-	 * @return int|bool
-	 */
-	public function filesize($path) {
-		return $this->storage->filesize($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file can be created in $path
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isCreatable($path) {
-		return $this->storage->isCreatable($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isReadable($path) {
-		return $this->storage->isReadable($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file can be written to
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isUpdatable($path) {
-		return $this->storage->isUpdatable($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file can be deleted
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isDeletable($path) {
-		return $this->storage->isDeletable($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file can be shared
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isSharable($path) {
-		return $this->storage->isSharable($this->findPathToUse($path));
-	}
-
-	/**
-	 * get the full permissions of a path.
-	 * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function getPermissions($path) {
-		return $this->storage->getPermissions($this->findPathToUse($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function file_exists($path) {
-		return $this->storage->file_exists($this->findPathToUse($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int|bool
-	 */
-	public function filemtime($path) {
-		return $this->storage->filemtime($this->findPathToUse($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string|bool
-	 */
-	public function file_get_contents($path) {
-		return $this->storage->file_get_contents($this->findPathToUse($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_put_contents.php
-	 *
-	 * @param string $path
-	 * @param mixed $data
-	 * @return int|false
-	 */
-	public function file_put_contents($path, $data) {
-		return $this->storage->file_put_contents($this->findPathToUse($path), $data);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function unlink($path) {
-		$result = $this->storage->unlink($this->findPathToUse($path));
-		if ($result) {
-			unset($this->namesCache[$path]);
-		}
-		return $result;
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function rename($path1, $path2) {
-		// second name always NFC
-		return $this->storage->rename($this->findPathToUse($path1), $this->findPathToUse($path2));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.copy.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function copy($path1, $path2) {
-		return $this->storage->copy($this->findPathToUse($path1), $this->findPathToUse($path2));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|bool
-	 */
-	public function fopen($path, $mode) {
-		$result = $this->storage->fopen($this->findPathToUse($path), $mode);
-		if ($result && $mode !== 'r' && $mode !== 'rb') {
-			unset($this->namesCache[$path]);
-		}
-		return $result;
-	}
-
-	/**
-	 * get the mimetype for a file or folder
-	 * The mimetype for a folder is required to be "httpd/unix-directory"
-	 *
-	 * @param string $path
-	 * @return string|bool
-	 */
-	public function getMimeType($path) {
-		return $this->storage->getMimeType($this->findPathToUse($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.hash.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string|bool
-	 */
-	public function hash($type, $path, $raw = false) {
-		return $this->storage->hash($type, $this->findPathToUse($path), $raw);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int|bool
-	 */
-	public function free_space($path) {
-		return $this->storage->free_space($this->findPathToUse($path));
-	}
-
-	/**
-	 * search for occurrences of $query in file names
-	 *
-	 * @param string $query
-	 * @return array|bool
-	 */
-	public function search($query) {
-		return $this->storage->search($query);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.touch.php
-	 * If the backend does not support the operation, false should be returned
-	 *
-	 * @param string $path
-	 * @param int $mtime
-	 * @return bool
-	 */
-	public function touch($path, $mtime = null) {
-		return $this->storage->touch($this->findPathToUse($path), $mtime);
-	}
-
-	/**
-	 * get the path to a local version of the file.
-	 * The local version of the file can be temporary and doesn't have to be persistent across requests
-	 *
-	 * @param string $path
-	 * @return string|bool
-	 */
-	public function getLocalFile($path) {
-		return $this->storage->getLocalFile($this->findPathToUse($path));
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 *
-	 * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
-	 * returning true for other changes in the folder is optional
-	 */
-	public function hasUpdated($path, $time) {
-		return $this->storage->hasUpdated($this->findPathToUse($path), $time);
-	}
-
-	/**
-	 * get a cache instance for the storage
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache
-	 * @return \OC\Files\Cache\Cache
-	 */
-	public function getCache($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->storage->getCache($this->findPathToUse($path), $storage);
-	}
-
-	/**
-	 * get a scanner instance for the storage
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner
-	 * @return \OC\Files\Cache\Scanner
-	 */
-	public function getScanner($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->storage->getScanner($this->findPathToUse($path), $storage);
-	}
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string|bool
-	 */
-	public function getETag($path) {
-		return $this->storage->getETag($this->findPathToUse($path));
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		if ($sourceStorage === $this) {
-			return $this->copy($sourceInternalPath, $this->findPathToUse($targetInternalPath));
-		}
-
-		$result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath));
-		if ($result) {
-			unset($this->namesCache[$targetInternalPath]);
-		}
-		return $result;
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		if ($sourceStorage === $this) {
-			$result = $this->rename($sourceInternalPath, $this->findPathToUse($targetInternalPath));
-			if ($result) {
-				unset($this->namesCache[$sourceInternalPath]);
-				unset($this->namesCache[$targetInternalPath]);
-			}
-			return $result;
-		}
-
-		$result = $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath));
-		if ($result) {
-			unset($this->namesCache[$sourceInternalPath]);
-			unset($this->namesCache[$targetInternalPath]);
-		}
-		return $result;
-	}
-
-	/**
-	 * @param string $path
-	 * @return array
-	 */
-	public function getMetaData($path) {
-		return $this->storage->getMetaData($this->findPathToUse($path));
-	}
-
-	public function getDirectoryContent($directory): \Traversable {
-		return $this->storage->getDirectoryContent($this->findPathToUse($directory));
-	}
+    /**
+     * @var ICache
+     */
+    private $namesCache;
+
+    /**
+     * @param array $parameters
+     */
+    public function __construct($parameters) {
+        $this->storage = $parameters['storage'];
+        $this->namesCache = new CappedMemoryCache();
+    }
+
+    /**
+     * Returns whether the given string is only made of ASCII characters
+     *
+     * @param string $str string
+     *
+     * @return bool true if the string is all ASCII, false otherwise
+     */
+    private function isAscii($str) {
+        return !preg_match('/[\\x80-\\xff]+/', $str);
+    }
+
+    /**
+     * Checks whether the given path exists in NFC or NFD form after checking
+     * each form for each path section and returns the correct form.
+     * If no existing path found, returns the path as it was given.
+     *
+     * @param string $fullPath path to check
+     *
+     * @return string original or converted path
+     */
+    private function findPathToUse($fullPath) {
+        $cachedPath = $this->namesCache[$fullPath];
+        if ($cachedPath !== null) {
+            return $cachedPath;
+        }
+
+        $sections = explode('/', $fullPath);
+        $path = '';
+        foreach ($sections as $section) {
+            $convertedPath = $this->findPathToUseLastSection($path, $section);
+            if ($convertedPath === null) {
+                // no point in continuing if the section was not found, use original path
+                return $fullPath;
+            }
+            $path = $convertedPath . '/';
+        }
+        $path = rtrim($path, '/');
+        return $path;
+    }
+
+    /**
+     * Checks whether the last path section of the given path exists in NFC or NFD form
+     * and returns the correct form. If no existing path found, returns null.
+     *
+     * @param string $basePath base path to check
+     * @param string $lastSection last section of the path to check for NFD/NFC variations
+     *
+     * @return string|null original or converted path, or null if none of the forms was found
+     */
+    private function findPathToUseLastSection($basePath, $lastSection) {
+        $fullPath = $basePath . $lastSection;
+        if ($lastSection === '' || $this->isAscii($lastSection) || $this->storage->file_exists($fullPath)) {
+            $this->namesCache[$fullPath] = $fullPath;
+            return $fullPath;
+        }
+
+        // swap encoding
+        if (\Normalizer::isNormalized($lastSection, \Normalizer::FORM_C)) {
+            $otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_D);
+        } else {
+            $otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_C);
+        }
+        $otherFullPath = $basePath . $otherFormPath;
+        if ($this->storage->file_exists($otherFullPath)) {
+            $this->namesCache[$fullPath] = $otherFullPath;
+            return $otherFullPath;
+        }
+
+        // return original path, file did not exist at all
+        $this->namesCache[$fullPath] = $fullPath;
+        return null;
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.mkdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function mkdir($path) {
+        // note: no conversion here, method should not be called with non-NFC names!
+        $result = $this->storage->mkdir($path);
+        if ($result) {
+            $this->namesCache[$path] = $path;
+        }
+        return $result;
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function rmdir($path) {
+        $result = $this->storage->rmdir($this->findPathToUse($path));
+        if ($result) {
+            unset($this->namesCache[$path]);
+        }
+        return $result;
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource|bool
+     */
+    public function opendir($path) {
+        return $this->storage->opendir($this->findPathToUse($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.is_dir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function is_dir($path) {
+        return $this->storage->is_dir($this->findPathToUse($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.is_file.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function is_file($path) {
+        return $this->storage->is_file($this->findPathToUse($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.stat.php
+     * only the following keys are required in the result: size and mtime
+     *
+     * @param string $path
+     * @return array|bool
+     */
+    public function stat($path) {
+        return $this->storage->stat($this->findPathToUse($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return string|bool
+     */
+    public function filetype($path) {
+        return $this->storage->filetype($this->findPathToUse($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.filesize.php
+     * The result for filesize when called on a folder is required to be 0
+     *
+     * @param string $path
+     * @return int|bool
+     */
+    public function filesize($path) {
+        return $this->storage->filesize($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file can be created in $path
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isCreatable($path) {
+        return $this->storage->isCreatable($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isReadable($path) {
+        return $this->storage->isReadable($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file can be written to
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isUpdatable($path) {
+        return $this->storage->isUpdatable($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file can be deleted
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isDeletable($path) {
+        return $this->storage->isDeletable($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file can be shared
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isSharable($path) {
+        return $this->storage->isSharable($this->findPathToUse($path));
+    }
+
+    /**
+     * get the full permissions of a path.
+     * Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function getPermissions($path) {
+        return $this->storage->getPermissions($this->findPathToUse($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function file_exists($path) {
+        return $this->storage->file_exists($this->findPathToUse($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int|bool
+     */
+    public function filemtime($path) {
+        return $this->storage->filemtime($this->findPathToUse($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string|bool
+     */
+    public function file_get_contents($path) {
+        return $this->storage->file_get_contents($this->findPathToUse($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.file_put_contents.php
+     *
+     * @param string $path
+     * @param mixed $data
+     * @return int|false
+     */
+    public function file_put_contents($path, $data) {
+        return $this->storage->file_put_contents($this->findPathToUse($path), $data);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function unlink($path) {
+        $result = $this->storage->unlink($this->findPathToUse($path));
+        if ($result) {
+            unset($this->namesCache[$path]);
+        }
+        return $result;
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function rename($path1, $path2) {
+        // second name always NFC
+        return $this->storage->rename($this->findPathToUse($path1), $this->findPathToUse($path2));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.copy.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function copy($path1, $path2) {
+        return $this->storage->copy($this->findPathToUse($path1), $this->findPathToUse($path2));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource|bool
+     */
+    public function fopen($path, $mode) {
+        $result = $this->storage->fopen($this->findPathToUse($path), $mode);
+        if ($result && $mode !== 'r' && $mode !== 'rb') {
+            unset($this->namesCache[$path]);
+        }
+        return $result;
+    }
+
+    /**
+     * get the mimetype for a file or folder
+     * The mimetype for a folder is required to be "httpd/unix-directory"
+     *
+     * @param string $path
+     * @return string|bool
+     */
+    public function getMimeType($path) {
+        return $this->storage->getMimeType($this->findPathToUse($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.hash.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string|bool
+     */
+    public function hash($type, $path, $raw = false) {
+        return $this->storage->hash($type, $this->findPathToUse($path), $raw);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int|bool
+     */
+    public function free_space($path) {
+        return $this->storage->free_space($this->findPathToUse($path));
+    }
+
+    /**
+     * search for occurrences of $query in file names
+     *
+     * @param string $query
+     * @return array|bool
+     */
+    public function search($query) {
+        return $this->storage->search($query);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.touch.php
+     * If the backend does not support the operation, false should be returned
+     *
+     * @param string $path
+     * @param int $mtime
+     * @return bool
+     */
+    public function touch($path, $mtime = null) {
+        return $this->storage->touch($this->findPathToUse($path), $mtime);
+    }
+
+    /**
+     * get the path to a local version of the file.
+     * The local version of the file can be temporary and doesn't have to be persistent across requests
+     *
+     * @param string $path
+     * @return string|bool
+     */
+    public function getLocalFile($path) {
+        return $this->storage->getLocalFile($this->findPathToUse($path));
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     *
+     * hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
+     * returning true for other changes in the folder is optional
+     */
+    public function hasUpdated($path, $time) {
+        return $this->storage->hasUpdated($this->findPathToUse($path), $time);
+    }
+
+    /**
+     * get a cache instance for the storage
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache
+     * @return \OC\Files\Cache\Cache
+     */
+    public function getCache($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->storage->getCache($this->findPathToUse($path), $storage);
+    }
+
+    /**
+     * get a scanner instance for the storage
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner
+     * @return \OC\Files\Cache\Scanner
+     */
+    public function getScanner($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->storage->getScanner($this->findPathToUse($path), $storage);
+    }
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string|bool
+     */
+    public function getETag($path) {
+        return $this->storage->getETag($this->findPathToUse($path));
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        if ($sourceStorage === $this) {
+            return $this->copy($sourceInternalPath, $this->findPathToUse($targetInternalPath));
+        }
+
+        $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath));
+        if ($result) {
+            unset($this->namesCache[$targetInternalPath]);
+        }
+        return $result;
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        if ($sourceStorage === $this) {
+            $result = $this->rename($sourceInternalPath, $this->findPathToUse($targetInternalPath));
+            if ($result) {
+                unset($this->namesCache[$sourceInternalPath]);
+                unset($this->namesCache[$targetInternalPath]);
+            }
+            return $result;
+        }
+
+        $result = $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath));
+        if ($result) {
+            unset($this->namesCache[$sourceInternalPath]);
+            unset($this->namesCache[$targetInternalPath]);
+        }
+        return $result;
+    }
+
+    /**
+     * @param string $path
+     * @return array
+     */
+    public function getMetaData($path) {
+        return $this->storage->getMetaData($this->findPathToUse($path));
+    }
+
+    public function getDirectoryContent($directory): \Traversable {
+        return $this->storage->getDirectoryContent($this->findPathToUse($directory));
+    }
 }

lib/private/Files/FileInfo.php

Indentation +376 added lines, -376 removed lines

@@ -38,380 +38,380 @@
 use OCP\IUser;
 
 class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess {
-	/**
-	 * @var array $data
-	 */
-	private $data;
-
-	/**
-	 * @var string $path
-	 */
-	private $path;
-
-	/**
-	 * @var \OC\Files\Storage\Storage $storage
-	 */
-	private $storage;
-
-	/**
-	 * @var string $internalPath
-	 */
-	private $internalPath;
-
-	/**
-	 * @var \OCP\Files\Mount\IMountPoint
-	 */
-	private $mount;
-
-	/**
-	 * @var IUser
-	 */
-	private $owner;
-
-	/**
-	 * @var string[]
-	 */
-	private $childEtags = [];
-
-	/**
-	 * @var IMountPoint[]
-	 */
-	private $subMounts = [];
-
-	private $subMountsUsed = false;
-
-	/**
-	 * The size of the file/folder without any sub mount
-	 *
-	 * @var int
-	 */
-	private $rawSize = 0;
-
-	/**
-	 * @param string|boolean $path
-	 * @param Storage\Storage $storage
-	 * @param string $internalPath
-	 * @param array|ICacheEntry $data
-	 * @param \OCP\Files\Mount\IMountPoint $mount
-	 * @param \OCP\IUser|null $owner
-	 */
-	public function __construct($path, $storage, $internalPath, $data, $mount, $owner = null) {
-		$this->path = $path;
-		$this->storage = $storage;
-		$this->internalPath = $internalPath;
-		$this->data = $data;
-		$this->mount = $mount;
-		$this->owner = $owner;
-		$this->rawSize = $this->data['size'] ?? 0;
-	}
-
-	public function offsetSet($offset, $value) {
-		$this->data[$offset] = $value;
-	}
-
-	public function offsetExists($offset) {
-		return isset($this->data[$offset]);
-	}
-
-	public function offsetUnset($offset) {
-		unset($this->data[$offset]);
-	}
-
-	public function offsetGet($offset) {
-		if ($offset === 'type') {
-			return $this->getType();
-		} elseif ($offset === 'etag') {
-			return $this->getEtag();
-		} elseif ($offset === 'size') {
-			return $this->getSize();
-		} elseif ($offset === 'mtime') {
-			return $this->getMTime();
-		} elseif ($offset === 'permissions') {
-			return $this->getPermissions();
-		} elseif (isset($this->data[$offset])) {
-			return $this->data[$offset];
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getPath() {
-		return $this->path;
-	}
-
-	/**
-	 * @return \OCP\Files\Storage
-	 */
-	public function getStorage() {
-		return $this->storage;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getInternalPath() {
-		return $this->internalPath;
-	}
-
-	/**
-	 * Get FileInfo ID or null in case of part file
-	 *
-	 * @return int|null
-	 */
-	public function getId() {
-		return isset($this->data['fileid']) ? (int)  $this->data['fileid'] : null;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getMimetype() {
-		return $this->data['mimetype'];
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getMimePart() {
-		return $this->data['mimepart'];
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getName() {
-		return isset($this->data['name']) ? $this->data['name'] : basename($this->getPath());
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getEtag() {
-		$this->updateEntryfromSubMounts();
-		if (count($this->childEtags) > 0) {
-			$combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
-			return md5($combinedEtag);
-		} else {
-			return $this->data['etag'];
-		}
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getSize($includeMounts = true) {
-		if ($includeMounts) {
-			$this->updateEntryfromSubMounts();
-			return isset($this->data['size']) ? 0 + $this->data['size'] : 0;
-		} else {
-			return $this->rawSize;
-		}
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getMTime() {
-		$this->updateEntryfromSubMounts();
-		return (int) $this->data['mtime'];
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isEncrypted() {
-		return $this->data['encrypted'];
-	}
-
-	/**
-	 * Return the currently version used for the HMAC in the encryption app
-	 *
-	 * @return int
-	 */
-	public function getEncryptedVersion() {
-		return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getPermissions() {
-		$perms = (int) $this->data['permissions'];
-		if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) {
-			$perms = $perms & ~\OCP\Constants::PERMISSION_SHARE;
-		}
-		return $perms;
-	}
-
-	/**
-	 * @return string \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
-	 */
-	public function getType() {
-		if (!isset($this->data['type'])) {
-			$this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE;
-		}
-		return $this->data['type'];
-	}
-
-	public function getData() {
-		return $this->data;
-	}
-
-	/**
-	 * @param int $permissions
-	 * @return bool
-	 */
-	protected function checkPermissions($permissions) {
-		return ($this->getPermissions() & $permissions) === $permissions;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isReadable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_READ);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isUpdateable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE);
-	}
-
-	/**
-	 * Check whether new files or folders can be created inside this folder
-	 *
-	 * @return bool
-	 */
-	public function isCreatable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isDeletable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isShareable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE);
-	}
-
-	/**
-	 * Check if a file or folder is shared
-	 *
-	 * @return bool
-	 */
-	public function isShared() {
-		$sid = $this->getStorage()->getId();
-		if (!is_null($sid)) {
-			$sid = explode(':', $sid);
-			return ($sid[0] === 'shared');
-		}
-
-		return false;
-	}
-
-	public function isMounted() {
-		$storage = $this->getStorage();
-		if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
-			return false;
-		}
-		$sid = $storage->getId();
-		if (!is_null($sid)) {
-			$sid = explode(':', $sid);
-			return ($sid[0] !== 'home' and $sid[0] !== 'shared');
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get the mountpoint the file belongs to
-	 *
-	 * @return \OCP\Files\Mount\IMountPoint
-	 */
-	public function getMountPoint() {
-		return $this->mount;
-	}
-
-	/**
-	 * Get the owner of the file
-	 *
-	 * @return \OCP\IUser
-	 */
-	public function getOwner() {
-		return $this->owner;
-	}
-
-	/**
-	 * @param IMountPoint[] $mounts
-	 */
-	public function setSubMounts(array $mounts) {
-		$this->subMounts = $mounts;
-	}
-
-	private function updateEntryfromSubMounts() {
-		if ($this->subMountsUsed) {
-			return;
-		}
-		$this->subMountsUsed = true;
-		foreach ($this->subMounts as $mount) {
-			$subStorage = $mount->getStorage();
-			if ($subStorage) {
-				$subCache = $subStorage->getCache('');
-				$rootEntry = $subCache->get('');
-				$this->addSubEntry($rootEntry, $mount->getMountPoint());
-			}
-		}
-	}
-
-	/**
-	 * Add a cache entry which is the child of this folder
-	 *
-	 * Sets the size, etag and size to for cross-storage childs
-	 *
-	 * @param array|ICacheEntry $data cache entry for the child
-	 * @param string $entryPath full path of the child entry
-	 */
-	public function addSubEntry($data, $entryPath) {
-		$this->data['size'] += isset($data['size']) ? $data['size'] : 0;
-		if (isset($data['mtime'])) {
-			$this->data['mtime'] = max($this->data['mtime'], $data['mtime']);
-		}
-		if (isset($data['etag'])) {
-			// prefix the etag with the relative path of the subentry to propagate etag on mount moves
-			$relativeEntryPath = substr($entryPath, strlen($this->getPath()));
-			// attach the permissions to propagate etag on permision changes of submounts
-			$permissions = isset($data['permissions']) ? $data['permissions'] : 0;
-			$this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getChecksum() {
-		return $this->data['checksum'];
-	}
-
-	public function getExtension(): string {
-		return pathinfo($this->getName(), PATHINFO_EXTENSION);
-	}
-
-	public function getCreationTime(): int {
-		return (int) $this->data['creation_time'];
-	}
-
-	public function getUploadTime(): int {
-		return (int) $this->data['upload_time'];
-	}
+    /**
+     * @var array $data
+     */
+    private $data;
+
+    /**
+     * @var string $path
+     */
+    private $path;
+
+    /**
+     * @var \OC\Files\Storage\Storage $storage
+     */
+    private $storage;
+
+    /**
+     * @var string $internalPath
+     */
+    private $internalPath;
+
+    /**
+     * @var \OCP\Files\Mount\IMountPoint
+     */
+    private $mount;
+
+    /**
+     * @var IUser
+     */
+    private $owner;
+
+    /**
+     * @var string[]
+     */
+    private $childEtags = [];
+
+    /**
+     * @var IMountPoint[]
+     */
+    private $subMounts = [];
+
+    private $subMountsUsed = false;
+
+    /**
+     * The size of the file/folder without any sub mount
+     *
+     * @var int
+     */
+    private $rawSize = 0;
+
+    /**
+     * @param string|boolean $path
+     * @param Storage\Storage $storage
+     * @param string $internalPath
+     * @param array|ICacheEntry $data
+     * @param \OCP\Files\Mount\IMountPoint $mount
+     * @param \OCP\IUser|null $owner
+     */
+    public function __construct($path, $storage, $internalPath, $data, $mount, $owner = null) {
+        $this->path = $path;
+        $this->storage = $storage;
+        $this->internalPath = $internalPath;
+        $this->data = $data;
+        $this->mount = $mount;
+        $this->owner = $owner;
+        $this->rawSize = $this->data['size'] ?? 0;
+    }
+
+    public function offsetSet($offset, $value) {
+        $this->data[$offset] = $value;
+    }
+
+    public function offsetExists($offset) {
+        return isset($this->data[$offset]);
+    }
+
+    public function offsetUnset($offset) {
+        unset($this->data[$offset]);
+    }
+
+    public function offsetGet($offset) {
+        if ($offset === 'type') {
+            return $this->getType();
+        } elseif ($offset === 'etag') {
+            return $this->getEtag();
+        } elseif ($offset === 'size') {
+            return $this->getSize();
+        } elseif ($offset === 'mtime') {
+            return $this->getMTime();
+        } elseif ($offset === 'permissions') {
+            return $this->getPermissions();
+        } elseif (isset($this->data[$offset])) {
+            return $this->data[$offset];
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getPath() {
+        return $this->path;
+    }
+
+    /**
+     * @return \OCP\Files\Storage
+     */
+    public function getStorage() {
+        return $this->storage;
+    }
+
+    /**
+     * @return string
+     */
+    public function getInternalPath() {
+        return $this->internalPath;
+    }
+
+    /**
+     * Get FileInfo ID or null in case of part file
+     *
+     * @return int|null
+     */
+    public function getId() {
+        return isset($this->data['fileid']) ? (int)  $this->data['fileid'] : null;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMimetype() {
+        return $this->data['mimetype'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getMimePart() {
+        return $this->data['mimepart'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getName() {
+        return isset($this->data['name']) ? $this->data['name'] : basename($this->getPath());
+    }
+
+    /**
+     * @return string
+     */
+    public function getEtag() {
+        $this->updateEntryfromSubMounts();
+        if (count($this->childEtags) > 0) {
+            $combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
+            return md5($combinedEtag);
+        } else {
+            return $this->data['etag'];
+        }
+    }
+
+    /**
+     * @return int
+     */
+    public function getSize($includeMounts = true) {
+        if ($includeMounts) {
+            $this->updateEntryfromSubMounts();
+            return isset($this->data['size']) ? 0 + $this->data['size'] : 0;
+        } else {
+            return $this->rawSize;
+        }
+    }
+
+    /**
+     * @return int
+     */
+    public function getMTime() {
+        $this->updateEntryfromSubMounts();
+        return (int) $this->data['mtime'];
+    }
+
+    /**
+     * @return bool
+     */
+    public function isEncrypted() {
+        return $this->data['encrypted'];
+    }
+
+    /**
+     * Return the currently version used for the HMAC in the encryption app
+     *
+     * @return int
+     */
+    public function getEncryptedVersion() {
+        return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1;
+    }
+
+    /**
+     * @return int
+     */
+    public function getPermissions() {
+        $perms = (int) $this->data['permissions'];
+        if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) {
+            $perms = $perms & ~\OCP\Constants::PERMISSION_SHARE;
+        }
+        return $perms;
+    }
+
+    /**
+     * @return string \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
+     */
+    public function getType() {
+        if (!isset($this->data['type'])) {
+            $this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE;
+        }
+        return $this->data['type'];
+    }
+
+    public function getData() {
+        return $this->data;
+    }
+
+    /**
+     * @param int $permissions
+     * @return bool
+     */
+    protected function checkPermissions($permissions) {
+        return ($this->getPermissions() & $permissions) === $permissions;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isReadable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_READ);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isUpdateable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE);
+    }
+
+    /**
+     * Check whether new files or folders can be created inside this folder
+     *
+     * @return bool
+     */
+    public function isCreatable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isDeletable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isShareable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE);
+    }
+
+    /**
+     * Check if a file or folder is shared
+     *
+     * @return bool
+     */
+    public function isShared() {
+        $sid = $this->getStorage()->getId();
+        if (!is_null($sid)) {
+            $sid = explode(':', $sid);
+            return ($sid[0] === 'shared');
+        }
+
+        return false;
+    }
+
+    public function isMounted() {
+        $storage = $this->getStorage();
+        if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
+            return false;
+        }
+        $sid = $storage->getId();
+        if (!is_null($sid)) {
+            $sid = explode(':', $sid);
+            return ($sid[0] !== 'home' and $sid[0] !== 'shared');
+        }
+
+        return false;
+    }
+
+    /**
+     * Get the mountpoint the file belongs to
+     *
+     * @return \OCP\Files\Mount\IMountPoint
+     */
+    public function getMountPoint() {
+        return $this->mount;
+    }
+
+    /**
+     * Get the owner of the file
+     *
+     * @return \OCP\IUser
+     */
+    public function getOwner() {
+        return $this->owner;
+    }
+
+    /**
+     * @param IMountPoint[] $mounts
+     */
+    public function setSubMounts(array $mounts) {
+        $this->subMounts = $mounts;
+    }
+
+    private function updateEntryfromSubMounts() {
+        if ($this->subMountsUsed) {
+            return;
+        }
+        $this->subMountsUsed = true;
+        foreach ($this->subMounts as $mount) {
+            $subStorage = $mount->getStorage();
+            if ($subStorage) {
+                $subCache = $subStorage->getCache('');
+                $rootEntry = $subCache->get('');
+                $this->addSubEntry($rootEntry, $mount->getMountPoint());
+            }
+        }
+    }
+
+    /**
+     * Add a cache entry which is the child of this folder
+     *
+     * Sets the size, etag and size to for cross-storage childs
+     *
+     * @param array|ICacheEntry $data cache entry for the child
+     * @param string $entryPath full path of the child entry
+     */
+    public function addSubEntry($data, $entryPath) {
+        $this->data['size'] += isset($data['size']) ? $data['size'] : 0;
+        if (isset($data['mtime'])) {
+            $this->data['mtime'] = max($this->data['mtime'], $data['mtime']);
+        }
+        if (isset($data['etag'])) {
+            // prefix the etag with the relative path of the subentry to propagate etag on mount moves
+            $relativeEntryPath = substr($entryPath, strlen($this->getPath()));
+            // attach the permissions to propagate etag on permision changes of submounts
+            $permissions = isset($data['permissions']) ? $data['permissions'] : 0;
+            $this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getChecksum() {
+        return $this->data['checksum'];
+    }
+
+    public function getExtension(): string {
+        return pathinfo($this->getName(), PATHINFO_EXTENSION);
+    }
+
+    public function getCreationTime(): int {
+        return (int) $this->data['creation_time'];
+    }
+
+    public function getUploadTime(): int {
+        return (int) $this->data['upload_time'];
+    }
 }

lib/private/Notification/Notification.php

Indentation +543 added lines, -543 removed lines

@@ -34,547 +34,547 @@
 
 class Notification implements INotification {
 
-	/** @var IValidator */
-	protected $richValidator;
-
-	/** @var string */
-	protected $app;
-
-	/** @var string */
-	protected $user;
-
-	/** @var \DateTime */
-	protected $dateTime;
-
-	/** @var string */
-	protected $objectType;
-
-	/** @var string */
-	protected $objectId;
-
-	/** @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 $link;
-
-	/** @var string */
-	protected $icon;
-
-	/** @var array */
-	protected $actions;
-
-	/** @var array */
-	protected $actionsParsed;
-
-	/** @var bool */
-	protected $hasPrimaryAction;
-
-	/** @var bool */
-	protected $hasPrimaryParsedAction;
-
-	public function __construct(IValidator $richValidator) {
-		$this->richValidator = $richValidator;
-		$this->app = '';
-		$this->user = '';
-		$this->dateTime = new \DateTime();
-		$this->dateTime->setTimestamp(0);
-		$this->objectType = '';
-		$this->objectId = '';
-		$this->subject = '';
-		$this->subjectParameters = [];
-		$this->subjectParsed = '';
-		$this->subjectRich = '';
-		$this->subjectRichParameters = [];
-		$this->message = '';
-		$this->messageParameters = [];
-		$this->messageParsed = '';
-		$this->messageRich = '';
-		$this->messageRichParameters = [];
-		$this->link = '';
-		$this->icon = '';
-		$this->actions = [];
-		$this->actionsParsed = [];
-	}
-
-	/**
-	 * @param string $app
-	 * @return $this
-	 * @throws \InvalidArgumentException if the app id is invalid
-	 * @since 8.2.0
-	 */
-	public function setApp(string $app): INotification {
-		if ($app === '' || isset($app[32])) {
-			throw new \InvalidArgumentException('The given app name is invalid');
-		}
-		$this->app = $app;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getApp(): string {
-		return $this->app;
-	}
-
-	/**
-	 * @param string $user
-	 * @return $this
-	 * @throws \InvalidArgumentException if the user id is invalid
-	 * @since 8.2.0
-	 */
-	public function setUser(string $user): INotification {
-		if ($user === '' || isset($user[64])) {
-			throw new \InvalidArgumentException('The given user id is invalid');
-		}
-		$this->user = $user;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getUser(): string {
-		return $this->user;
-	}
-
-	/**
-	 * @param \DateTime $dateTime
-	 * @return $this
-	 * @throws \InvalidArgumentException if the $dateTime is invalid
-	 * @since 9.0.0
-	 */
-	public function setDateTime(\DateTime $dateTime): INotification {
-		if ($dateTime->getTimestamp() === 0) {
-			throw new \InvalidArgumentException('The given date time is invalid');
-		}
-		$this->dateTime = $dateTime;
-		return $this;
-	}
-
-	/**
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getDateTime(): \DateTime {
-		return $this->dateTime;
-	}
-
-	/**
-	 * @param string $type
-	 * @param string $id
-	 * @return $this
-	 * @throws \InvalidArgumentException if the object type or id is invalid
-	 * @since 8.2.0 - 9.0.0: Type of $id changed to string
-	 */
-	public function setObject(string $type, string $id): INotification {
-		if ($type === '' || isset($type[64])) {
-			throw new \InvalidArgumentException('The given object type is invalid');
-		}
-		$this->objectType = $type;
-
-		if ($id === '' || isset($id[64])) {
-			throw new \InvalidArgumentException('The given object id is invalid');
-		}
-		$this->objectId = $id;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getObjectType(): string {
-		return $this->objectType;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0 - 9.0.0: Return type changed to string
-	 */
-	public function getObjectId(): string {
-		return $this->objectId;
-	}
-
-	/**
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setSubject(string $subject, array $parameters = []): INotification {
-		if ($subject === '' || isset($subject[64])) {
-			throw new \InvalidArgumentException('The given subject is invalid');
-		}
-
-		$this->subject = $subject;
-		$this->subjectParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getSubject(): string {
-		return $this->subject;
-	}
-
-	/**
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getSubjectParameters(): array {
-		return $this->subjectParameters;
-	}
-
-	/**
-	 * @param string $subject
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject is invalid
-	 * @since 8.2.0
-	 */
-	public function setParsedSubject(string $subject): INotification {
-		if ($subject === '') {
-			throw new \InvalidArgumentException('The given parsed subject is invalid');
-		}
-		$this->subjectParsed = $subject;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.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 = []): INotification {
-		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;
-	}
-
-	/**
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setMessage(string $message, array $parameters = []): INotification {
-		if ($message === '' || isset($message[64])) {
-			throw new \InvalidArgumentException('The given message is invalid');
-		}
-
-		$this->message = $message;
-		$this->messageParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getMessage(): string {
-		return $this->message;
-	}
-
-	/**
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getMessageParameters(): array {
-		return $this->messageParameters;
-	}
-
-	/**
-	 * @param string $message
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message is invalid
-	 * @since 8.2.0
-	 */
-	public function setParsedMessage(string $message): INotification {
-		if ($message === '') {
-			throw new \InvalidArgumentException('The given parsed message is invalid');
-		}
-		$this->messageParsed = $message;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getParsedMessage(): string {
-		return $this->messageParsed;
-	}
-
-	/**
-	 * @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 = []): INotification {
-		if ($message === '') {
-			throw new \InvalidArgumentException('The given parsed message is invalid');
-		}
-
-		$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;
-	}
-
-	/**
-	 * @param string $link
-	 * @return $this
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
-	 */
-	public function setLink(string $link): INotification {
-		if ($link === '' || isset($link[4000])) {
-			throw new \InvalidArgumentException('The given link is invalid');
-		}
-		$this->link = $link;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	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): INotification {
-		if ($icon === '' || 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;
-	}
-
-	/**
-	 * @return IAction
-	 * @since 8.2.0
-	 */
-	public function createAction(): IAction {
-		return new Action();
-	}
-
-	/**
-	 * @param IAction $action
-	 * @return $this
-	 * @throws \InvalidArgumentException if the action is invalid
-	 * @since 8.2.0
-	 */
-	public function addAction(IAction $action): INotification {
-		if (!$action->isValid()) {
-			throw new \InvalidArgumentException('The given action is invalid');
-		}
-
-		if ($action->isPrimary()) {
-			if ($this->hasPrimaryAction) {
-				throw new \InvalidArgumentException('The notification already has a primary action');
-			}
-
-			$this->hasPrimaryAction = true;
-		}
-
-		$this->actions[] = $action;
-		return $this;
-	}
-
-	/**
-	 * @return IAction[]
-	 * @since 8.2.0
-	 */
-	public function getActions(): array {
-		return $this->actions;
-	}
-
-	/**
-	 * @param IAction $action
-	 * @return $this
-	 * @throws \InvalidArgumentException if the action is invalid
-	 * @since 8.2.0
-	 */
-	public function addParsedAction(IAction $action): INotification {
-		if (!$action->isValidParsed()) {
-			throw new \InvalidArgumentException('The given parsed action is invalid');
-		}
-
-		if ($action->isPrimary()) {
-			if ($this->hasPrimaryParsedAction) {
-				throw new \InvalidArgumentException('The notification already has a primary action');
-			}
-
-			$this->hasPrimaryParsedAction = true;
-
-			// Make sure the primary action is always the first one
-			array_unshift($this->actionsParsed, $action);
-		} else {
-			$this->actionsParsed[] = $action;
-		}
-
-		return $this;
-	}
-
-	/**
-	 * @return IAction[]
-	 * @since 8.2.0
-	 */
-	public function getParsedActions(): array {
-		return $this->actionsParsed;
-	}
-
-	/**
-	 * @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->getUser() !== ''
-			&&
-			$this->getDateTime()->getTimestamp() !== 0
-			&&
-			$this->getObjectType() !== ''
-			&&
-			$this->getObjectId() !== ''
-		;
-	}
+    /** @var IValidator */
+    protected $richValidator;
+
+    /** @var string */
+    protected $app;
+
+    /** @var string */
+    protected $user;
+
+    /** @var \DateTime */
+    protected $dateTime;
+
+    /** @var string */
+    protected $objectType;
+
+    /** @var string */
+    protected $objectId;
+
+    /** @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 $link;
+
+    /** @var string */
+    protected $icon;
+
+    /** @var array */
+    protected $actions;
+
+    /** @var array */
+    protected $actionsParsed;
+
+    /** @var bool */
+    protected $hasPrimaryAction;
+
+    /** @var bool */
+    protected $hasPrimaryParsedAction;
+
+    public function __construct(IValidator $richValidator) {
+        $this->richValidator = $richValidator;
+        $this->app = '';
+        $this->user = '';
+        $this->dateTime = new \DateTime();
+        $this->dateTime->setTimestamp(0);
+        $this->objectType = '';
+        $this->objectId = '';
+        $this->subject = '';
+        $this->subjectParameters = [];
+        $this->subjectParsed = '';
+        $this->subjectRich = '';
+        $this->subjectRichParameters = [];
+        $this->message = '';
+        $this->messageParameters = [];
+        $this->messageParsed = '';
+        $this->messageRich = '';
+        $this->messageRichParameters = [];
+        $this->link = '';
+        $this->icon = '';
+        $this->actions = [];
+        $this->actionsParsed = [];
+    }
+
+    /**
+     * @param string $app
+     * @return $this
+     * @throws \InvalidArgumentException if the app id is invalid
+     * @since 8.2.0
+     */
+    public function setApp(string $app): INotification {
+        if ($app === '' || isset($app[32])) {
+            throw new \InvalidArgumentException('The given app name is invalid');
+        }
+        $this->app = $app;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getApp(): string {
+        return $this->app;
+    }
+
+    /**
+     * @param string $user
+     * @return $this
+     * @throws \InvalidArgumentException if the user id is invalid
+     * @since 8.2.0
+     */
+    public function setUser(string $user): INotification {
+        if ($user === '' || isset($user[64])) {
+            throw new \InvalidArgumentException('The given user id is invalid');
+        }
+        $this->user = $user;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getUser(): string {
+        return $this->user;
+    }
+
+    /**
+     * @param \DateTime $dateTime
+     * @return $this
+     * @throws \InvalidArgumentException if the $dateTime is invalid
+     * @since 9.0.0
+     */
+    public function setDateTime(\DateTime $dateTime): INotification {
+        if ($dateTime->getTimestamp() === 0) {
+            throw new \InvalidArgumentException('The given date time is invalid');
+        }
+        $this->dateTime = $dateTime;
+        return $this;
+    }
+
+    /**
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getDateTime(): \DateTime {
+        return $this->dateTime;
+    }
+
+    /**
+     * @param string $type
+     * @param string $id
+     * @return $this
+     * @throws \InvalidArgumentException if the object type or id is invalid
+     * @since 8.2.0 - 9.0.0: Type of $id changed to string
+     */
+    public function setObject(string $type, string $id): INotification {
+        if ($type === '' || isset($type[64])) {
+            throw new \InvalidArgumentException('The given object type is invalid');
+        }
+        $this->objectType = $type;
+
+        if ($id === '' || isset($id[64])) {
+            throw new \InvalidArgumentException('The given object id is invalid');
+        }
+        $this->objectId = $id;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getObjectType(): string {
+        return $this->objectType;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0 - 9.0.0: Return type changed to string
+     */
+    public function getObjectId(): string {
+        return $this->objectId;
+    }
+
+    /**
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setSubject(string $subject, array $parameters = []): INotification {
+        if ($subject === '' || isset($subject[64])) {
+            throw new \InvalidArgumentException('The given subject is invalid');
+        }
+
+        $this->subject = $subject;
+        $this->subjectParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getSubject(): string {
+        return $this->subject;
+    }
+
+    /**
+     * @return array
+     * @since 8.2.0
+     */
+    public function getSubjectParameters(): array {
+        return $this->subjectParameters;
+    }
+
+    /**
+     * @param string $subject
+     * @return $this
+     * @throws \InvalidArgumentException if the subject is invalid
+     * @since 8.2.0
+     */
+    public function setParsedSubject(string $subject): INotification {
+        if ($subject === '') {
+            throw new \InvalidArgumentException('The given parsed subject is invalid');
+        }
+        $this->subjectParsed = $subject;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.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 = []): INotification {
+        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;
+    }
+
+    /**
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setMessage(string $message, array $parameters = []): INotification {
+        if ($message === '' || isset($message[64])) {
+            throw new \InvalidArgumentException('The given message is invalid');
+        }
+
+        $this->message = $message;
+        $this->messageParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getMessage(): string {
+        return $this->message;
+    }
+
+    /**
+     * @return array
+     * @since 8.2.0
+     */
+    public function getMessageParameters(): array {
+        return $this->messageParameters;
+    }
+
+    /**
+     * @param string $message
+     * @return $this
+     * @throws \InvalidArgumentException if the message is invalid
+     * @since 8.2.0
+     */
+    public function setParsedMessage(string $message): INotification {
+        if ($message === '') {
+            throw new \InvalidArgumentException('The given parsed message is invalid');
+        }
+        $this->messageParsed = $message;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getParsedMessage(): string {
+        return $this->messageParsed;
+    }
+
+    /**
+     * @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 = []): INotification {
+        if ($message === '') {
+            throw new \InvalidArgumentException('The given parsed message is invalid');
+        }
+
+        $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;
+    }
+
+    /**
+     * @param string $link
+     * @return $this
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 8.2.0
+     */
+    public function setLink(string $link): INotification {
+        if ($link === '' || isset($link[4000])) {
+            throw new \InvalidArgumentException('The given link is invalid');
+        }
+        $this->link = $link;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    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): INotification {
+        if ($icon === '' || 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;
+    }
+
+    /**
+     * @return IAction
+     * @since 8.2.0
+     */
+    public function createAction(): IAction {
+        return new Action();
+    }
+
+    /**
+     * @param IAction $action
+     * @return $this
+     * @throws \InvalidArgumentException if the action is invalid
+     * @since 8.2.0
+     */
+    public function addAction(IAction $action): INotification {
+        if (!$action->isValid()) {
+            throw new \InvalidArgumentException('The given action is invalid');
+        }
+
+        if ($action->isPrimary()) {
+            if ($this->hasPrimaryAction) {
+                throw new \InvalidArgumentException('The notification already has a primary action');
+            }
+
+            $this->hasPrimaryAction = true;
+        }
+
+        $this->actions[] = $action;
+        return $this;
+    }
+
+    /**
+     * @return IAction[]
+     * @since 8.2.0
+     */
+    public function getActions(): array {
+        return $this->actions;
+    }
+
+    /**
+     * @param IAction $action
+     * @return $this
+     * @throws \InvalidArgumentException if the action is invalid
+     * @since 8.2.0
+     */
+    public function addParsedAction(IAction $action): INotification {
+        if (!$action->isValidParsed()) {
+            throw new \InvalidArgumentException('The given parsed action is invalid');
+        }
+
+        if ($action->isPrimary()) {
+            if ($this->hasPrimaryParsedAction) {
+                throw new \InvalidArgumentException('The notification already has a primary action');
+            }
+
+            $this->hasPrimaryParsedAction = true;
+
+            // Make sure the primary action is always the first one
+            array_unshift($this->actionsParsed, $action);
+        } else {
+            $this->actionsParsed[] = $action;
+        }
+
+        return $this;
+    }
+
+    /**
+     * @return IAction[]
+     * @since 8.2.0
+     */
+    public function getParsedActions(): array {
+        return $this->actionsParsed;
+    }
+
+    /**
+     * @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->getUser() !== ''
+            &&
+            $this->getDateTime()->getTimestamp() !== 0
+            &&
+            $this->getObjectType() !== ''
+            &&
+            $this->getObjectId() !== ''
+        ;
+    }
 }

apps/workflowengine/lib/Check/RequestUserAgent.php

Indentation +51 added lines, -51 removed lines

@@ -26,60 +26,60 @@
 
 class RequestUserAgent extends AbstractStringCheck {
 
-	/** @var IRequest */
-	protected $request;
+    /** @var IRequest */
+    protected $request;
 
-	/**
-	 * @param IL10N $l
-	 * @param IRequest $request
-	 */
-	public function __construct(IL10N $l, IRequest $request) {
-		parent::__construct($l);
-		$this->request = $request;
-	}
+    /**
+     * @param IL10N $l
+     * @param IRequest $request
+     */
+    public function __construct(IL10N $l, IRequest $request) {
+        parent::__construct($l);
+        $this->request = $request;
+    }
 
-	/**
-	 * @param string $operator
-	 * @param string $value
-	 * @return bool
-	 */
-	public function executeCheck($operator, $value) {
-		$actualValue = $this->getActualValue();
-		if (in_array($operator, ['is', '!is'], true)) {
-			switch ($value) {
-				case 'android':
-					$operator = $operator === 'is' ? 'matches' : '!matches';
-					$value = IRequest::USER_AGENT_CLIENT_ANDROID;
-					break;
-				case 'ios':
-					$operator = $operator === 'is' ? 'matches' : '!matches';
-					$value = IRequest::USER_AGENT_CLIENT_IOS;
-					break;
-				case 'desktop':
-					$operator = $operator === 'is' ? 'matches' : '!matches';
-					$value = IRequest::USER_AGENT_CLIENT_DESKTOP;
-					break;
-				case 'mail':
-					if ($operator === 'is') {
-						return $this->executeStringCheck('matches', IRequest::USER_AGENT_OUTLOOK_ADDON, $actualValue)
-							|| $this->executeStringCheck('matches', IRequest::USER_AGENT_THUNDERBIRD_ADDON, $actualValue);
-					}
+    /**
+     * @param string $operator
+     * @param string $value
+     * @return bool
+     */
+    public function executeCheck($operator, $value) {
+        $actualValue = $this->getActualValue();
+        if (in_array($operator, ['is', '!is'], true)) {
+            switch ($value) {
+                case 'android':
+                    $operator = $operator === 'is' ? 'matches' : '!matches';
+                    $value = IRequest::USER_AGENT_CLIENT_ANDROID;
+                    break;
+                case 'ios':
+                    $operator = $operator === 'is' ? 'matches' : '!matches';
+                    $value = IRequest::USER_AGENT_CLIENT_IOS;
+                    break;
+                case 'desktop':
+                    $operator = $operator === 'is' ? 'matches' : '!matches';
+                    $value = IRequest::USER_AGENT_CLIENT_DESKTOP;
+                    break;
+                case 'mail':
+                    if ($operator === 'is') {
+                        return $this->executeStringCheck('matches', IRequest::USER_AGENT_OUTLOOK_ADDON, $actualValue)
+                            || $this->executeStringCheck('matches', IRequest::USER_AGENT_THUNDERBIRD_ADDON, $actualValue);
+                    }
 
-					return $this->executeStringCheck('!matches', IRequest::USER_AGENT_OUTLOOK_ADDON, $actualValue)
-						&& $this->executeStringCheck('!matches', IRequest::USER_AGENT_THUNDERBIRD_ADDON, $actualValue);
-			}
-		}
-		return $this->executeStringCheck($operator, $value, $actualValue);
-	}
+                    return $this->executeStringCheck('!matches', IRequest::USER_AGENT_OUTLOOK_ADDON, $actualValue)
+                        && $this->executeStringCheck('!matches', IRequest::USER_AGENT_THUNDERBIRD_ADDON, $actualValue);
+            }
+        }
+        return $this->executeStringCheck($operator, $value, $actualValue);
+    }
 
-	/**
-	 * @return string
-	 */
-	protected function getActualValue() {
-		return $this->request->getHeader('User-Agent');
-	}
+    /**
+     * @return string
+     */
+    protected function getActualValue() {
+        return $this->request->getHeader('User-Agent');
+    }
 
-	public function isAvailableForScope(int $scope): bool {
-		return true;
-	}
+    public function isAvailableForScope(int $scope): bool {
+        return true;
+    }
 }

apps/comments/lib/Activity/Provider.php

Indentation +240 added lines, -240 removed lines

@@ -37,244 +37,244 @@
 
 class Provider implements IProvider {
 
-	/** @var IFactory */
-	protected $languageFactory;
-
-	/** @var IL10N */
-	protected $l;
-
-	/** @var IURLGenerator */
-	protected $url;
-
-	/** @var ICommentsManager */
-	protected $commentsManager;
-
-	/** @var IUserManager */
-	protected $userManager;
-
-	/** @var IManager */
-	protected $activityManager;
-
-	/** @var string[] */
-	protected $displayNames = [];
-
-	/**
-	 * @param IFactory $languageFactory
-	 * @param IURLGenerator $url
-	 * @param ICommentsManager $commentsManager
-	 * @param IUserManager $userManager
-	 * @param IManager $activityManager
-	 */
-	public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) {
-		$this->languageFactory = $languageFactory;
-		$this->url = $url;
-		$this->commentsManager = $commentsManager;
-		$this->userManager = $userManager;
-		$this->activityManager = $activityManager;
-	}
-
-	/**
-	 * @param string $language
-	 * @param IEvent $event
-	 * @param IEvent|null $previousEvent
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 * @since 11.0.0
-	 */
-	public function parse($language, IEvent $event, IEvent $previousEvent = null) {
-		if ($event->getApp() !== 'comments') {
-			throw new \InvalidArgumentException();
-		}
-
-		$this->l = $this->languageFactory->get('comments', $language);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			$this->parseMessage($event);
-			if ($this->activityManager->getRequirePNG()) {
-				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.png')));
-			} else {
-				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')));
-			}
-
-			if ($this->activityManager->isFormattingFilteredObject()) {
-				try {
-					return $this->parseShortVersion($event);
-				} catch (\InvalidArgumentException $e) {
-					// Ignore and simply use the long version...
-				}
-			}
-
-			return $this->parseLongVersion($event);
-		} else {
-			throw new \InvalidArgumentException();
-		}
-	}
-
-	/**
-	 * @param IEvent $event
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 */
-	protected function parseShortVersion(IEvent $event) {
-		$subjectParameters = $this->getSubjectParameters($event);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
-				$event->setParsedSubject($this->l->t('You commented'))
-					->setRichSubject($this->l->t('You commented'), []);
-			} else {
-				$author = $this->generateUserParameter($subjectParameters['actor']);
-				$event->setParsedSubject($this->l->t('%1$s commented', [$author['name']]))
-					->setRichSubject($this->l->t('{author} commented'), [
-						'author' => $author,
-					]);
-			}
-		} else {
-			throw new \InvalidArgumentException();
-		}
-
-		return $event;
-	}
-
-	/**
-	 * @param IEvent $event
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 */
-	protected function parseLongVersion(IEvent $event) {
-		$subjectParameters = $this->getSubjectParameters($event);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
-				$event->setParsedSubject($this->l->t('You commented on %1$s', [
-					$subjectParameters['filePath'],
-				]))
-					->setRichSubject($this->l->t('You commented on {file}'), [
-						'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
-					]);
-			} else {
-				$author = $this->generateUserParameter($subjectParameters['actor']);
-				$event->setParsedSubject($this->l->t('%1$s commented on %2$s', [
-					$author['name'],
-					$subjectParameters['filePath'],
-				]))
-					->setRichSubject($this->l->t('{author} commented on {file}'), [
-						'author' => $author,
-						'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
-					]);
-			}
-		} else {
-			throw new \InvalidArgumentException();
-		}
-
-		return $event;
-	}
-
-	protected function getSubjectParameters(IEvent $event) {
-		$subjectParameters = $event->getSubjectParameters();
-		if (isset($subjectParameters['fileId'])) {
-			return $subjectParameters;
-		}
-
-		// Fix subjects from 12.0.3 and older
-		//
-		// Do NOT Remove unless necessary
-		// Removing this will break parsing of activities that were created on
-		// Nextcloud 12, so we should keep this as long as it's acceptable.
-		// Otherwise if people upgrade over multiple releases in a short period,
-		// they will get the dead entries in their stream.
-		return [
-			'actor' => $subjectParameters[0],
-			'fileId' => $event->getObjectId(),
-			'filePath' => trim($subjectParameters[1], '/'),
-		];
-	}
-
-	/**
-	 * @param IEvent $event
-	 */
-	protected function parseMessage(IEvent $event) {
-		$messageParameters = $event->getMessageParameters();
-		if (empty($messageParameters)) {
-			// Email
-			return;
-		}
-
-		$commentId = isset($messageParameters['commentId']) ? $messageParameters['commentId'] : $messageParameters[0];
-
-		try {
-			$comment = $this->commentsManager->get((string) $commentId);
-			$message = $comment->getMessage();
-
-			$mentionCount = 1;
-			$mentions = [];
-			foreach ($comment->getMentions() as $mention) {
-				if ($mention['type'] !== 'user') {
-					continue;
-				}
-
-				$pattern = '/(^|\s)(' . '@' . $mention['id'] . ')(\b)/';
-				if (strpos($mention['id'], ' ') !== false) {
-					$pattern = '/(^|\s)(' . '@"' . $mention['id'] . '"' . ')(\b)?/';
-				}
-
-				$message = preg_replace(
-					$pattern,
-					//'${1}' . $this->regexSafeUser($mention['id'], $displayName) . '${3}',
-					'${1}' . '{mention' . $mentionCount . '}' . '${3}',
-					$message
-				);
-				$mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']);
-				$mentionCount++;
-			}
-
-			$event->setParsedMessage($comment->getMessage())
-				->setRichMessage($message, $mentions);
-		} catch (NotFoundException $e) {
-		}
-	}
-
-	/**
-	 * @param int $id
-	 * @param string $path
-	 * @return array
-	 */
-	protected function generateFileParameter($id, $path) {
-		return [
-			'type' => 'file',
-			'id' => $id,
-			'name' => basename($path),
-			'path' => $path,
-			'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]),
-		];
-	}
-
-	/**
-	 * @param string $uid
-	 * @return array
-	 */
-	protected function generateUserParameter($uid) {
-		if (!isset($this->displayNames[$uid])) {
-			$this->displayNames[$uid] = $this->getDisplayName($uid);
-		}
-
-		return [
-			'type' => 'user',
-			'id' => $uid,
-			'name' => $this->displayNames[$uid],
-		];
-	}
-
-	/**
-	 * @param string $uid
-	 * @return string
-	 */
-	protected function getDisplayName($uid) {
-		$user = $this->userManager->get($uid);
-		if ($user instanceof IUser) {
-			return $user->getDisplayName();
-		} else {
-			return $uid;
-		}
-	}
+    /** @var IFactory */
+    protected $languageFactory;
+
+    /** @var IL10N */
+    protected $l;
+
+    /** @var IURLGenerator */
+    protected $url;
+
+    /** @var ICommentsManager */
+    protected $commentsManager;
+
+    /** @var IUserManager */
+    protected $userManager;
+
+    /** @var IManager */
+    protected $activityManager;
+
+    /** @var string[] */
+    protected $displayNames = [];
+
+    /**
+     * @param IFactory $languageFactory
+     * @param IURLGenerator $url
+     * @param ICommentsManager $commentsManager
+     * @param IUserManager $userManager
+     * @param IManager $activityManager
+     */
+    public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) {
+        $this->languageFactory = $languageFactory;
+        $this->url = $url;
+        $this->commentsManager = $commentsManager;
+        $this->userManager = $userManager;
+        $this->activityManager = $activityManager;
+    }
+
+    /**
+     * @param string $language
+     * @param IEvent $event
+     * @param IEvent|null $previousEvent
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     * @since 11.0.0
+     */
+    public function parse($language, IEvent $event, IEvent $previousEvent = null) {
+        if ($event->getApp() !== 'comments') {
+            throw new \InvalidArgumentException();
+        }
+
+        $this->l = $this->languageFactory->get('comments', $language);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            $this->parseMessage($event);
+            if ($this->activityManager->getRequirePNG()) {
+                $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.png')));
+            } else {
+                $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')));
+            }
+
+            if ($this->activityManager->isFormattingFilteredObject()) {
+                try {
+                    return $this->parseShortVersion($event);
+                } catch (\InvalidArgumentException $e) {
+                    // Ignore and simply use the long version...
+                }
+            }
+
+            return $this->parseLongVersion($event);
+        } else {
+            throw new \InvalidArgumentException();
+        }
+    }
+
+    /**
+     * @param IEvent $event
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     */
+    protected function parseShortVersion(IEvent $event) {
+        $subjectParameters = $this->getSubjectParameters($event);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
+                $event->setParsedSubject($this->l->t('You commented'))
+                    ->setRichSubject($this->l->t('You commented'), []);
+            } else {
+                $author = $this->generateUserParameter($subjectParameters['actor']);
+                $event->setParsedSubject($this->l->t('%1$s commented', [$author['name']]))
+                    ->setRichSubject($this->l->t('{author} commented'), [
+                        'author' => $author,
+                    ]);
+            }
+        } else {
+            throw new \InvalidArgumentException();
+        }
+
+        return $event;
+    }
+
+    /**
+     * @param IEvent $event
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     */
+    protected function parseLongVersion(IEvent $event) {
+        $subjectParameters = $this->getSubjectParameters($event);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
+                $event->setParsedSubject($this->l->t('You commented on %1$s', [
+                    $subjectParameters['filePath'],
+                ]))
+                    ->setRichSubject($this->l->t('You commented on {file}'), [
+                        'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
+                    ]);
+            } else {
+                $author = $this->generateUserParameter($subjectParameters['actor']);
+                $event->setParsedSubject($this->l->t('%1$s commented on %2$s', [
+                    $author['name'],
+                    $subjectParameters['filePath'],
+                ]))
+                    ->setRichSubject($this->l->t('{author} commented on {file}'), [
+                        'author' => $author,
+                        'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
+                    ]);
+            }
+        } else {
+            throw new \InvalidArgumentException();
+        }
+
+        return $event;
+    }
+
+    protected function getSubjectParameters(IEvent $event) {
+        $subjectParameters = $event->getSubjectParameters();
+        if (isset($subjectParameters['fileId'])) {
+            return $subjectParameters;
+        }
+
+        // Fix subjects from 12.0.3 and older
+        //
+        // Do NOT Remove unless necessary
+        // Removing this will break parsing of activities that were created on
+        // Nextcloud 12, so we should keep this as long as it's acceptable.
+        // Otherwise if people upgrade over multiple releases in a short period,
+        // they will get the dead entries in their stream.
+        return [
+            'actor' => $subjectParameters[0],
+            'fileId' => $event->getObjectId(),
+            'filePath' => trim($subjectParameters[1], '/'),
+        ];
+    }
+
+    /**
+     * @param IEvent $event
+     */
+    protected function parseMessage(IEvent $event) {
+        $messageParameters = $event->getMessageParameters();
+        if (empty($messageParameters)) {
+            // Email
+            return;
+        }
+
+        $commentId = isset($messageParameters['commentId']) ? $messageParameters['commentId'] : $messageParameters[0];
+
+        try {
+            $comment = $this->commentsManager->get((string) $commentId);
+            $message = $comment->getMessage();
+
+            $mentionCount = 1;
+            $mentions = [];
+            foreach ($comment->getMentions() as $mention) {
+                if ($mention['type'] !== 'user') {
+                    continue;
+                }
+
+                $pattern = '/(^|\s)(' . '@' . $mention['id'] . ')(\b)/';
+                if (strpos($mention['id'], ' ') !== false) {
+                    $pattern = '/(^|\s)(' . '@"' . $mention['id'] . '"' . ')(\b)?/';
+                }
+
+                $message = preg_replace(
+                    $pattern,
+                    //'${1}' . $this->regexSafeUser($mention['id'], $displayName) . '${3}',
+                    '${1}' . '{mention' . $mentionCount . '}' . '${3}',
+                    $message
+                );
+                $mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']);
+                $mentionCount++;
+            }
+
+            $event->setParsedMessage($comment->getMessage())
+                ->setRichMessage($message, $mentions);
+        } catch (NotFoundException $e) {
+        }
+    }
+
+    /**
+     * @param int $id
+     * @param string $path
+     * @return array
+     */
+    protected function generateFileParameter($id, $path) {
+        return [
+            'type' => 'file',
+            'id' => $id,
+            'name' => basename($path),
+            'path' => $path,
+            'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]),
+        ];
+    }
+
+    /**
+     * @param string $uid
+     * @return array
+     */
+    protected function generateUserParameter($uid) {
+        if (!isset($this->displayNames[$uid])) {
+            $this->displayNames[$uid] = $this->getDisplayName($uid);
+        }
+
+        return [
+            'type' => 'user',
+            'id' => $uid,
+            'name' => $this->displayNames[$uid],
+        ];
+    }
+
+    /**
+     * @param string $uid
+     * @return string
+     */
+    protected function getDisplayName($uid) {
+        $user = $this->userManager->get($uid);
+        if ($user instanceof IUser) {
+            return $user->getDisplayName();
+        } else {
+            return $uid;
+        }
+    }
 }