nextcloud / server

lib/private/AppFramework/Http/Request.php

Indentation +871 added lines, -871 removed lines

@@ -63,875 +63,875 @@
  * @property mixed[] server
  */
 class Request implements \ArrayAccess, \Countable, IRequest {
-	public const USER_AGENT_IE = '/(MSIE)|(Trident)/';
-	// Microsoft Edge User Agent from https://msdn.microsoft.com/en-us/library/hh869301(v=vs.85).aspx
-	public const USER_AGENT_MS_EDGE = '/^Mozilla\/5\.0 \([^)]+\) AppleWebKit\/[0-9.]+ \(KHTML, like Gecko\) Chrome\/[0-9.]+ (Mobile Safari|Safari)\/[0-9.]+ Edge\/[0-9.]+$/';
-	// Firefox User Agent from https://developer.mozilla.org/en-US/docs/Web/HTTP/Gecko_user_agent_string_reference
-	public const USER_AGENT_FIREFOX = '/^Mozilla\/5\.0 \([^)]+\) Gecko\/[0-9.]+ Firefox\/[0-9.]+$/';
-	// Chrome User Agent from https://developer.chrome.com/multidevice/user-agent
-	public const USER_AGENT_CHROME = '/^Mozilla\/5\.0 \([^)]+\) AppleWebKit\/[0-9.]+ \(KHTML, like Gecko\)( Ubuntu Chromium\/[0-9.]+|) Chrome\/[0-9.]+ (Mobile Safari|Safari)\/[0-9.]+( (Vivaldi|Brave|OPR)\/[0-9.]+|)$/';
-	// Safari User Agent from http://www.useragentstring.com/pages/Safari/
-	public const USER_AGENT_SAFARI = '/^Mozilla\/5\.0 \([^)]+\) AppleWebKit\/[0-9.]+ \(KHTML, like Gecko\) Version\/[0-9.]+ Safari\/[0-9.A-Z]+$/';
-	// Android Chrome user agent: https://developers.google.com/chrome/mobile/docs/user-agent
-	public const USER_AGENT_ANDROID_MOBILE_CHROME = '#Android.*Chrome/[.0-9]*#';
-	public const USER_AGENT_FREEBOX = '#^Mozilla/5\.0$#';
-	public const REGEX_LOCALHOST = '/^(127\.0\.0\.1|localhost|\[::1\])$/';
-
-	/**
-	 * @deprecated use \OCP\IRequest::USER_AGENT_CLIENT_IOS instead
-	 */
-	public const USER_AGENT_OWNCLOUD_IOS = '/^Mozilla\/5\.0 \(iOS\) (ownCloud|Nextcloud)\-iOS.*$/';
-	/**
-	 * @deprecated use \OCP\IRequest::USER_AGENT_CLIENT_ANDROID instead
-	 */
-	public const USER_AGENT_OWNCLOUD_ANDROID = '/^Mozilla\/5\.0 \(Android\) ownCloud\-android.*$/';
-	/**
-	 * @deprecated use \OCP\IRequest::USER_AGENT_CLIENT_DESKTOP instead
-	 */
-	public const USER_AGENT_OWNCLOUD_DESKTOP = '/^Mozilla\/5\.0 \([A-Za-z ]+\) (mirall|csyncoC)\/.*$/';
-
-	protected $inputStream;
-	protected $content;
-	protected $items = [];
-	protected $allowedKeys = [
-		'get',
-		'post',
-		'files',
-		'server',
-		'env',
-		'cookies',
-		'urlParams',
-		'parameters',
-		'method',
-		'requesttoken',
-	];
-	/** @var ISecureRandom */
-	protected $secureRandom;
-	/** @var IConfig */
-	protected $config;
-	/** @var string */
-	protected $requestId = '';
-	/** @var ICrypto */
-	protected $crypto;
-	/** @var CsrfTokenManager|null */
-	protected $csrfTokenManager;
-
-	/** @var bool */
-	protected $contentDecoded = false;
-
-	/**
-	 * @param array $vars An associative array with the following optional values:
-	 *        - array 'urlParams' the parameters which were matched from the URL
-	 *        - array 'get' the $_GET array
-	 *        - array|string 'post' the $_POST array or JSON string
-	 *        - array 'files' the $_FILES array
-	 *        - array 'server' the $_SERVER array
-	 *        - array 'env' the $_ENV array
-	 *        - array 'cookies' the $_COOKIE array
-	 *        - string 'method' the request method (GET, POST etc)
-	 *        - string|false 'requesttoken' the requesttoken or false when not available
-	 * @param ISecureRandom $secureRandom
-	 * @param IConfig $config
-	 * @param CsrfTokenManager|null $csrfTokenManager
-	 * @param string $stream
-	 * @see https://www.php.net/manual/en/reserved.variables.php
-	 */
-	public function __construct(array $vars,
-								ISecureRandom $secureRandom,
-								IConfig $config,
-								CsrfTokenManager $csrfTokenManager = null,
-								string $stream = 'php://input') {
-		$this->inputStream = $stream;
-		$this->items['params'] = [];
-		$this->secureRandom = $secureRandom;
-		$this->config = $config;
-		$this->csrfTokenManager = $csrfTokenManager;
-
-		if (!array_key_exists('method', $vars)) {
-			$vars['method'] = 'GET';
-		}
-
-		foreach ($this->allowedKeys as $name) {
-			$this->items[$name] = isset($vars[$name])
-				? $vars[$name]
-				: [];
-		}
-
-		$this->items['parameters'] = array_merge(
-			$this->items['get'],
-			$this->items['post'],
-			$this->items['urlParams'],
-			$this->items['params']
-		);
-	}
-	/**
-	 * @param array $parameters
-	 */
-	public function setUrlParameters(array $parameters) {
-		$this->items['urlParams'] = $parameters;
-		$this->items['parameters'] = array_merge(
-			$this->items['parameters'],
-			$this->items['urlParams']
-		);
-	}
-
-	/**
-	 * Countable method
-	 * @return int
-	 */
-	public function count(): int {
-		return \count($this->items['parameters']);
-	}
-
-	/**
-	 * ArrayAccess methods
-	 *
-	 * Gives access to the combined GET, POST and urlParams arrays
-	 *
-	 * Examples:
-	 *
-	 * $var = $request['myvar'];
-	 *
-	 * or
-	 *
-	 * if(!isset($request['myvar']) {
-	 * 	// Do something
-	 * }
-	 *
-	 * $request['myvar'] = 'something'; // This throws an exception.
-	 *
-	 * @param string $offset The key to lookup
-	 * @return boolean
-	 */
-	public function offsetExists($offset): bool {
-		return isset($this->items['parameters'][$offset]);
-	}
-
-	/**
-	 * @see offsetExists
-	 * @param string $offset
-	 * @return mixed
-	 */
-	public function offsetGet($offset) {
-		return isset($this->items['parameters'][$offset])
-			? $this->items['parameters'][$offset]
-			: null;
-	}
-
-	/**
-	 * @see offsetExists
-	 * @param string $offset
-	 * @param mixed $value
-	 */
-	public function offsetSet($offset, $value) {
-		throw new \RuntimeException('You cannot change the contents of the request object');
-	}
-
-	/**
-	 * @see offsetExists
-	 * @param string $offset
-	 */
-	public function offsetUnset($offset) {
-		throw new \RuntimeException('You cannot change the contents of the request object');
-	}
-
-	/**
-	 * Magic property accessors
-	 * @param string $name
-	 * @param mixed $value
-	 */
-	public function __set($name, $value) {
-		throw new \RuntimeException('You cannot change the contents of the request object');
-	}
-
-	/**
-	 * Access request variables by method and name.
-	 * Examples:
-	 *
-	 * $request->post['myvar']; // Only look for POST variables
-	 * $request->myvar; or $request->{'myvar'}; or $request->{$myvar}
-	 * Looks in the combined GET, POST and urlParams array.
-	 *
-	 * If you access e.g. ->post but the current HTTP request method
-	 * is GET a \LogicException will be thrown.
-	 *
-	 * @param string $name The key to look for.
-	 * @throws \LogicException
-	 * @return mixed|null
-	 */
-	public function __get($name) {
-		switch ($name) {
-			case 'put':
-			case 'patch':
-			case 'get':
-			case 'post':
-				if ($this->method !== strtoupper($name)) {
-					throw new \LogicException(sprintf('%s cannot be accessed in a %s request.', $name, $this->method));
-				}
-				return $this->getContent();
-			case 'files':
-			case 'server':
-			case 'env':
-			case 'cookies':
-			case 'urlParams':
-			case 'method':
-				return isset($this->items[$name])
-					? $this->items[$name]
-					: null;
-			case 'parameters':
-			case 'params':
-				return $this->getContent();
-			default:
-				return isset($this[$name])
-					? $this[$name]
-					: null;
-		}
-	}
-
-	/**
-	 * @param string $name
-	 * @return bool
-	 */
-	public function __isset($name) {
-		if (\in_array($name, $this->allowedKeys, true)) {
-			return true;
-		}
-		return isset($this->items['parameters'][$name]);
-	}
-
-	/**
-	 * @param string $id
-	 */
-	public function __unset($id) {
-		throw new \RuntimeException('You cannot change the contents of the request object');
-	}
-
-	/**
-	 * Returns the value for a specific http header.
-	 *
-	 * This method returns an empty string if the header did not exist.
-	 *
-	 * @param string $name
-	 * @return string
-	 */
-	public function getHeader(string $name): string {
-		$name = strtoupper(str_replace('-', '_',$name));
-		if (isset($this->server['HTTP_' . $name])) {
-			return $this->server['HTTP_' . $name];
-		}
-
-		// There's a few headers that seem to end up in the top-level
-		// server array.
-		switch ($name) {
-			case 'CONTENT_TYPE':
-			case 'CONTENT_LENGTH':
-			case 'REMOTE_ADDR':
-				if (isset($this->server[$name])) {
-					return $this->server[$name];
-				}
-				break;
-		}
-
-		return '';
-	}
-
-	/**
-	 * Lets you access post and get parameters by the index
-	 * In case of json requests the encoded json body is accessed
-	 *
-	 * @param string $key the key which you want to access in the URL Parameter
-	 *                     placeholder, $_POST or $_GET array.
-	 *                     The priority how they're returned is the following:
-	 *                     1. URL parameters
-	 *                     2. POST parameters
-	 *                     3. GET parameters
-	 * @param mixed $default If the key is not found, this value will be returned
-	 * @return mixed the content of the array
-	 */
-	public function getParam(string $key, $default = null) {
-		return isset($this->parameters[$key])
-			? $this->parameters[$key]
-			: $default;
-	}
-
-	/**
-	 * Returns all params that were received, be it from the request
-	 * (as GET or POST) or throuh the URL by the route
-	 * @return array the array with all parameters
-	 */
-	public function getParams(): array {
-		return is_array($this->parameters) ? $this->parameters : [];
-	}
-
-	/**
-	 * Returns the method of the request
-	 * @return string the method of the request (POST, GET, etc)
-	 */
-	public function getMethod(): string {
-		return $this->method;
-	}
-
-	/**
-	 * Shortcut for accessing an uploaded file through the $_FILES array
-	 * @param string $key the key that will be taken from the $_FILES array
-	 * @return array the file in the $_FILES element
-	 */
-	public function getUploadedFile(string $key) {
-		return isset($this->files[$key]) ? $this->files[$key] : null;
-	}
-
-	/**
-	 * Shortcut for getting env variables
-	 * @param string $key the key that will be taken from the $_ENV array
-	 * @return array the value in the $_ENV element
-	 */
-	public function getEnv(string $key) {
-		return isset($this->env[$key]) ? $this->env[$key] : null;
-	}
-
-	/**
-	 * Shortcut for getting cookie variables
-	 * @param string $key the key that will be taken from the $_COOKIE array
-	 * @return string the value in the $_COOKIE element
-	 */
-	public function getCookie(string $key) {
-		return isset($this->cookies[$key]) ? $this->cookies[$key] : null;
-	}
-
-	/**
-	 * Returns the request body content.
-	 *
-	 * If the HTTP request method is PUT and the body
-	 * not application/x-www-form-urlencoded or application/json a stream
-	 * resource is returned, otherwise an array.
-	 *
-	 * @return array|string|resource The request body content or a resource to read the body stream.
-	 *
-	 * @throws \LogicException
-	 */
-	protected function getContent() {
-		// If the content can't be parsed into an array then return a stream resource.
-		if ($this->method === 'PUT'
-			&& $this->getHeader('Content-Length') !== '0'
-			&& $this->getHeader('Content-Length') !== ''
-			&& strpos($this->getHeader('Content-Type'), 'application/x-www-form-urlencoded') === false
-			&& strpos($this->getHeader('Content-Type'), 'application/json') === false
-		) {
-			if ($this->content === false) {
-				throw new \LogicException(
-					'"put" can only be accessed once if not '
-					. 'application/x-www-form-urlencoded or application/json.'
-				);
-			}
-			$this->content = false;
-			return fopen($this->inputStream, 'rb');
-		} else {
-			$this->decodeContent();
-			return $this->items['parameters'];
-		}
-	}
-
-	/**
-	 * Attempt to decode the content and populate parameters
-	 */
-	protected function decodeContent() {
-		if ($this->contentDecoded) {
-			return;
-		}
-		$params = [];
-
-		// 'application/json' must be decoded manually.
-		if (strpos($this->getHeader('Content-Type'), 'application/json') !== false) {
-			$params = json_decode(file_get_contents($this->inputStream), true);
-			if ($params !== null && \count($params) > 0) {
-				$this->items['params'] = $params;
-				if ($this->method === 'POST') {
-					$this->items['post'] = $params;
-				}
-			}
-
-			// Handle application/x-www-form-urlencoded for methods other than GET
-		// or post correctly
-		} elseif ($this->method !== 'GET'
-				&& $this->method !== 'POST'
-				&& strpos($this->getHeader('Content-Type'), 'application/x-www-form-urlencoded') !== false) {
-			parse_str(file_get_contents($this->inputStream), $params);
-			if (\is_array($params)) {
-				$this->items['params'] = $params;
-			}
-		}
-
-		if (\is_array($params)) {
-			$this->items['parameters'] = array_merge($this->items['parameters'], $params);
-		}
-		$this->contentDecoded = true;
-	}
-
-
-	/**
-	 * Checks if the CSRF check was correct
-	 * @return bool true if CSRF check passed
-	 */
-	public function passesCSRFCheck(): bool {
-		if ($this->csrfTokenManager === null) {
-			return false;
-		}
-
-		if (!$this->passesStrictCookieCheck()) {
-			return false;
-		}
-
-		if (isset($this->items['get']['requesttoken'])) {
-			$token = $this->items['get']['requesttoken'];
-		} elseif (isset($this->items['post']['requesttoken'])) {
-			$token = $this->items['post']['requesttoken'];
-		} elseif (isset($this->items['server']['HTTP_REQUESTTOKEN'])) {
-			$token = $this->items['server']['HTTP_REQUESTTOKEN'];
-		} else {
-			//no token found.
-			return false;
-		}
-		$token = new CsrfToken($token);
-
-		return $this->csrfTokenManager->isTokenValid($token);
-	}
-
-	/**
-	 * Whether the cookie checks are required
-	 *
-	 * @return bool
-	 */
-	private function cookieCheckRequired(): bool {
-		if ($this->getHeader('OCS-APIREQUEST')) {
-			return false;
-		}
-		if ($this->getCookie(session_name()) === null && $this->getCookie('nc_token') === null) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Wrapper around session_get_cookie_params
-	 *
-	 * @return array
-	 */
-	public function getCookieParams(): array {
-		return session_get_cookie_params();
-	}
-
-	/**
-	 * Appends the __Host- prefix to the cookie if applicable
-	 *
-	 * @param string $name
-	 * @return string
-	 */
-	protected function getProtectedCookieName(string $name): string {
-		$cookieParams = $this->getCookieParams();
-		$prefix = '';
-		if ($cookieParams['secure'] === true && $cookieParams['path'] === '/') {
-			$prefix = '__Host-';
-		}
-
-		return $prefix.$name;
-	}
-
-	/**
-	 * Checks if the strict cookie has been sent with the request if the request
-	 * is including any cookies.
-	 *
-	 * @return bool
-	 * @since 9.1.0
-	 */
-	public function passesStrictCookieCheck(): bool {
-		if (!$this->cookieCheckRequired()) {
-			return true;
-		}
-
-		$cookieName = $this->getProtectedCookieName('nc_sameSiteCookiestrict');
-		if ($this->getCookie($cookieName) === 'true'
-			&& $this->passesLaxCookieCheck()) {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Checks if the lax cookie has been sent with the request if the request
-	 * is including any cookies.
-	 *
-	 * @return bool
-	 * @since 9.1.0
-	 */
-	public function passesLaxCookieCheck(): bool {
-		if (!$this->cookieCheckRequired()) {
-			return true;
-		}
-
-		$cookieName = $this->getProtectedCookieName('nc_sameSiteCookielax');
-		if ($this->getCookie($cookieName) === 'true') {
-			return true;
-		}
-		return false;
-	}
-
-
-	/**
-	 * Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging
-	 * If `mod_unique_id` is installed this value will be taken.
-	 * @return string
-	 */
-	public function getId(): string {
-		if (isset($this->server['UNIQUE_ID'])) {
-			return $this->server['UNIQUE_ID'];
-		}
-
-		if (empty($this->requestId)) {
-			$validChars = ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS;
-			$this->requestId = $this->secureRandom->generate(20, $validChars);
-		}
-
-		return $this->requestId;
-	}
-
-	/**
-	 * Checks if given $remoteAddress matches given $trustedProxy.
-	 * If $trustedProxy is an IPv4 IP range given in CIDR notation, true will be returned if
-	 * $remoteAddress is an IPv4 address within that IP range.
-	 * Otherwise $remoteAddress will be compared to $trustedProxy literally and the result
-	 * will be returned.
-	 * @return boolean true if $remoteAddress matches $trustedProxy, false otherwise
-	 */
-	protected function matchesTrustedProxy($trustedProxy, $remoteAddress) {
-		$cidrre = '/^([0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3})\/([0-9]{1,2})$/';
-
-		if (preg_match($cidrre, $trustedProxy, $match)) {
-			$net = $match[1];
-			$shiftbits = min(32, max(0, 32 - intval($match[2])));
-			$netnum = ip2long($net) >> $shiftbits;
-			$ipnum = ip2long($remoteAddress) >> $shiftbits;
-
-			return $ipnum === $netnum;
-		}
-
-		return $trustedProxy === $remoteAddress;
-	}
-
-	/**
-	 * Checks if given $remoteAddress matches any entry in the given array $trustedProxies.
-	 * For details regarding what "match" means, refer to `matchesTrustedProxy`.
-	 * @return boolean true if $remoteAddress matches any entry in $trustedProxies, false otherwise
-	 */
-	protected function isTrustedProxy($trustedProxies, $remoteAddress) {
-		foreach ($trustedProxies as $tp) {
-			if ($this->matchesTrustedProxy($tp, $remoteAddress)) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Returns the remote address, if the connection came from a trusted proxy
-	 * and `forwarded_for_headers` has been configured then the IP address
-	 * specified in this header will be returned instead.
-	 * Do always use this instead of $_SERVER['REMOTE_ADDR']
-	 * @return string IP address
-	 */
-	public function getRemoteAddress(): string {
-		$remoteAddress = isset($this->server['REMOTE_ADDR']) ? $this->server['REMOTE_ADDR'] : '';
-		$trustedProxies = $this->config->getSystemValue('trusted_proxies', []);
-
-		if (\is_array($trustedProxies) && $this->isTrustedProxy($trustedProxies, $remoteAddress)) {
-			$forwardedForHeaders = $this->config->getSystemValue('forwarded_for_headers', [
-				'HTTP_X_FORWARDED_FOR'
-				// only have one default, so we cannot ship an insecure product out of the box
-			]);
-
-			foreach ($forwardedForHeaders as $header) {
-				if (isset($this->server[$header])) {
-					foreach (explode(',', $this->server[$header]) as $IP) {
-						$IP = trim($IP);
-
-						// remove brackets from IPv6 addresses
-						if (strpos($IP, '[') === 0 && substr($IP, -1) === ']') {
-							$IP = substr($IP, 1, -1);
-						}
-
-						if (filter_var($IP, FILTER_VALIDATE_IP) !== false) {
-							return $IP;
-						}
-					}
-				}
-			}
-		}
-
-		return $remoteAddress;
-	}
-
-	/**
-	 * Check overwrite condition
-	 * @param string $type
-	 * @return bool
-	 */
-	private function isOverwriteCondition(string $type = ''): bool {
-		$regex = '/' . $this->config->getSystemValue('overwritecondaddr', '')  . '/';
-		$remoteAddr = isset($this->server['REMOTE_ADDR']) ? $this->server['REMOTE_ADDR'] : '';
-		return $regex === '//' || preg_match($regex, $remoteAddr) === 1
-		|| $type !== 'protocol';
-	}
-
-	/**
-	 * Returns the server protocol. It respects one or more reverse proxies servers
-	 * and load balancers
-	 * @return string Server protocol (http or https)
-	 */
-	public function getServerProtocol(): string {
-		if ($this->config->getSystemValue('overwriteprotocol') !== ''
-			&& $this->isOverwriteCondition('protocol')) {
-			return $this->config->getSystemValue('overwriteprotocol');
-		}
-
-		if ($this->fromTrustedProxy() && isset($this->server['HTTP_X_FORWARDED_PROTO'])) {
-			if (strpos($this->server['HTTP_X_FORWARDED_PROTO'], ',') !== false) {
-				$parts = explode(',', $this->server['HTTP_X_FORWARDED_PROTO']);
-				$proto = strtolower(trim($parts[0]));
-			} else {
-				$proto = strtolower($this->server['HTTP_X_FORWARDED_PROTO']);
-			}
-
-			// Verify that the protocol is always HTTP or HTTPS
-			// default to http if an invalid value is provided
-			return $proto === 'https' ? 'https' : 'http';
-		}
-
-		if (isset($this->server['HTTPS'])
-			&& $this->server['HTTPS'] !== null
-			&& $this->server['HTTPS'] !== 'off'
-			&& $this->server['HTTPS'] !== '') {
-			return 'https';
-		}
-
-		return 'http';
-	}
-
-	/**
-	 * Returns the used HTTP protocol.
-	 *
-	 * @return string HTTP protocol. HTTP/2, HTTP/1.1 or HTTP/1.0.
-	 */
-	public function getHttpProtocol(): string {
-		$claimedProtocol = $this->server['SERVER_PROTOCOL'];
-
-		if (\is_string($claimedProtocol)) {
-			$claimedProtocol = strtoupper($claimedProtocol);
-		}
-
-		$validProtocols = [
-			'HTTP/1.0',
-			'HTTP/1.1',
-			'HTTP/2',
-		];
-
-		if (\in_array($claimedProtocol, $validProtocols, true)) {
-			return $claimedProtocol;
-		}
-
-		return 'HTTP/1.1';
-	}
-
-	/**
-	 * Returns the request uri, even if the website uses one or more
-	 * reverse proxies
-	 * @return string
-	 */
-	public function getRequestUri(): string {
-		$uri = isset($this->server['REQUEST_URI']) ? $this->server['REQUEST_URI'] : '';
-		if ($this->config->getSystemValue('overwritewebroot') !== '' && $this->isOverwriteCondition()) {
-			$uri = $this->getScriptName() . substr($uri, \strlen($this->server['SCRIPT_NAME']));
-		}
-		return $uri;
-	}
-
-	/**
-	 * Get raw PathInfo from request (not urldecoded)
-	 * @throws \Exception
-	 * @return string Path info
-	 */
-	public function getRawPathInfo(): string {
-		$requestUri = isset($this->server['REQUEST_URI']) ? $this->server['REQUEST_URI'] : '';
-		// remove too many slashes - can be caused by reverse proxy configuration
-		$requestUri = preg_replace('%/{2,}%', '/', $requestUri);
-
-		// Remove the query string from REQUEST_URI
-		if ($pos = strpos($requestUri, '?')) {
-			$requestUri = substr($requestUri, 0, $pos);
-		}
-
-		$scriptName = $this->server['SCRIPT_NAME'];
-		$pathInfo = $requestUri;
-
-		// strip off the script name's dir and file name
-		// FIXME: Sabre does not really belong here
-		list($path, $name) = \Sabre\Uri\split($scriptName);
-		if (!empty($path)) {
-			if ($path === $pathInfo || strpos($pathInfo, $path.'/') === 0) {
-				$pathInfo = substr($pathInfo, \strlen($path));
-			} else {
-				throw new \Exception("The requested uri($requestUri) cannot be processed by the script '$scriptName')");
-			}
-		}
-		if ($name === null) {
-			$name = '';
-		}
-
-		if (strpos($pathInfo, '/'.$name) === 0) {
-			$pathInfo = substr($pathInfo, \strlen($name) + 1);
-		}
-		if ($name !== '' && strpos($pathInfo, $name) === 0) {
-			$pathInfo = substr($pathInfo, \strlen($name));
-		}
-		if ($pathInfo === false || $pathInfo === '/') {
-			return '';
-		} else {
-			return $pathInfo;
-		}
-	}
-
-	/**
-	 * Get PathInfo from request
-	 * @throws \Exception
-	 * @return string|false Path info or false when not found
-	 */
-	public function getPathInfo() {
-		$pathInfo = $this->getRawPathInfo();
-		// following is taken from \Sabre\HTTP\URLUtil::decodePathSegment
-		$pathInfo = rawurldecode($pathInfo);
-		$encoding = mb_detect_encoding($pathInfo, ['UTF-8', 'ISO-8859-1']);
-
-		switch ($encoding) {
-			case 'ISO-8859-1':
-				$pathInfo = utf8_encode($pathInfo);
-		}
-		// end copy
-
-		return $pathInfo;
-	}
-
-	/**
-	 * Returns the script name, even if the website uses one or more
-	 * reverse proxies
-	 * @return string the script name
-	 */
-	public function getScriptName(): string {
-		$name = $this->server['SCRIPT_NAME'];
-		$overwriteWebRoot = $this->config->getSystemValue('overwritewebroot');
-		if ($overwriteWebRoot !== '' && $this->isOverwriteCondition()) {
-			// FIXME: This code is untestable due to __DIR__, also that hardcoded path is really dangerous
-			$serverRoot = str_replace('\\', '/', substr(__DIR__, 0, -\strlen('lib/private/appframework/http/')));
-			$suburi = str_replace('\\', '/', substr(realpath($this->server['SCRIPT_FILENAME']), \strlen($serverRoot)));
-			$name = '/' . ltrim($overwriteWebRoot . $suburi, '/');
-		}
-		return $name;
-	}
-
-	/**
-	 * Checks whether the user agent matches a given regex
-	 * @param array $agent array of agent names
-	 * @return bool true if at least one of the given agent matches, false otherwise
-	 */
-	public function isUserAgent(array $agent): bool {
-		if (!isset($this->server['HTTP_USER_AGENT'])) {
-			return false;
-		}
-		foreach ($agent as $regex) {
-			if (preg_match($regex, $this->server['HTTP_USER_AGENT'])) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * Returns the unverified server host from the headers without checking
-	 * whether it is a trusted domain
-	 * @return string Server host
-	 */
-	public function getInsecureServerHost(): string {
-		if ($this->fromTrustedProxy() && $this->getOverwriteHost() !== null) {
-			return $this->getOverwriteHost();
-		}
-
-		$host = 'localhost';
-		if ($this->fromTrustedProxy() && isset($this->server['HTTP_X_FORWARDED_HOST'])) {
-			if (strpos($this->server['HTTP_X_FORWARDED_HOST'], ',') !== false) {
-				$parts = explode(',', $this->server['HTTP_X_FORWARDED_HOST']);
-				$host = trim(current($parts));
-			} else {
-				$host = $this->server['HTTP_X_FORWARDED_HOST'];
-			}
-		} else {
-			if (isset($this->server['HTTP_HOST'])) {
-				$host = $this->server['HTTP_HOST'];
-			} elseif (isset($this->server['SERVER_NAME'])) {
-				$host = $this->server['SERVER_NAME'];
-			}
-		}
-
-		return $host;
-	}
-
-
-	/**
-	 * Returns the server host from the headers, or the first configured
-	 * trusted domain if the host isn't in the trusted list
-	 * @return string Server host
-	 */
-	public function getServerHost(): string {
-		// overwritehost is always trusted
-		$host = $this->getOverwriteHost();
-		if ($host !== null) {
-			return $host;
-		}
-
-		// get the host from the headers
-		$host = $this->getInsecureServerHost();
-
-		// Verify that the host is a trusted domain if the trusted domains
-		// are defined
-		// If no trusted domain is provided the first trusted domain is returned
-		$trustedDomainHelper = new TrustedDomainHelper($this->config);
-		if ($trustedDomainHelper->isTrustedDomain($host)) {
-			return $host;
-		}
-
-		$trustedList = (array)$this->config->getSystemValue('trusted_domains', []);
-		if (count($trustedList) > 0) {
-			return reset($trustedList);
-		}
-
-		return '';
-	}
-
-	/**
-	 * Returns the overwritehost setting from the config if set and
-	 * if the overwrite condition is met
-	 * @return string|null overwritehost value or null if not defined or the defined condition
-	 * isn't met
-	 */
-	private function getOverwriteHost() {
-		if ($this->config->getSystemValue('overwritehost') !== '' && $this->isOverwriteCondition()) {
-			return $this->config->getSystemValue('overwritehost');
-		}
-		return null;
-	}
-
-	private function fromTrustedProxy(): bool {
-		$remoteAddress = isset($this->server['REMOTE_ADDR']) ? $this->server['REMOTE_ADDR'] : '';
-		$trustedProxies = $this->config->getSystemValue('trusted_proxies', []);
-
-		return \is_array($trustedProxies) && $this->isTrustedProxy($trustedProxies, $remoteAddress);
-	}
+    public const USER_AGENT_IE = '/(MSIE)|(Trident)/';
+    // Microsoft Edge User Agent from https://msdn.microsoft.com/en-us/library/hh869301(v=vs.85).aspx
+    public const USER_AGENT_MS_EDGE = '/^Mozilla\/5\.0 \([^)]+\) AppleWebKit\/[0-9.]+ \(KHTML, like Gecko\) Chrome\/[0-9.]+ (Mobile Safari|Safari)\/[0-9.]+ Edge\/[0-9.]+$/';
+    // Firefox User Agent from https://developer.mozilla.org/en-US/docs/Web/HTTP/Gecko_user_agent_string_reference
+    public const USER_AGENT_FIREFOX = '/^Mozilla\/5\.0 \([^)]+\) Gecko\/[0-9.]+ Firefox\/[0-9.]+$/';
+    // Chrome User Agent from https://developer.chrome.com/multidevice/user-agent
+    public const USER_AGENT_CHROME = '/^Mozilla\/5\.0 \([^)]+\) AppleWebKit\/[0-9.]+ \(KHTML, like Gecko\)( Ubuntu Chromium\/[0-9.]+|) Chrome\/[0-9.]+ (Mobile Safari|Safari)\/[0-9.]+( (Vivaldi|Brave|OPR)\/[0-9.]+|)$/';
+    // Safari User Agent from http://www.useragentstring.com/pages/Safari/
+    public const USER_AGENT_SAFARI = '/^Mozilla\/5\.0 \([^)]+\) AppleWebKit\/[0-9.]+ \(KHTML, like Gecko\) Version\/[0-9.]+ Safari\/[0-9.A-Z]+$/';
+    // Android Chrome user agent: https://developers.google.com/chrome/mobile/docs/user-agent
+    public const USER_AGENT_ANDROID_MOBILE_CHROME = '#Android.*Chrome/[.0-9]*#';
+    public const USER_AGENT_FREEBOX = '#^Mozilla/5\.0$#';
+    public const REGEX_LOCALHOST = '/^(127\.0\.0\.1|localhost|\[::1\])$/';
+
+    /**
+     * @deprecated use \OCP\IRequest::USER_AGENT_CLIENT_IOS instead
+     */
+    public const USER_AGENT_OWNCLOUD_IOS = '/^Mozilla\/5\.0 \(iOS\) (ownCloud|Nextcloud)\-iOS.*$/';
+    /**
+     * @deprecated use \OCP\IRequest::USER_AGENT_CLIENT_ANDROID instead
+     */
+    public const USER_AGENT_OWNCLOUD_ANDROID = '/^Mozilla\/5\.0 \(Android\) ownCloud\-android.*$/';
+    /**
+     * @deprecated use \OCP\IRequest::USER_AGENT_CLIENT_DESKTOP instead
+     */
+    public const USER_AGENT_OWNCLOUD_DESKTOP = '/^Mozilla\/5\.0 \([A-Za-z ]+\) (mirall|csyncoC)\/.*$/';
+
+    protected $inputStream;
+    protected $content;
+    protected $items = [];
+    protected $allowedKeys = [
+        'get',
+        'post',
+        'files',
+        'server',
+        'env',
+        'cookies',
+        'urlParams',
+        'parameters',
+        'method',
+        'requesttoken',
+    ];
+    /** @var ISecureRandom */
+    protected $secureRandom;
+    /** @var IConfig */
+    protected $config;
+    /** @var string */
+    protected $requestId = '';
+    /** @var ICrypto */
+    protected $crypto;
+    /** @var CsrfTokenManager|null */
+    protected $csrfTokenManager;
+
+    /** @var bool */
+    protected $contentDecoded = false;
+
+    /**
+     * @param array $vars An associative array with the following optional values:
+     *        - array 'urlParams' the parameters which were matched from the URL
+     *        - array 'get' the $_GET array
+     *        - array|string 'post' the $_POST array or JSON string
+     *        - array 'files' the $_FILES array
+     *        - array 'server' the $_SERVER array
+     *        - array 'env' the $_ENV array
+     *        - array 'cookies' the $_COOKIE array
+     *        - string 'method' the request method (GET, POST etc)
+     *        - string|false 'requesttoken' the requesttoken or false when not available
+     * @param ISecureRandom $secureRandom
+     * @param IConfig $config
+     * @param CsrfTokenManager|null $csrfTokenManager
+     * @param string $stream
+     * @see https://www.php.net/manual/en/reserved.variables.php
+     */
+    public function __construct(array $vars,
+                                ISecureRandom $secureRandom,
+                                IConfig $config,
+                                CsrfTokenManager $csrfTokenManager = null,
+                                string $stream = 'php://input') {
+        $this->inputStream = $stream;
+        $this->items['params'] = [];
+        $this->secureRandom = $secureRandom;
+        $this->config = $config;
+        $this->csrfTokenManager = $csrfTokenManager;
+
+        if (!array_key_exists('method', $vars)) {
+            $vars['method'] = 'GET';
+        }
+
+        foreach ($this->allowedKeys as $name) {
+            $this->items[$name] = isset($vars[$name])
+                ? $vars[$name]
+                : [];
+        }
+
+        $this->items['parameters'] = array_merge(
+            $this->items['get'],
+            $this->items['post'],
+            $this->items['urlParams'],
+            $this->items['params']
+        );
+    }
+    /**
+     * @param array $parameters
+     */
+    public function setUrlParameters(array $parameters) {
+        $this->items['urlParams'] = $parameters;
+        $this->items['parameters'] = array_merge(
+            $this->items['parameters'],
+            $this->items['urlParams']
+        );
+    }
+
+    /**
+     * Countable method
+     * @return int
+     */
+    public function count(): int {
+        return \count($this->items['parameters']);
+    }
+
+    /**
+     * ArrayAccess methods
+     *
+     * Gives access to the combined GET, POST and urlParams arrays
+     *
+     * Examples:
+     *
+     * $var = $request['myvar'];
+     *
+     * or
+     *
+     * if(!isset($request['myvar']) {
+     * 	// Do something
+     * }
+     *
+     * $request['myvar'] = 'something'; // This throws an exception.
+     *
+     * @param string $offset The key to lookup
+     * @return boolean
+     */
+    public function offsetExists($offset): bool {
+        return isset($this->items['parameters'][$offset]);
+    }
+
+    /**
+     * @see offsetExists
+     * @param string $offset
+     * @return mixed
+     */
+    public function offsetGet($offset) {
+        return isset($this->items['parameters'][$offset])
+            ? $this->items['parameters'][$offset]
+            : null;
+    }
+
+    /**
+     * @see offsetExists
+     * @param string $offset
+     * @param mixed $value
+     */
+    public function offsetSet($offset, $value) {
+        throw new \RuntimeException('You cannot change the contents of the request object');
+    }
+
+    /**
+     * @see offsetExists
+     * @param string $offset
+     */
+    public function offsetUnset($offset) {
+        throw new \RuntimeException('You cannot change the contents of the request object');
+    }
+
+    /**
+     * Magic property accessors
+     * @param string $name
+     * @param mixed $value
+     */
+    public function __set($name, $value) {
+        throw new \RuntimeException('You cannot change the contents of the request object');
+    }
+
+    /**
+     * Access request variables by method and name.
+     * Examples:
+     *
+     * $request->post['myvar']; // Only look for POST variables
+     * $request->myvar; or $request->{'myvar'}; or $request->{$myvar}
+     * Looks in the combined GET, POST and urlParams array.
+     *
+     * If you access e.g. ->post but the current HTTP request method
+     * is GET a \LogicException will be thrown.
+     *
+     * @param string $name The key to look for.
+     * @throws \LogicException
+     * @return mixed|null
+     */
+    public function __get($name) {
+        switch ($name) {
+            case 'put':
+            case 'patch':
+            case 'get':
+            case 'post':
+                if ($this->method !== strtoupper($name)) {
+                    throw new \LogicException(sprintf('%s cannot be accessed in a %s request.', $name, $this->method));
+                }
+                return $this->getContent();
+            case 'files':
+            case 'server':
+            case 'env':
+            case 'cookies':
+            case 'urlParams':
+            case 'method':
+                return isset($this->items[$name])
+                    ? $this->items[$name]
+                    : null;
+            case 'parameters':
+            case 'params':
+                return $this->getContent();
+            default:
+                return isset($this[$name])
+                    ? $this[$name]
+                    : null;
+        }
+    }
+
+    /**
+     * @param string $name
+     * @return bool
+     */
+    public function __isset($name) {
+        if (\in_array($name, $this->allowedKeys, true)) {
+            return true;
+        }
+        return isset($this->items['parameters'][$name]);
+    }
+
+    /**
+     * @param string $id
+     */
+    public function __unset($id) {
+        throw new \RuntimeException('You cannot change the contents of the request object');
+    }
+
+    /**
+     * Returns the value for a specific http header.
+     *
+     * This method returns an empty string if the header did not exist.
+     *
+     * @param string $name
+     * @return string
+     */
+    public function getHeader(string $name): string {
+        $name = strtoupper(str_replace('-', '_',$name));
+        if (isset($this->server['HTTP_' . $name])) {
+            return $this->server['HTTP_' . $name];
+        }
+
+        // There's a few headers that seem to end up in the top-level
+        // server array.
+        switch ($name) {
+            case 'CONTENT_TYPE':
+            case 'CONTENT_LENGTH':
+            case 'REMOTE_ADDR':
+                if (isset($this->server[$name])) {
+                    return $this->server[$name];
+                }
+                break;
+        }
+
+        return '';
+    }
+
+    /**
+     * Lets you access post and get parameters by the index
+     * In case of json requests the encoded json body is accessed
+     *
+     * @param string $key the key which you want to access in the URL Parameter
+     *                     placeholder, $_POST or $_GET array.
+     *                     The priority how they're returned is the following:
+     *                     1. URL parameters
+     *                     2. POST parameters
+     *                     3. GET parameters
+     * @param mixed $default If the key is not found, this value will be returned
+     * @return mixed the content of the array
+     */
+    public function getParam(string $key, $default = null) {
+        return isset($this->parameters[$key])
+            ? $this->parameters[$key]
+            : $default;
+    }
+
+    /**
+     * Returns all params that were received, be it from the request
+     * (as GET or POST) or throuh the URL by the route
+     * @return array the array with all parameters
+     */
+    public function getParams(): array {
+        return is_array($this->parameters) ? $this->parameters : [];
+    }
+
+    /**
+     * Returns the method of the request
+     * @return string the method of the request (POST, GET, etc)
+     */
+    public function getMethod(): string {
+        return $this->method;
+    }
+
+    /**
+     * Shortcut for accessing an uploaded file through the $_FILES array
+     * @param string $key the key that will be taken from the $_FILES array
+     * @return array the file in the $_FILES element
+     */
+    public function getUploadedFile(string $key) {
+        return isset($this->files[$key]) ? $this->files[$key] : null;
+    }
+
+    /**
+     * Shortcut for getting env variables
+     * @param string $key the key that will be taken from the $_ENV array
+     * @return array the value in the $_ENV element
+     */
+    public function getEnv(string $key) {
+        return isset($this->env[$key]) ? $this->env[$key] : null;
+    }
+
+    /**
+     * Shortcut for getting cookie variables
+     * @param string $key the key that will be taken from the $_COOKIE array
+     * @return string the value in the $_COOKIE element
+     */
+    public function getCookie(string $key) {
+        return isset($this->cookies[$key]) ? $this->cookies[$key] : null;
+    }
+
+    /**
+     * Returns the request body content.
+     *
+     * If the HTTP request method is PUT and the body
+     * not application/x-www-form-urlencoded or application/json a stream
+     * resource is returned, otherwise an array.
+     *
+     * @return array|string|resource The request body content or a resource to read the body stream.
+     *
+     * @throws \LogicException
+     */
+    protected function getContent() {
+        // If the content can't be parsed into an array then return a stream resource.
+        if ($this->method === 'PUT'
+            && $this->getHeader('Content-Length') !== '0'
+            && $this->getHeader('Content-Length') !== ''
+            && strpos($this->getHeader('Content-Type'), 'application/x-www-form-urlencoded') === false
+            && strpos($this->getHeader('Content-Type'), 'application/json') === false
+        ) {
+            if ($this->content === false) {
+                throw new \LogicException(
+                    '"put" can only be accessed once if not '
+                    . 'application/x-www-form-urlencoded or application/json.'
+                );
+            }
+            $this->content = false;
+            return fopen($this->inputStream, 'rb');
+        } else {
+            $this->decodeContent();
+            return $this->items['parameters'];
+        }
+    }
+
+    /**
+     * Attempt to decode the content and populate parameters
+     */
+    protected function decodeContent() {
+        if ($this->contentDecoded) {
+            return;
+        }
+        $params = [];
+
+        // 'application/json' must be decoded manually.
+        if (strpos($this->getHeader('Content-Type'), 'application/json') !== false) {
+            $params = json_decode(file_get_contents($this->inputStream), true);
+            if ($params !== null && \count($params) > 0) {
+                $this->items['params'] = $params;
+                if ($this->method === 'POST') {
+                    $this->items['post'] = $params;
+                }
+            }
+
+            // Handle application/x-www-form-urlencoded for methods other than GET
+        // or post correctly
+        } elseif ($this->method !== 'GET'
+                && $this->method !== 'POST'
+                && strpos($this->getHeader('Content-Type'), 'application/x-www-form-urlencoded') !== false) {
+            parse_str(file_get_contents($this->inputStream), $params);
+            if (\is_array($params)) {
+                $this->items['params'] = $params;
+            }
+        }
+
+        if (\is_array($params)) {
+            $this->items['parameters'] = array_merge($this->items['parameters'], $params);
+        }
+        $this->contentDecoded = true;
+    }
+
+
+    /**
+     * Checks if the CSRF check was correct
+     * @return bool true if CSRF check passed
+     */
+    public function passesCSRFCheck(): bool {
+        if ($this->csrfTokenManager === null) {
+            return false;
+        }
+
+        if (!$this->passesStrictCookieCheck()) {
+            return false;
+        }
+
+        if (isset($this->items['get']['requesttoken'])) {
+            $token = $this->items['get']['requesttoken'];
+        } elseif (isset($this->items['post']['requesttoken'])) {
+            $token = $this->items['post']['requesttoken'];
+        } elseif (isset($this->items['server']['HTTP_REQUESTTOKEN'])) {
+            $token = $this->items['server']['HTTP_REQUESTTOKEN'];
+        } else {
+            //no token found.
+            return false;
+        }
+        $token = new CsrfToken($token);
+
+        return $this->csrfTokenManager->isTokenValid($token);
+    }
+
+    /**
+     * Whether the cookie checks are required
+     *
+     * @return bool
+     */
+    private function cookieCheckRequired(): bool {
+        if ($this->getHeader('OCS-APIREQUEST')) {
+            return false;
+        }
+        if ($this->getCookie(session_name()) === null && $this->getCookie('nc_token') === null) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Wrapper around session_get_cookie_params
+     *
+     * @return array
+     */
+    public function getCookieParams(): array {
+        return session_get_cookie_params();
+    }
+
+    /**
+     * Appends the __Host- prefix to the cookie if applicable
+     *
+     * @param string $name
+     * @return string
+     */
+    protected function getProtectedCookieName(string $name): string {
+        $cookieParams = $this->getCookieParams();
+        $prefix = '';
+        if ($cookieParams['secure'] === true && $cookieParams['path'] === '/') {
+            $prefix = '__Host-';
+        }
+
+        return $prefix.$name;
+    }
+
+    /**
+     * Checks if the strict cookie has been sent with the request if the request
+     * is including any cookies.
+     *
+     * @return bool
+     * @since 9.1.0
+     */
+    public function passesStrictCookieCheck(): bool {
+        if (!$this->cookieCheckRequired()) {
+            return true;
+        }
+
+        $cookieName = $this->getProtectedCookieName('nc_sameSiteCookiestrict');
+        if ($this->getCookie($cookieName) === 'true'
+            && $this->passesLaxCookieCheck()) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Checks if the lax cookie has been sent with the request if the request
+     * is including any cookies.
+     *
+     * @return bool
+     * @since 9.1.0
+     */
+    public function passesLaxCookieCheck(): bool {
+        if (!$this->cookieCheckRequired()) {
+            return true;
+        }
+
+        $cookieName = $this->getProtectedCookieName('nc_sameSiteCookielax');
+        if ($this->getCookie($cookieName) === 'true') {
+            return true;
+        }
+        return false;
+    }
+
+
+    /**
+     * Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging
+     * If `mod_unique_id` is installed this value will be taken.
+     * @return string
+     */
+    public function getId(): string {
+        if (isset($this->server['UNIQUE_ID'])) {
+            return $this->server['UNIQUE_ID'];
+        }
+
+        if (empty($this->requestId)) {
+            $validChars = ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS;
+            $this->requestId = $this->secureRandom->generate(20, $validChars);
+        }
+
+        return $this->requestId;
+    }
+
+    /**
+     * Checks if given $remoteAddress matches given $trustedProxy.
+     * If $trustedProxy is an IPv4 IP range given in CIDR notation, true will be returned if
+     * $remoteAddress is an IPv4 address within that IP range.
+     * Otherwise $remoteAddress will be compared to $trustedProxy literally and the result
+     * will be returned.
+     * @return boolean true if $remoteAddress matches $trustedProxy, false otherwise
+     */
+    protected function matchesTrustedProxy($trustedProxy, $remoteAddress) {
+        $cidrre = '/^([0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3})\/([0-9]{1,2})$/';
+
+        if (preg_match($cidrre, $trustedProxy, $match)) {
+            $net = $match[1];
+            $shiftbits = min(32, max(0, 32 - intval($match[2])));
+            $netnum = ip2long($net) >> $shiftbits;
+            $ipnum = ip2long($remoteAddress) >> $shiftbits;
+
+            return $ipnum === $netnum;
+        }
+
+        return $trustedProxy === $remoteAddress;
+    }
+
+    /**
+     * Checks if given $remoteAddress matches any entry in the given array $trustedProxies.
+     * For details regarding what "match" means, refer to `matchesTrustedProxy`.
+     * @return boolean true if $remoteAddress matches any entry in $trustedProxies, false otherwise
+     */
+    protected function isTrustedProxy($trustedProxies, $remoteAddress) {
+        foreach ($trustedProxies as $tp) {
+            if ($this->matchesTrustedProxy($tp, $remoteAddress)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Returns the remote address, if the connection came from a trusted proxy
+     * and `forwarded_for_headers` has been configured then the IP address
+     * specified in this header will be returned instead.
+     * Do always use this instead of $_SERVER['REMOTE_ADDR']
+     * @return string IP address
+     */
+    public function getRemoteAddress(): string {
+        $remoteAddress = isset($this->server['REMOTE_ADDR']) ? $this->server['REMOTE_ADDR'] : '';
+        $trustedProxies = $this->config->getSystemValue('trusted_proxies', []);
+
+        if (\is_array($trustedProxies) && $this->isTrustedProxy($trustedProxies, $remoteAddress)) {
+            $forwardedForHeaders = $this->config->getSystemValue('forwarded_for_headers', [
+                'HTTP_X_FORWARDED_FOR'
+                // only have one default, so we cannot ship an insecure product out of the box
+            ]);
+
+            foreach ($forwardedForHeaders as $header) {
+                if (isset($this->server[$header])) {
+                    foreach (explode(',', $this->server[$header]) as $IP) {
+                        $IP = trim($IP);
+
+                        // remove brackets from IPv6 addresses
+                        if (strpos($IP, '[') === 0 && substr($IP, -1) === ']') {
+                            $IP = substr($IP, 1, -1);
+                        }
+
+                        if (filter_var($IP, FILTER_VALIDATE_IP) !== false) {
+                            return $IP;
+                        }
+                    }
+                }
+            }
+        }
+
+        return $remoteAddress;
+    }
+
+    /**
+     * Check overwrite condition
+     * @param string $type
+     * @return bool
+     */
+    private function isOverwriteCondition(string $type = ''): bool {
+        $regex = '/' . $this->config->getSystemValue('overwritecondaddr', '')  . '/';
+        $remoteAddr = isset($this->server['REMOTE_ADDR']) ? $this->server['REMOTE_ADDR'] : '';
+        return $regex === '//' || preg_match($regex, $remoteAddr) === 1
+        || $type !== 'protocol';
+    }
+
+    /**
+     * Returns the server protocol. It respects one or more reverse proxies servers
+     * and load balancers
+     * @return string Server protocol (http or https)
+     */
+    public function getServerProtocol(): string {
+        if ($this->config->getSystemValue('overwriteprotocol') !== ''
+            && $this->isOverwriteCondition('protocol')) {
+            return $this->config->getSystemValue('overwriteprotocol');
+        }
+
+        if ($this->fromTrustedProxy() && isset($this->server['HTTP_X_FORWARDED_PROTO'])) {
+            if (strpos($this->server['HTTP_X_FORWARDED_PROTO'], ',') !== false) {
+                $parts = explode(',', $this->server['HTTP_X_FORWARDED_PROTO']);
+                $proto = strtolower(trim($parts[0]));
+            } else {
+                $proto = strtolower($this->server['HTTP_X_FORWARDED_PROTO']);
+            }
+
+            // Verify that the protocol is always HTTP or HTTPS
+            // default to http if an invalid value is provided
+            return $proto === 'https' ? 'https' : 'http';
+        }
+
+        if (isset($this->server['HTTPS'])
+            && $this->server['HTTPS'] !== null
+            && $this->server['HTTPS'] !== 'off'
+            && $this->server['HTTPS'] !== '') {
+            return 'https';
+        }
+
+        return 'http';
+    }
+
+    /**
+     * Returns the used HTTP protocol.
+     *
+     * @return string HTTP protocol. HTTP/2, HTTP/1.1 or HTTP/1.0.
+     */
+    public function getHttpProtocol(): string {
+        $claimedProtocol = $this->server['SERVER_PROTOCOL'];
+
+        if (\is_string($claimedProtocol)) {
+            $claimedProtocol = strtoupper($claimedProtocol);
+        }
+
+        $validProtocols = [
+            'HTTP/1.0',
+            'HTTP/1.1',
+            'HTTP/2',
+        ];
+
+        if (\in_array($claimedProtocol, $validProtocols, true)) {
+            return $claimedProtocol;
+        }
+
+        return 'HTTP/1.1';
+    }
+
+    /**
+     * Returns the request uri, even if the website uses one or more
+     * reverse proxies
+     * @return string
+     */
+    public function getRequestUri(): string {
+        $uri = isset($this->server['REQUEST_URI']) ? $this->server['REQUEST_URI'] : '';
+        if ($this->config->getSystemValue('overwritewebroot') !== '' && $this->isOverwriteCondition()) {
+            $uri = $this->getScriptName() . substr($uri, \strlen($this->server['SCRIPT_NAME']));
+        }
+        return $uri;
+    }
+
+    /**
+     * Get raw PathInfo from request (not urldecoded)
+     * @throws \Exception
+     * @return string Path info
+     */
+    public function getRawPathInfo(): string {
+        $requestUri = isset($this->server['REQUEST_URI']) ? $this->server['REQUEST_URI'] : '';
+        // remove too many slashes - can be caused by reverse proxy configuration
+        $requestUri = preg_replace('%/{2,}%', '/', $requestUri);
+
+        // Remove the query string from REQUEST_URI
+        if ($pos = strpos($requestUri, '?')) {
+            $requestUri = substr($requestUri, 0, $pos);
+        }
+
+        $scriptName = $this->server['SCRIPT_NAME'];
+        $pathInfo = $requestUri;
+
+        // strip off the script name's dir and file name
+        // FIXME: Sabre does not really belong here
+        list($path, $name) = \Sabre\Uri\split($scriptName);
+        if (!empty($path)) {
+            if ($path === $pathInfo || strpos($pathInfo, $path.'/') === 0) {
+                $pathInfo = substr($pathInfo, \strlen($path));
+            } else {
+                throw new \Exception("The requested uri($requestUri) cannot be processed by the script '$scriptName')");
+            }
+        }
+        if ($name === null) {
+            $name = '';
+        }
+
+        if (strpos($pathInfo, '/'.$name) === 0) {
+            $pathInfo = substr($pathInfo, \strlen($name) + 1);
+        }
+        if ($name !== '' && strpos($pathInfo, $name) === 0) {
+            $pathInfo = substr($pathInfo, \strlen($name));
+        }
+        if ($pathInfo === false || $pathInfo === '/') {
+            return '';
+        } else {
+            return $pathInfo;
+        }
+    }
+
+    /**
+     * Get PathInfo from request
+     * @throws \Exception
+     * @return string|false Path info or false when not found
+     */
+    public function getPathInfo() {
+        $pathInfo = $this->getRawPathInfo();
+        // following is taken from \Sabre\HTTP\URLUtil::decodePathSegment
+        $pathInfo = rawurldecode($pathInfo);
+        $encoding = mb_detect_encoding($pathInfo, ['UTF-8', 'ISO-8859-1']);
+
+        switch ($encoding) {
+            case 'ISO-8859-1':
+                $pathInfo = utf8_encode($pathInfo);
+        }
+        // end copy
+
+        return $pathInfo;
+    }
+
+    /**
+     * Returns the script name, even if the website uses one or more
+     * reverse proxies
+     * @return string the script name
+     */
+    public function getScriptName(): string {
+        $name = $this->server['SCRIPT_NAME'];
+        $overwriteWebRoot = $this->config->getSystemValue('overwritewebroot');
+        if ($overwriteWebRoot !== '' && $this->isOverwriteCondition()) {
+            // FIXME: This code is untestable due to __DIR__, also that hardcoded path is really dangerous
+            $serverRoot = str_replace('\\', '/', substr(__DIR__, 0, -\strlen('lib/private/appframework/http/')));
+            $suburi = str_replace('\\', '/', substr(realpath($this->server['SCRIPT_FILENAME']), \strlen($serverRoot)));
+            $name = '/' . ltrim($overwriteWebRoot . $suburi, '/');
+        }
+        return $name;
+    }
+
+    /**
+     * Checks whether the user agent matches a given regex
+     * @param array $agent array of agent names
+     * @return bool true if at least one of the given agent matches, false otherwise
+     */
+    public function isUserAgent(array $agent): bool {
+        if (!isset($this->server['HTTP_USER_AGENT'])) {
+            return false;
+        }
+        foreach ($agent as $regex) {
+            if (preg_match($regex, $this->server['HTTP_USER_AGENT'])) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Returns the unverified server host from the headers without checking
+     * whether it is a trusted domain
+     * @return string Server host
+     */
+    public function getInsecureServerHost(): string {
+        if ($this->fromTrustedProxy() && $this->getOverwriteHost() !== null) {
+            return $this->getOverwriteHost();
+        }
+
+        $host = 'localhost';
+        if ($this->fromTrustedProxy() && isset($this->server['HTTP_X_FORWARDED_HOST'])) {
+            if (strpos($this->server['HTTP_X_FORWARDED_HOST'], ',') !== false) {
+                $parts = explode(',', $this->server['HTTP_X_FORWARDED_HOST']);
+                $host = trim(current($parts));
+            } else {
+                $host = $this->server['HTTP_X_FORWARDED_HOST'];
+            }
+        } else {
+            if (isset($this->server['HTTP_HOST'])) {
+                $host = $this->server['HTTP_HOST'];
+            } elseif (isset($this->server['SERVER_NAME'])) {
+                $host = $this->server['SERVER_NAME'];
+            }
+        }
+
+        return $host;
+    }
+
+
+    /**
+     * Returns the server host from the headers, or the first configured
+     * trusted domain if the host isn't in the trusted list
+     * @return string Server host
+     */
+    public function getServerHost(): string {
+        // overwritehost is always trusted
+        $host = $this->getOverwriteHost();
+        if ($host !== null) {
+            return $host;
+        }
+
+        // get the host from the headers
+        $host = $this->getInsecureServerHost();
+
+        // Verify that the host is a trusted domain if the trusted domains
+        // are defined
+        // If no trusted domain is provided the first trusted domain is returned
+        $trustedDomainHelper = new TrustedDomainHelper($this->config);
+        if ($trustedDomainHelper->isTrustedDomain($host)) {
+            return $host;
+        }
+
+        $trustedList = (array)$this->config->getSystemValue('trusted_domains', []);
+        if (count($trustedList) > 0) {
+            return reset($trustedList);
+        }
+
+        return '';
+    }
+
+    /**
+     * Returns the overwritehost setting from the config if set and
+     * if the overwrite condition is met
+     * @return string|null overwritehost value or null if not defined or the defined condition
+     * isn't met
+     */
+    private function getOverwriteHost() {
+        if ($this->config->getSystemValue('overwritehost') !== '' && $this->isOverwriteCondition()) {
+            return $this->config->getSystemValue('overwritehost');
+        }
+        return null;
+    }
+
+    private function fromTrustedProxy(): bool {
+        $remoteAddress = isset($this->server['REMOTE_ADDR']) ? $this->server['REMOTE_ADDR'] : '';
+        $trustedProxies = $this->config->getSystemValue('trusted_proxies', []);
+
+        return \is_array($trustedProxies) && $this->isTrustedProxy($trustedProxies, $remoteAddress);
+    }
 }

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

Indentation +604 added lines, -604 removed lines

@@ -37,608 +37,608 @@
 use OCP\Lock\ILockingProvider;
 
 class Wrapper implements \OC\Files\Storage\Storage, ILockingStorage, IWriteStreamStorage {
-	/**
-	 * @var \OC\Files\Storage\Storage $storage
-	 */
-	protected $storage;
-
-	public $cache;
-	public $scanner;
-	public $watcher;
-	public $propagator;
-	public $updater;
-
-	/**
-	 * @param array $parameters
-	 */
-	public function __construct($parameters) {
-		$this->storage = $parameters['storage'];
-	}
-
-	/**
-	 * @return \OC\Files\Storage\Storage
-	 */
-	public function getWrapperStorage() {
-		return $this->storage;
-	}
-
-	/**
-	 * Get the identifier for the storage,
-	 * the returned id should be the same for every storage object that is created with the same parameters
-	 * and two storage objects with the same id should refer to two storages that display the same files.
-	 *
-	 * @return string
-	 */
-	public function getId() {
-		return $this->getWrapperStorage()->getId();
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.mkdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function mkdir($path) {
-		return $this->getWrapperStorage()->mkdir($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function rmdir($path) {
-		return $this->getWrapperStorage()->rmdir($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource
-	 */
-	public function opendir($path) {
-		return $this->getWrapperStorage()->opendir($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.is_dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function is_dir($path) {
-		return $this->getWrapperStorage()->is_dir($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.is_file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function is_file($path) {
-		return $this->getWrapperStorage()->is_file($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
-	 */
-	public function stat($path) {
-		return $this->getWrapperStorage()->stat($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function filetype($path) {
-		return $this->getWrapperStorage()->filetype($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
-	 */
-	public function filesize($path) {
-		return $this->getWrapperStorage()->filesize($path);
-	}
-
-	/**
-	 * check if a file can be created in $path
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isCreatable($path) {
-		return $this->getWrapperStorage()->isCreatable($path);
-	}
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isReadable($path) {
-		return $this->getWrapperStorage()->isReadable($path);
-	}
-
-	/**
-	 * check if a file can be written to
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isUpdatable($path) {
-		return $this->getWrapperStorage()->isUpdatable($path);
-	}
-
-	/**
-	 * check if a file can be deleted
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isDeletable($path) {
-		return $this->getWrapperStorage()->isDeletable($path);
-	}
-
-	/**
-	 * check if a file can be shared
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isSharable($path) {
-		return $this->getWrapperStorage()->isSharable($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->getWrapperStorage()->getPermissions($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function file_exists($path) {
-		return $this->getWrapperStorage()->file_exists($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function filemtime($path) {
-		return $this->getWrapperStorage()->filemtime($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function file_get_contents($path) {
-		return $this->getWrapperStorage()->file_get_contents($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->getWrapperStorage()->file_put_contents($path, $data);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function unlink($path) {
-		return $this->getWrapperStorage()->unlink($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function rename($path1, $path2) {
-		return $this->getWrapperStorage()->rename($path1, $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->getWrapperStorage()->copy($path1, $path2);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource
-	 */
-	public function fopen($path, $mode) {
-		return $this->getWrapperStorage()->fopen($path, $mode);
-	}
-
-	/**
-	 * 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
-	 */
-	public function getMimeType($path) {
-		return $this->getWrapperStorage()->getMimeType($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.hash.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string
-	 */
-	public function hash($type, $path, $raw = false) {
-		return $this->getWrapperStorage()->hash($type, $path, $raw);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function free_space($path) {
-		return $this->getWrapperStorage()->free_space($path);
-	}
-
-	/**
-	 * search for occurrences of $query in file names
-	 *
-	 * @param string $query
-	 * @return array
-	 */
-	public function search($query) {
-		return $this->getWrapperStorage()->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->getWrapperStorage()->touch($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
-	 */
-	public function getLocalFile($path) {
-		return $this->getWrapperStorage()->getLocalFile($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->getWrapperStorage()->hasUpdated($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->getWrapperStorage()->getCache($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->getWrapperStorage()->getScanner($path, $storage);
-	}
-
-
-	/**
-	 * get the user id of the owner of a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getOwner($path) {
-		return $this->getWrapperStorage()->getOwner($path);
-	}
-
-	/**
-	 * get a watcher instance for the cache
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
-	 * @return \OC\Files\Cache\Watcher
-	 */
-	public function getWatcher($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->getWrapperStorage()->getWatcher($path, $storage);
-	}
-
-	public function getPropagator($storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->getWrapperStorage()->getPropagator($storage);
-	}
-
-	public function getUpdater($storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->getWrapperStorage()->getUpdater($storage);
-	}
-
-	/**
-	 * @return \OC\Files\Cache\Storage
-	 */
-	public function getStorageCache() {
-		return $this->getWrapperStorage()->getStorageCache();
-	}
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getETag($path) {
-		return $this->getWrapperStorage()->getETag($path);
-	}
-
-	/**
-	 * Returns true
-	 *
-	 * @return true
-	 */
-	public function test() {
-		return $this->getWrapperStorage()->test();
-	}
-
-	/**
-	 * Returns the wrapped storage's value for isLocal()
-	 *
-	 * @return bool wrapped storage's isLocal() value
-	 */
-	public function isLocal() {
-		return $this->getWrapperStorage()->isLocal();
-	}
-
-	/**
-	 * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
-	 *
-	 * @param string $class
-	 * @return bool
-	 */
-	public function instanceOfStorage($class) {
-		if (ltrim($class, '\\') === 'OC\Files\Storage\Shared') {
-			// FIXME Temporary fix to keep existing checks working
-			$class = '\OCA\Files_Sharing\SharedStorage';
-		}
-		return is_a($this, $class) or $this->getWrapperStorage()->instanceOfStorage($class);
-	}
-
-	/**
-	 * Pass any methods custom to specific storage implementations to the wrapped storage
-	 *
-	 * @param string $method
-	 * @param array $args
-	 * @return mixed
-	 */
-	public function __call($method, $args) {
-		return call_user_func_array([$this->getWrapperStorage(), $method], $args);
-	}
-
-	/**
-	 * A custom storage implementation can return an url for direct download of a give file.
-	 *
-	 * For now the returned array can hold the parameter url - in future more attributes might follow.
-	 *
-	 * @param string $path
-	 * @return array
-	 */
-	public function getDirectDownload($path) {
-		return $this->getWrapperStorage()->getDirectDownload($path);
-	}
-
-	/**
-	 * Get availability of the storage
-	 *
-	 * @return array [ available, last_checked ]
-	 */
-	public function getAvailability() {
-		return $this->getWrapperStorage()->getAvailability();
-	}
-
-	/**
-	 * Set availability of the storage
-	 *
-	 * @param bool $isAvailable
-	 */
-	public function setAvailability($isAvailable) {
-		$this->getWrapperStorage()->setAvailability($isAvailable);
-	}
-
-	/**
-	 * @param string $path the path of the target folder
-	 * @param string $fileName the name of the file itself
-	 * @return void
-	 * @throws InvalidPathException
-	 */
-	public function verifyPath($path, $fileName) {
-		$this->getWrapperStorage()->verifyPath($path, $fileName);
-	}
-
-	/**
-	 * @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, $targetInternalPath);
-		}
-
-		return $this->getWrapperStorage()->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		if ($sourceStorage === $this) {
-			return $this->rename($sourceInternalPath, $targetInternalPath);
-		}
-
-		return $this->getWrapperStorage()->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-	}
-
-	/**
-	 * @param string $path
-	 * @return array
-	 */
-	public function getMetaData($path) {
-		return $this->getWrapperStorage()->getMetaData($path);
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function acquireLock($path, $type, ILockingProvider $provider) {
-		if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-			$this->getWrapperStorage()->acquireLock($path, $type, $provider);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 */
-	public function releaseLock($path, $type, ILockingProvider $provider) {
-		if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-			$this->getWrapperStorage()->releaseLock($path, $type, $provider);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 */
-	public function changeLock($path, $type, ILockingProvider $provider) {
-		if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-			$this->getWrapperStorage()->changeLock($path, $type, $provider);
-		}
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function needsPartFile() {
-		return $this->getWrapperStorage()->needsPartFile();
-	}
-
-	public function writeStream(string $path, $stream, int $size = null): int {
-		$storage = $this->getWrapperStorage();
-		if ($storage->instanceOfStorage(IWriteStreamStorage::class)) {
-			/** @var IWriteStreamStorage $storage */
-			return $storage->writeStream($path, $stream, $size);
-		} else {
-			$target = $this->fopen($path, 'w');
-			list($count, $result) = \OC_Helper::streamCopy($stream, $target);
-			fclose($stream);
-			fclose($target);
-			return $count;
-		}
-	}
-
-	public function getDirectoryContent($directory): \Traversable {
-		return $this->getWrapperStorage()->getDirectoryContent($directory);
-	}
+    /**
+     * @var \OC\Files\Storage\Storage $storage
+     */
+    protected $storage;
+
+    public $cache;
+    public $scanner;
+    public $watcher;
+    public $propagator;
+    public $updater;
+
+    /**
+     * @param array $parameters
+     */
+    public function __construct($parameters) {
+        $this->storage = $parameters['storage'];
+    }
+
+    /**
+     * @return \OC\Files\Storage\Storage
+     */
+    public function getWrapperStorage() {
+        return $this->storage;
+    }
+
+    /**
+     * Get the identifier for the storage,
+     * the returned id should be the same for every storage object that is created with the same parameters
+     * and two storage objects with the same id should refer to two storages that display the same files.
+     *
+     * @return string
+     */
+    public function getId() {
+        return $this->getWrapperStorage()->getId();
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.mkdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function mkdir($path) {
+        return $this->getWrapperStorage()->mkdir($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function rmdir($path) {
+        return $this->getWrapperStorage()->rmdir($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource
+     */
+    public function opendir($path) {
+        return $this->getWrapperStorage()->opendir($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.is_dir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function is_dir($path) {
+        return $this->getWrapperStorage()->is_dir($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.is_file.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function is_file($path) {
+        return $this->getWrapperStorage()->is_file($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
+     */
+    public function stat($path) {
+        return $this->getWrapperStorage()->stat($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function filetype($path) {
+        return $this->getWrapperStorage()->filetype($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
+     */
+    public function filesize($path) {
+        return $this->getWrapperStorage()->filesize($path);
+    }
+
+    /**
+     * check if a file can be created in $path
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isCreatable($path) {
+        return $this->getWrapperStorage()->isCreatable($path);
+    }
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isReadable($path) {
+        return $this->getWrapperStorage()->isReadable($path);
+    }
+
+    /**
+     * check if a file can be written to
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isUpdatable($path) {
+        return $this->getWrapperStorage()->isUpdatable($path);
+    }
+
+    /**
+     * check if a file can be deleted
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isDeletable($path) {
+        return $this->getWrapperStorage()->isDeletable($path);
+    }
+
+    /**
+     * check if a file can be shared
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isSharable($path) {
+        return $this->getWrapperStorage()->isSharable($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->getWrapperStorage()->getPermissions($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function file_exists($path) {
+        return $this->getWrapperStorage()->file_exists($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function filemtime($path) {
+        return $this->getWrapperStorage()->filemtime($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string
+     */
+    public function file_get_contents($path) {
+        return $this->getWrapperStorage()->file_get_contents($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->getWrapperStorage()->file_put_contents($path, $data);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function unlink($path) {
+        return $this->getWrapperStorage()->unlink($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function rename($path1, $path2) {
+        return $this->getWrapperStorage()->rename($path1, $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->getWrapperStorage()->copy($path1, $path2);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource
+     */
+    public function fopen($path, $mode) {
+        return $this->getWrapperStorage()->fopen($path, $mode);
+    }
+
+    /**
+     * 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
+     */
+    public function getMimeType($path) {
+        return $this->getWrapperStorage()->getMimeType($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.hash.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string
+     */
+    public function hash($type, $path, $raw = false) {
+        return $this->getWrapperStorage()->hash($type, $path, $raw);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function free_space($path) {
+        return $this->getWrapperStorage()->free_space($path);
+    }
+
+    /**
+     * search for occurrences of $query in file names
+     *
+     * @param string $query
+     * @return array
+     */
+    public function search($query) {
+        return $this->getWrapperStorage()->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->getWrapperStorage()->touch($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
+     */
+    public function getLocalFile($path) {
+        return $this->getWrapperStorage()->getLocalFile($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->getWrapperStorage()->hasUpdated($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->getWrapperStorage()->getCache($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->getWrapperStorage()->getScanner($path, $storage);
+    }
+
+
+    /**
+     * get the user id of the owner of a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getOwner($path) {
+        return $this->getWrapperStorage()->getOwner($path);
+    }
+
+    /**
+     * get a watcher instance for the cache
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
+     * @return \OC\Files\Cache\Watcher
+     */
+    public function getWatcher($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->getWrapperStorage()->getWatcher($path, $storage);
+    }
+
+    public function getPropagator($storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->getWrapperStorage()->getPropagator($storage);
+    }
+
+    public function getUpdater($storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->getWrapperStorage()->getUpdater($storage);
+    }
+
+    /**
+     * @return \OC\Files\Cache\Storage
+     */
+    public function getStorageCache() {
+        return $this->getWrapperStorage()->getStorageCache();
+    }
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getETag($path) {
+        return $this->getWrapperStorage()->getETag($path);
+    }
+
+    /**
+     * Returns true
+     *
+     * @return true
+     */
+    public function test() {
+        return $this->getWrapperStorage()->test();
+    }
+
+    /**
+     * Returns the wrapped storage's value for isLocal()
+     *
+     * @return bool wrapped storage's isLocal() value
+     */
+    public function isLocal() {
+        return $this->getWrapperStorage()->isLocal();
+    }
+
+    /**
+     * Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
+     *
+     * @param string $class
+     * @return bool
+     */
+    public function instanceOfStorage($class) {
+        if (ltrim($class, '\\') === 'OC\Files\Storage\Shared') {
+            // FIXME Temporary fix to keep existing checks working
+            $class = '\OCA\Files_Sharing\SharedStorage';
+        }
+        return is_a($this, $class) or $this->getWrapperStorage()->instanceOfStorage($class);
+    }
+
+    /**
+     * Pass any methods custom to specific storage implementations to the wrapped storage
+     *
+     * @param string $method
+     * @param array $args
+     * @return mixed
+     */
+    public function __call($method, $args) {
+        return call_user_func_array([$this->getWrapperStorage(), $method], $args);
+    }
+
+    /**
+     * A custom storage implementation can return an url for direct download of a give file.
+     *
+     * For now the returned array can hold the parameter url - in future more attributes might follow.
+     *
+     * @param string $path
+     * @return array
+     */
+    public function getDirectDownload($path) {
+        return $this->getWrapperStorage()->getDirectDownload($path);
+    }
+
+    /**
+     * Get availability of the storage
+     *
+     * @return array [ available, last_checked ]
+     */
+    public function getAvailability() {
+        return $this->getWrapperStorage()->getAvailability();
+    }
+
+    /**
+     * Set availability of the storage
+     *
+     * @param bool $isAvailable
+     */
+    public function setAvailability($isAvailable) {
+        $this->getWrapperStorage()->setAvailability($isAvailable);
+    }
+
+    /**
+     * @param string $path the path of the target folder
+     * @param string $fileName the name of the file itself
+     * @return void
+     * @throws InvalidPathException
+     */
+    public function verifyPath($path, $fileName) {
+        $this->getWrapperStorage()->verifyPath($path, $fileName);
+    }
+
+    /**
+     * @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, $targetInternalPath);
+        }
+
+        return $this->getWrapperStorage()->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        if ($sourceStorage === $this) {
+            return $this->rename($sourceInternalPath, $targetInternalPath);
+        }
+
+        return $this->getWrapperStorage()->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+    }
+
+    /**
+     * @param string $path
+     * @return array
+     */
+    public function getMetaData($path) {
+        return $this->getWrapperStorage()->getMetaData($path);
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function acquireLock($path, $type, ILockingProvider $provider) {
+        if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+            $this->getWrapperStorage()->acquireLock($path, $type, $provider);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     */
+    public function releaseLock($path, $type, ILockingProvider $provider) {
+        if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+            $this->getWrapperStorage()->releaseLock($path, $type, $provider);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     */
+    public function changeLock($path, $type, ILockingProvider $provider) {
+        if ($this->getWrapperStorage()->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+            $this->getWrapperStorage()->changeLock($path, $type, $provider);
+        }
+    }
+
+    /**
+     * @return bool
+     */
+    public function needsPartFile() {
+        return $this->getWrapperStorage()->needsPartFile();
+    }
+
+    public function writeStream(string $path, $stream, int $size = null): int {
+        $storage = $this->getWrapperStorage();
+        if ($storage->instanceOfStorage(IWriteStreamStorage::class)) {
+            /** @var IWriteStreamStorage $storage */
+            return $storage->writeStream($path, $stream, $size);
+        } else {
+            $target = $this->fopen($path, 'w');
+            list($count, $result) = \OC_Helper::streamCopy($stream, $target);
+            fclose($stream);
+            fclose($target);
+            return $count;
+        }
+    }
+
+    public function getDirectoryContent($directory): \Traversable {
+        return $this->getWrapperStorage()->getDirectoryContent($directory);
+    }
 }

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

Indentation +988 added lines, -988 removed lines

@@ -51,992 +51,992 @@
 use OCP\ILogger;
 
 class Encryption extends Wrapper {
-	use LocalTempFileTrait;
-
-	/** @var string */
-	private $mountPoint;
-
-	/** @var \OC\Encryption\Util */
-	private $util;
-
-	/** @var \OCP\Encryption\IManager */
-	private $encryptionManager;
-
-	/** @var \OCP\ILogger */
-	private $logger;
-
-	/** @var string */
-	private $uid;
-
-	/** @var array */
-	protected $unencryptedSize;
-
-	/** @var \OCP\Encryption\IFile */
-	private $fileHelper;
-
-	/** @var IMountPoint */
-	private $mount;
-
-	/** @var IStorage */
-	private $keyStorage;
-
-	/** @var Update */
-	private $update;
-
-	/** @var Manager */
-	private $mountManager;
-
-	/** @var array remember for which path we execute the repair step to avoid recursions */
-	private $fixUnencryptedSizeOf = [];
-
-	/** @var  ArrayCache */
-	private $arrayCache;
-
-	/**
-	 * @param array $parameters
-	 * @param IManager $encryptionManager
-	 * @param Util $util
-	 * @param ILogger $logger
-	 * @param IFile $fileHelper
-	 * @param string $uid
-	 * @param IStorage $keyStorage
-	 * @param Update $update
-	 * @param Manager $mountManager
-	 * @param ArrayCache $arrayCache
-	 */
-	public function __construct(
-		$parameters,
-		IManager $encryptionManager = null,
-		Util $util = null,
-		ILogger $logger = null,
-		IFile $fileHelper = null,
-		$uid = null,
-		IStorage $keyStorage = null,
-		Update $update = null,
-		Manager $mountManager = null,
-		ArrayCache $arrayCache = null
-	) {
-		$this->mountPoint = $parameters['mountPoint'];
-		$this->mount = $parameters['mount'];
-		$this->encryptionManager = $encryptionManager;
-		$this->util = $util;
-		$this->logger = $logger;
-		$this->uid = $uid;
-		$this->fileHelper = $fileHelper;
-		$this->keyStorage = $keyStorage;
-		$this->unencryptedSize = [];
-		$this->update = $update;
-		$this->mountManager = $mountManager;
-		$this->arrayCache = $arrayCache;
-		parent::__construct($parameters);
-	}
-
-	/**
-	 * 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
-	 */
-	public function filesize($path) {
-		$fullPath = $this->getFullPath($path);
-
-		/** @var CacheEntry $info */
-		$info = $this->getCache()->get($path);
-		if (isset($this->unencryptedSize[$fullPath])) {
-			$size = $this->unencryptedSize[$fullPath];
-			// update file cache
-			if ($info instanceof ICacheEntry) {
-				$info = $info->getData();
-				$info['encrypted'] = $info['encryptedVersion'];
-			} else {
-				if (!is_array($info)) {
-					$info = [];
-				}
-				$info['encrypted'] = true;
-			}
-
-			$info['size'] = $size;
-			$this->getCache()->put($path, $info);
-
-			return $size;
-		}
-
-		if (isset($info['fileid']) && $info['encrypted']) {
-			return $this->verifyUnencryptedSize($path, $info['size']);
-		}
-
-		return $this->storage->filesize($path);
-	}
-
-	private function modifyMetaData(string $path, array $data): array {
-		$fullPath = $this->getFullPath($path);
-		$info = $this->getCache()->get($path);
-
-		if (isset($this->unencryptedSize[$fullPath])) {
-			$data['encrypted'] = true;
-			$data['size'] = $this->unencryptedSize[$fullPath];
-		} else {
-			if (isset($info['fileid']) && $info['encrypted']) {
-				$data['size'] = $this->verifyUnencryptedSize($path, $info['size']);
-				$data['encrypted'] = true;
-			}
-		}
-
-		if (isset($info['encryptedVersion']) && $info['encryptedVersion'] > 1) {
-			$data['encryptedVersion'] = $info['encryptedVersion'];
-		}
-
-		return $data;
-	}
-
-	/**
-	 * @param string $path
-	 * @return array
-	 */
-	public function getMetaData($path) {
-		$data = $this->storage->getMetaData($path);
-		if (is_null($data)) {
-			return null;
-		}
-		return $this->modifyMetaData($path, $data);
-	}
-
-	public function getDirectoryContent($directory): \Traversable {
-		$parent = rtrim($directory, '/');
-		foreach ($this->getWrapperStorage()->getDirectoryContent($directory) as $data) {
-			yield $this->modifyMetaData($parent . '/' . $data['name'], $data);
-		}
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function file_get_contents($path) {
-		$encryptionModule = $this->getEncryptionModule($path);
-
-		if ($encryptionModule) {
-			$handle = $this->fopen($path, "r");
-			if (!$handle) {
-				return false;
-			}
-			$data = stream_get_contents($handle);
-			fclose($handle);
-			return $data;
-		}
-		return $this->storage->file_get_contents($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) {
-		// file put content will always be translated to a stream write
-		$handle = $this->fopen($path, 'w');
-		if (is_resource($handle)) {
-			$written = fwrite($handle, $data);
-			fclose($handle);
-			return $written;
-		}
-
-		return false;
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function unlink($path) {
-		$fullPath = $this->getFullPath($path);
-		if ($this->util->isExcluded($fullPath)) {
-			return $this->storage->unlink($path);
-		}
-
-		$encryptionModule = $this->getEncryptionModule($path);
-		if ($encryptionModule) {
-			$this->keyStorage->deleteAllFileKeys($fullPath);
-		}
-
-		return $this->storage->unlink($path);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function rename($path1, $path2) {
-		$result = $this->storage->rename($path1, $path2);
-
-		if ($result &&
-			// versions always use the keys from the original file, so we can skip
-			// this step for versions
-			$this->isVersion($path2) === false &&
-			$this->encryptionManager->isEnabled()) {
-			$source = $this->getFullPath($path1);
-			if (!$this->util->isExcluded($source)) {
-				$target = $this->getFullPath($path2);
-				if (isset($this->unencryptedSize[$source])) {
-					$this->unencryptedSize[$target] = $this->unencryptedSize[$source];
-				}
-				$this->keyStorage->renameKeys($source, $target);
-				$module = $this->getEncryptionModule($path2);
-				if ($module) {
-					$module->update($target, $this->uid, []);
-				}
-			}
-		}
-
-		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($path);
-		$fullPath = $this->getFullPath($path);
-		if ($result &&
-			$this->util->isExcluded($fullPath) === false &&
-			$this->encryptionManager->isEnabled()
-		) {
-			$this->keyStorage->deleteAllFileKeys($fullPath);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isReadable($path) {
-		$isReadable = true;
-
-		$metaData = $this->getMetaData($path);
-		if (
-			!$this->is_dir($path) &&
-			isset($metaData['encrypted']) &&
-			$metaData['encrypted'] === true
-		) {
-			$fullPath = $this->getFullPath($path);
-			$module = $this->getEncryptionModule($path);
-			$isReadable = $module->isReadable($fullPath, $this->uid);
-		}
-
-		return $this->storage->isReadable($path) && $isReadable;
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.copy.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function copy($path1, $path2) {
-		$source = $this->getFullPath($path1);
-
-		if ($this->util->isExcluded($source)) {
-			return $this->storage->copy($path1, $path2);
-		}
-
-		// need to stream copy file by file in case we copy between a encrypted
-		// and a unencrypted storage
-		$this->unlink($path2);
-		return $this->copyFromStorage($this, $path1, $path2);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|bool
-	 * @throws GenericEncryptionException
-	 * @throws ModuleDoesNotExistsException
-	 */
-	public function fopen($path, $mode) {
-
-		// check if the file is stored in the array cache, this means that we
-		// copy a file over to the versions folder, in this case we don't want to
-		// decrypt it
-		if ($this->arrayCache->hasKey('encryption_copy_version_' . $path)) {
-			$this->arrayCache->remove('encryption_copy_version_' . $path);
-			return $this->storage->fopen($path, $mode);
-		}
-
-		$encryptionEnabled = $this->encryptionManager->isEnabled();
-		$shouldEncrypt = false;
-		$encryptionModule = null;
-		$header = $this->getHeader($path);
-		$signed = isset($header['signed']) && $header['signed'] === 'true';
-		$fullPath = $this->getFullPath($path);
-		$encryptionModuleId = $this->util->getEncryptionModuleId($header);
-
-		if ($this->util->isExcluded($fullPath) === false) {
-			$size = $unencryptedSize = 0;
-			$realFile = $this->util->stripPartialFileExtension($path);
-			$targetExists = $this->file_exists($realFile) || $this->file_exists($path);
-			$targetIsEncrypted = false;
-			if ($targetExists) {
-				// in case the file exists we require the explicit module as
-				// specified in the file header - otherwise we need to fail hard to
-				// prevent data loss on client side
-				if (!empty($encryptionModuleId)) {
-					$targetIsEncrypted = true;
-					$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
-				}
-
-				if ($this->file_exists($path)) {
-					$size = $this->storage->filesize($path);
-					$unencryptedSize = $this->filesize($path);
-				} else {
-					$size = $unencryptedSize = 0;
-				}
-			}
-
-			try {
-				if (
-					$mode === 'w'
-					|| $mode === 'w+'
-					|| $mode === 'wb'
-					|| $mode === 'wb+'
-				) {
-					// if we update a encrypted file with a un-encrypted one we change the db flag
-					if ($targetIsEncrypted && $encryptionEnabled === false) {
-						$cache = $this->storage->getCache();
-						if ($cache) {
-							$entry = $cache->get($path);
-							$cache->update($entry->getId(), ['encrypted' => 0]);
-						}
-					}
-					if ($encryptionEnabled) {
-						// if $encryptionModuleId is empty, the default module will be used
-						$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
-						$shouldEncrypt = $encryptionModule->shouldEncrypt($fullPath);
-						$signed = true;
-					}
-				} else {
-					$info = $this->getCache()->get($path);
-					// only get encryption module if we found one in the header
-					// or if file should be encrypted according to the file cache
-					if (!empty($encryptionModuleId)) {
-						$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
-						$shouldEncrypt = true;
-					} elseif (empty($encryptionModuleId) && $info['encrypted'] === true) {
-						// we come from a old installation. No header and/or no module defined
-						// but the file is encrypted. In this case we need to use the
-						// OC_DEFAULT_MODULE to read the file
-						$encryptionModule = $this->encryptionManager->getEncryptionModule('OC_DEFAULT_MODULE');
-						$shouldEncrypt = true;
-						$targetIsEncrypted = true;
-					}
-				}
-			} catch (ModuleDoesNotExistsException $e) {
-				$this->logger->logException($e, [
-					'message' => 'Encryption module "' . $encryptionModuleId . '" not found, file will be stored unencrypted',
-					'level' => ILogger::WARN,
-					'app' => 'core',
-				]);
-			}
-
-			// encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt
-			if (!$encryptionEnabled || !$this->shouldEncrypt($path)) {
-				if (!$targetExists || !$targetIsEncrypted) {
-					$shouldEncrypt = false;
-				}
-			}
-
-			if ($shouldEncrypt === true && $encryptionModule !== null) {
-				$headerSize = $this->getHeaderSize($path);
-				$source = $this->storage->fopen($path, $mode);
-				if (!is_resource($source)) {
-					return false;
-				}
-				$handle = \OC\Files\Stream\Encryption::wrap($source, $path, $fullPath, $header,
-					$this->uid, $encryptionModule, $this->storage, $this, $this->util, $this->fileHelper, $mode,
-					$size, $unencryptedSize, $headerSize, $signed);
-				return $handle;
-			}
-		}
-
-		return $this->storage->fopen($path, $mode);
-	}
-
-
-	/**
-	 * perform some plausibility checks if the the unencrypted size is correct.
-	 * If not, we calculate the correct unencrypted size and return it
-	 *
-	 * @param string $path internal path relative to the storage root
-	 * @param int $unencryptedSize size of the unencrypted file
-	 *
-	 * @return int unencrypted size
-	 */
-	protected function verifyUnencryptedSize($path, $unencryptedSize) {
-		$size = $this->storage->filesize($path);
-		$result = $unencryptedSize;
-
-		if ($unencryptedSize < 0 ||
-			($size > 0 && $unencryptedSize === $size)
-		) {
-			// check if we already calculate the unencrypted size for the
-			// given path to avoid recursions
-			if (isset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]) === false) {
-				$this->fixUnencryptedSizeOf[$this->getFullPath($path)] = true;
-				try {
-					$result = $this->fixUnencryptedSize($path, $size, $unencryptedSize);
-				} catch (\Exception $e) {
-					$this->logger->error('Couldn\'t re-calculate unencrypted size for ' . $path);
-					$this->logger->logException($e);
-				}
-				unset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]);
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * calculate the unencrypted size
-	 *
-	 * @param string $path internal path relative to the storage root
-	 * @param int $size size of the physical file
-	 * @param int $unencryptedSize size of the unencrypted file
-	 *
-	 * @return int calculated unencrypted size
-	 */
-	protected function fixUnencryptedSize($path, $size, $unencryptedSize) {
-		$headerSize = $this->getHeaderSize($path);
-		$header = $this->getHeader($path);
-		$encryptionModule = $this->getEncryptionModule($path);
-
-		$stream = $this->storage->fopen($path, 'r');
-
-		// if we couldn't open the file we return the old unencrypted size
-		if (!is_resource($stream)) {
-			$this->logger->error('Could not open ' . $path . '. Recalculation of unencrypted size aborted.');
-			return $unencryptedSize;
-		}
-
-		$newUnencryptedSize = 0;
-		$size -= $headerSize;
-		$blockSize = $this->util->getBlockSize();
-
-		// if a header exists we skip it
-		if ($headerSize > 0) {
-			fread($stream, $headerSize);
-		}
-
-		// fast path, else the calculation for $lastChunkNr is bogus
-		if ($size === 0) {
-			return 0;
-		}
-
-		$signed = isset($header['signed']) && $header['signed'] === 'true';
-		$unencryptedBlockSize = $encryptionModule->getUnencryptedBlockSize($signed);
-
-		// calculate last chunk nr
-		// next highest is end of chunks, one subtracted is last one
-		// we have to read the last chunk, we can't just calculate it (because of padding etc)
-
-		$lastChunkNr = ceil($size / $blockSize) - 1;
-		// calculate last chunk position
-		$lastChunkPos = ($lastChunkNr * $blockSize);
-		// try to fseek to the last chunk, if it fails we have to read the whole file
-		if (@fseek($stream, $lastChunkPos, SEEK_CUR) === 0) {
-			$newUnencryptedSize += $lastChunkNr * $unencryptedBlockSize;
-		}
-
-		$lastChunkContentEncrypted = '';
-		$count = $blockSize;
-
-		while ($count > 0) {
-			$data = fread($stream, $blockSize);
-			$count = strlen($data);
-			$lastChunkContentEncrypted .= $data;
-			if (strlen($lastChunkContentEncrypted) > $blockSize) {
-				$newUnencryptedSize += $unencryptedBlockSize;
-				$lastChunkContentEncrypted = substr($lastChunkContentEncrypted, $blockSize);
-			}
-		}
-
-		fclose($stream);
-
-		// we have to decrypt the last chunk to get it actual size
-		$encryptionModule->begin($this->getFullPath($path), $this->uid, 'r', $header, []);
-		$decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr . 'end');
-		$decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr . 'end');
-
-		// calc the real file size with the size of the last chunk
-		$newUnencryptedSize += strlen($decryptedLastChunk);
-
-		$this->updateUnencryptedSize($this->getFullPath($path), $newUnencryptedSize);
-
-		// write to cache if applicable
-		$cache = $this->storage->getCache();
-		if ($cache) {
-			$entry = $cache->get($path);
-			$cache->update($entry['fileid'], ['size' => $newUnencryptedSize]);
-		}
-
-		return $newUnencryptedSize;
-	}
-
-	/**
-	 * @param Storage\IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $preserveMtime
-	 * @return bool
-	 */
-	public function moveFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = true) {
-		if ($sourceStorage === $this) {
-			return $this->rename($sourceInternalPath, $targetInternalPath);
-		}
-
-		// TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed:
-		// - call $this->storage->moveFromStorage() instead of $this->copyBetweenStorage
-		// - copy the file cache update from  $this->copyBetweenStorage to this method
-		// - copy the copyKeys() call from  $this->copyBetweenStorage to this method
-		// - remove $this->copyBetweenStorage
-
-		if (!$sourceStorage->isDeletable($sourceInternalPath)) {
-			return false;
-		}
-
-		$result = $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, true);
-		if ($result) {
-			if ($sourceStorage->is_dir($sourceInternalPath)) {
-				$result &= $sourceStorage->rmdir($sourceInternalPath);
-			} else {
-				$result &= $sourceStorage->unlink($sourceInternalPath);
-			}
-		}
-		return $result;
-	}
-
-
-	/**
-	 * @param Storage\IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $preserveMtime
-	 * @param bool $isRename
-	 * @return bool
-	 */
-	public function copyFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false, $isRename = false) {
-
-		// TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed:
-		// - call $this->storage->copyFromStorage() instead of $this->copyBetweenStorage
-		// - copy the file cache update from  $this->copyBetweenStorage to this method
-		// - copy the copyKeys() call from  $this->copyBetweenStorage to this method
-		// - remove $this->copyBetweenStorage
-
-		return $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename);
-	}
-
-	/**
-	 * Update the encrypted cache version in the database
-	 *
-	 * @param Storage\IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $isRename
-	 * @param bool $keepEncryptionVersion
-	 */
-	private function updateEncryptedVersion(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, $keepEncryptionVersion) {
-		$isEncrypted = $this->encryptionManager->isEnabled() && $this->shouldEncrypt($targetInternalPath);
-		$cacheInformation = [
-			'encrypted' => $isEncrypted,
-		];
-		if ($isEncrypted) {
-			$encryptedVersion = $sourceStorage->getCache()->get($sourceInternalPath)['encryptedVersion'];
-
-			// In case of a move operation from an unencrypted to an encrypted
-			// storage the old encrypted version would stay with "0" while the
-			// correct value would be "1". Thus we manually set the value to "1"
-			// for those cases.
-			// See also https://github.com/owncloud/core/issues/23078
-			if ($encryptedVersion === 0 || !$keepEncryptionVersion) {
-				$encryptedVersion = 1;
-			}
-
-			$cacheInformation['encryptedVersion'] = $encryptedVersion;
-		}
-
-		// in case of a rename we need to manipulate the source cache because
-		// this information will be kept for the new target
-		if ($isRename) {
-			$sourceStorage->getCache()->put($sourceInternalPath, $cacheInformation);
-		} else {
-			$this->getCache()->put($targetInternalPath, $cacheInformation);
-		}
-	}
-
-	/**
-	 * copy file between two storages
-	 *
-	 * @param Storage\IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $preserveMtime
-	 * @param bool $isRename
-	 * @return bool
-	 * @throws \Exception
-	 */
-	private function copyBetweenStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename) {
-
-		// for versions we have nothing to do, because versions should always use the
-		// key from the original file. Just create a 1:1 copy and done
-		if ($this->isVersion($targetInternalPath) ||
-			$this->isVersion($sourceInternalPath)) {
-			// remember that we try to create a version so that we can detect it during
-			// fopen($sourceInternalPath) and by-pass the encryption in order to
-			// create a 1:1 copy of the file
-			$this->arrayCache->set('encryption_copy_version_' . $sourceInternalPath, true);
-			$result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-			$this->arrayCache->remove('encryption_copy_version_' . $sourceInternalPath);
-			if ($result) {
-				$info = $this->getCache('', $sourceStorage)->get($sourceInternalPath);
-				// make sure that we update the unencrypted size for the version
-				if (isset($info['encrypted']) && $info['encrypted'] === true) {
-					$this->updateUnencryptedSize(
-						$this->getFullPath($targetInternalPath),
-						$info['size']
-					);
-				}
-				$this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, true);
-			}
-			return $result;
-		}
-
-		// first copy the keys that we reuse the existing file key on the target location
-		// and don't create a new one which would break versions for example.
-		$mount = $this->mountManager->findByStorageId($sourceStorage->getId());
-		if (count($mount) === 1) {
-			$mountPoint = $mount[0]->getMountPoint();
-			$source = $mountPoint . '/' . $sourceInternalPath;
-			$target = $this->getFullPath($targetInternalPath);
-			$this->copyKeys($source, $target);
-		} else {
-			$this->logger->error('Could not find mount point, can\'t keep encryption keys');
-		}
-
-		if ($sourceStorage->is_dir($sourceInternalPath)) {
-			$dh = $sourceStorage->opendir($sourceInternalPath);
-			$result = $this->mkdir($targetInternalPath);
-			if (is_resource($dh)) {
-				while ($result and ($file = readdir($dh)) !== false) {
-					if (!Filesystem::isIgnoredDir($file)) {
-						$result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename);
-					}
-				}
-			}
-		} else {
-			try {
-				$source = $sourceStorage->fopen($sourceInternalPath, 'r');
-				$target = $this->fopen($targetInternalPath, 'w');
-				[, $result] = \OC_Helper::streamCopy($source, $target);
-				fclose($source);
-				fclose($target);
-			} catch (\Exception $e) {
-				fclose($source);
-				fclose($target);
-				throw $e;
-			}
-			if ($result) {
-				if ($preserveMtime) {
-					$this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath));
-				}
-				$this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, false);
-			} else {
-				// delete partially written target file
-				$this->unlink($targetInternalPath);
-				// delete cache entry that was created by fopen
-				$this->getCache()->remove($targetInternalPath);
-			}
-		}
-		return (bool)$result;
-	}
-
-	/**
-	 * 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
-	 */
-	public function getLocalFile($path) {
-		if ($this->encryptionManager->isEnabled()) {
-			$cachedFile = $this->getCachedFile($path);
-			if (is_string($cachedFile)) {
-				return $cachedFile;
-			}
-		}
-		return $this->storage->getLocalFile($path);
-	}
-
-	/**
-	 * Returns the wrapped storage's value for isLocal()
-	 *
-	 * @return bool wrapped storage's isLocal() value
-	 */
-	public function isLocal() {
-		if ($this->encryptionManager->isEnabled()) {
-			return false;
-		}
-		return $this->storage->isLocal();
-	}
-
-	/**
-	 * 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
-	 */
-	public function stat($path) {
-		$stat = $this->storage->stat($path);
-		$fileSize = $this->filesize($path);
-		$stat['size'] = $fileSize;
-		$stat[7] = $fileSize;
-		$stat['hasHeader'] = $this->getHeaderSize($path) > 0;
-		return $stat;
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.hash.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string
-	 */
-	public function hash($type, $path, $raw = false) {
-		$fh = $this->fopen($path, 'rb');
-		$ctx = hash_init($type);
-		hash_update_stream($ctx, $fh);
-		fclose($fh);
-		return hash_final($ctx, $raw);
-	}
-
-	/**
-	 * return full path, including mount point
-	 *
-	 * @param string $path relative to mount point
-	 * @return string full path including mount point
-	 */
-	protected function getFullPath($path) {
-		return Filesystem::normalizePath($this->mountPoint . '/' . $path);
-	}
-
-	/**
-	 * read first block of encrypted file, typically this will contain the
-	 * encryption header
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	protected function readFirstBlock($path) {
-		$firstBlock = '';
-		if ($this->storage->file_exists($path)) {
-			$handle = $this->storage->fopen($path, 'r');
-			$firstBlock = fread($handle, $this->util->getHeaderSize());
-			fclose($handle);
-		}
-		return $firstBlock;
-	}
-
-	/**
-	 * return header size of given file
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	protected function getHeaderSize($path) {
-		$headerSize = 0;
-		$realFile = $this->util->stripPartialFileExtension($path);
-		if ($this->storage->file_exists($realFile)) {
-			$path = $realFile;
-		}
-		$firstBlock = $this->readFirstBlock($path);
-
-		if (substr($firstBlock, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) {
-			$headerSize = $this->util->getHeaderSize();
-		}
-
-		return $headerSize;
-	}
-
-	/**
-	 * parse raw header to array
-	 *
-	 * @param string $rawHeader
-	 * @return array
-	 */
-	protected function parseRawHeader($rawHeader) {
-		$result = [];
-		if (substr($rawHeader, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) {
-			$header = $rawHeader;
-			$endAt = strpos($header, Util::HEADER_END);
-			if ($endAt !== false) {
-				$header = substr($header, 0, $endAt + strlen(Util::HEADER_END));
-
-				// +1 to not start with an ':' which would result in empty element at the beginning
-				$exploded = explode(':', substr($header, strlen(Util::HEADER_START) + 1));
-
-				$element = array_shift($exploded);
-				while ($element !== Util::HEADER_END) {
-					$result[$element] = array_shift($exploded);
-					$element = array_shift($exploded);
-				}
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * read header from file
-	 *
-	 * @param string $path
-	 * @return array
-	 */
-	protected function getHeader($path) {
-		$realFile = $this->util->stripPartialFileExtension($path);
-		$exists = $this->storage->file_exists($realFile);
-		if ($exists) {
-			$path = $realFile;
-		}
-
-		$firstBlock = $this->readFirstBlock($path);
-		$result = $this->parseRawHeader($firstBlock);
-
-		// if the header doesn't contain a encryption module we check if it is a
-		// legacy file. If true, we add the default encryption module
-		if (!isset($result[Util::HEADER_ENCRYPTION_MODULE_KEY])) {
-			if (!empty($result)) {
-				$result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE';
-			} elseif ($exists) {
-				// if the header was empty we have to check first if it is a encrypted file at all
-				// We would do query to filecache only if we know that entry in filecache exists
-				$info = $this->getCache()->get($path);
-				if (isset($info['encrypted']) && $info['encrypted'] === true) {
-					$result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE';
-				}
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * read encryption module needed to read/write the file located at $path
-	 *
-	 * @param string $path
-	 * @return null|\OCP\Encryption\IEncryptionModule
-	 * @throws ModuleDoesNotExistsException
-	 * @throws \Exception
-	 */
-	protected function getEncryptionModule($path) {
-		$encryptionModule = null;
-		$header = $this->getHeader($path);
-		$encryptionModuleId = $this->util->getEncryptionModuleId($header);
-		if (!empty($encryptionModuleId)) {
-			try {
-				$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
-			} catch (ModuleDoesNotExistsException $e) {
-				$this->logger->critical('Encryption module defined in "' . $path . '" not loaded!');
-				throw $e;
-			}
-		}
-
-		return $encryptionModule;
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $unencryptedSize
-	 */
-	public function updateUnencryptedSize($path, $unencryptedSize) {
-		$this->unencryptedSize[$path] = $unencryptedSize;
-	}
-
-	/**
-	 * copy keys to new location
-	 *
-	 * @param string $source path relative to data/
-	 * @param string $target path relative to data/
-	 * @return bool
-	 */
-	protected function copyKeys($source, $target) {
-		if (!$this->util->isExcluded($source)) {
-			return $this->keyStorage->copyKeys($source, $target);
-		}
-
-		return false;
-	}
-
-	/**
-	 * check if path points to a files version
-	 *
-	 * @param $path
-	 * @return bool
-	 */
-	protected function isVersion($path) {
-		$normalized = Filesystem::normalizePath($path);
-		return substr($normalized, 0, strlen('/files_versions/')) === '/files_versions/';
-	}
-
-	/**
-	 * check if the given storage should be encrypted or not
-	 *
-	 * @param $path
-	 * @return bool
-	 */
-	protected function shouldEncrypt($path) {
-		$fullPath = $this->getFullPath($path);
-		$mountPointConfig = $this->mount->getOption('encrypt', true);
-		if ($mountPointConfig === false) {
-			return false;
-		}
-
-		try {
-			$encryptionModule = $this->getEncryptionModule($fullPath);
-		} catch (ModuleDoesNotExistsException $e) {
-			return false;
-		}
-
-		if ($encryptionModule === null) {
-			$encryptionModule = $this->encryptionManager->getEncryptionModule();
-		}
-
-		return $encryptionModule->shouldEncrypt($fullPath);
-	}
-
-	public function writeStream(string $path, $stream, int $size = null): int {
-		// always fall back to fopen
-		$target = $this->fopen($path, 'w');
-		[$count, $result] = \OC_Helper::streamCopy($stream, $target);
-		fclose($target);
-		return $count;
-	}
+    use LocalTempFileTrait;
+
+    /** @var string */
+    private $mountPoint;
+
+    /** @var \OC\Encryption\Util */
+    private $util;
+
+    /** @var \OCP\Encryption\IManager */
+    private $encryptionManager;
+
+    /** @var \OCP\ILogger */
+    private $logger;
+
+    /** @var string */
+    private $uid;
+
+    /** @var array */
+    protected $unencryptedSize;
+
+    /** @var \OCP\Encryption\IFile */
+    private $fileHelper;
+
+    /** @var IMountPoint */
+    private $mount;
+
+    /** @var IStorage */
+    private $keyStorage;
+
+    /** @var Update */
+    private $update;
+
+    /** @var Manager */
+    private $mountManager;
+
+    /** @var array remember for which path we execute the repair step to avoid recursions */
+    private $fixUnencryptedSizeOf = [];
+
+    /** @var  ArrayCache */
+    private $arrayCache;
+
+    /**
+     * @param array $parameters
+     * @param IManager $encryptionManager
+     * @param Util $util
+     * @param ILogger $logger
+     * @param IFile $fileHelper
+     * @param string $uid
+     * @param IStorage $keyStorage
+     * @param Update $update
+     * @param Manager $mountManager
+     * @param ArrayCache $arrayCache
+     */
+    public function __construct(
+        $parameters,
+        IManager $encryptionManager = null,
+        Util $util = null,
+        ILogger $logger = null,
+        IFile $fileHelper = null,
+        $uid = null,
+        IStorage $keyStorage = null,
+        Update $update = null,
+        Manager $mountManager = null,
+        ArrayCache $arrayCache = null
+    ) {
+        $this->mountPoint = $parameters['mountPoint'];
+        $this->mount = $parameters['mount'];
+        $this->encryptionManager = $encryptionManager;
+        $this->util = $util;
+        $this->logger = $logger;
+        $this->uid = $uid;
+        $this->fileHelper = $fileHelper;
+        $this->keyStorage = $keyStorage;
+        $this->unencryptedSize = [];
+        $this->update = $update;
+        $this->mountManager = $mountManager;
+        $this->arrayCache = $arrayCache;
+        parent::__construct($parameters);
+    }
+
+    /**
+     * 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
+     */
+    public function filesize($path) {
+        $fullPath = $this->getFullPath($path);
+
+        /** @var CacheEntry $info */
+        $info = $this->getCache()->get($path);
+        if (isset($this->unencryptedSize[$fullPath])) {
+            $size = $this->unencryptedSize[$fullPath];
+            // update file cache
+            if ($info instanceof ICacheEntry) {
+                $info = $info->getData();
+                $info['encrypted'] = $info['encryptedVersion'];
+            } else {
+                if (!is_array($info)) {
+                    $info = [];
+                }
+                $info['encrypted'] = true;
+            }
+
+            $info['size'] = $size;
+            $this->getCache()->put($path, $info);
+
+            return $size;
+        }
+
+        if (isset($info['fileid']) && $info['encrypted']) {
+            return $this->verifyUnencryptedSize($path, $info['size']);
+        }
+
+        return $this->storage->filesize($path);
+    }
+
+    private function modifyMetaData(string $path, array $data): array {
+        $fullPath = $this->getFullPath($path);
+        $info = $this->getCache()->get($path);
+
+        if (isset($this->unencryptedSize[$fullPath])) {
+            $data['encrypted'] = true;
+            $data['size'] = $this->unencryptedSize[$fullPath];
+        } else {
+            if (isset($info['fileid']) && $info['encrypted']) {
+                $data['size'] = $this->verifyUnencryptedSize($path, $info['size']);
+                $data['encrypted'] = true;
+            }
+        }
+
+        if (isset($info['encryptedVersion']) && $info['encryptedVersion'] > 1) {
+            $data['encryptedVersion'] = $info['encryptedVersion'];
+        }
+
+        return $data;
+    }
+
+    /**
+     * @param string $path
+     * @return array
+     */
+    public function getMetaData($path) {
+        $data = $this->storage->getMetaData($path);
+        if (is_null($data)) {
+            return null;
+        }
+        return $this->modifyMetaData($path, $data);
+    }
+
+    public function getDirectoryContent($directory): \Traversable {
+        $parent = rtrim($directory, '/');
+        foreach ($this->getWrapperStorage()->getDirectoryContent($directory) as $data) {
+            yield $this->modifyMetaData($parent . '/' . $data['name'], $data);
+        }
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string
+     */
+    public function file_get_contents($path) {
+        $encryptionModule = $this->getEncryptionModule($path);
+
+        if ($encryptionModule) {
+            $handle = $this->fopen($path, "r");
+            if (!$handle) {
+                return false;
+            }
+            $data = stream_get_contents($handle);
+            fclose($handle);
+            return $data;
+        }
+        return $this->storage->file_get_contents($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) {
+        // file put content will always be translated to a stream write
+        $handle = $this->fopen($path, 'w');
+        if (is_resource($handle)) {
+            $written = fwrite($handle, $data);
+            fclose($handle);
+            return $written;
+        }
+
+        return false;
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function unlink($path) {
+        $fullPath = $this->getFullPath($path);
+        if ($this->util->isExcluded($fullPath)) {
+            return $this->storage->unlink($path);
+        }
+
+        $encryptionModule = $this->getEncryptionModule($path);
+        if ($encryptionModule) {
+            $this->keyStorage->deleteAllFileKeys($fullPath);
+        }
+
+        return $this->storage->unlink($path);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function rename($path1, $path2) {
+        $result = $this->storage->rename($path1, $path2);
+
+        if ($result &&
+            // versions always use the keys from the original file, so we can skip
+            // this step for versions
+            $this->isVersion($path2) === false &&
+            $this->encryptionManager->isEnabled()) {
+            $source = $this->getFullPath($path1);
+            if (!$this->util->isExcluded($source)) {
+                $target = $this->getFullPath($path2);
+                if (isset($this->unencryptedSize[$source])) {
+                    $this->unencryptedSize[$target] = $this->unencryptedSize[$source];
+                }
+                $this->keyStorage->renameKeys($source, $target);
+                $module = $this->getEncryptionModule($path2);
+                if ($module) {
+                    $module->update($target, $this->uid, []);
+                }
+            }
+        }
+
+        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($path);
+        $fullPath = $this->getFullPath($path);
+        if ($result &&
+            $this->util->isExcluded($fullPath) === false &&
+            $this->encryptionManager->isEnabled()
+        ) {
+            $this->keyStorage->deleteAllFileKeys($fullPath);
+        }
+
+        return $result;
+    }
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isReadable($path) {
+        $isReadable = true;
+
+        $metaData = $this->getMetaData($path);
+        if (
+            !$this->is_dir($path) &&
+            isset($metaData['encrypted']) &&
+            $metaData['encrypted'] === true
+        ) {
+            $fullPath = $this->getFullPath($path);
+            $module = $this->getEncryptionModule($path);
+            $isReadable = $module->isReadable($fullPath, $this->uid);
+        }
+
+        return $this->storage->isReadable($path) && $isReadable;
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.copy.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function copy($path1, $path2) {
+        $source = $this->getFullPath($path1);
+
+        if ($this->util->isExcluded($source)) {
+            return $this->storage->copy($path1, $path2);
+        }
+
+        // need to stream copy file by file in case we copy between a encrypted
+        // and a unencrypted storage
+        $this->unlink($path2);
+        return $this->copyFromStorage($this, $path1, $path2);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource|bool
+     * @throws GenericEncryptionException
+     * @throws ModuleDoesNotExistsException
+     */
+    public function fopen($path, $mode) {
+
+        // check if the file is stored in the array cache, this means that we
+        // copy a file over to the versions folder, in this case we don't want to
+        // decrypt it
+        if ($this->arrayCache->hasKey('encryption_copy_version_' . $path)) {
+            $this->arrayCache->remove('encryption_copy_version_' . $path);
+            return $this->storage->fopen($path, $mode);
+        }
+
+        $encryptionEnabled = $this->encryptionManager->isEnabled();
+        $shouldEncrypt = false;
+        $encryptionModule = null;
+        $header = $this->getHeader($path);
+        $signed = isset($header['signed']) && $header['signed'] === 'true';
+        $fullPath = $this->getFullPath($path);
+        $encryptionModuleId = $this->util->getEncryptionModuleId($header);
+
+        if ($this->util->isExcluded($fullPath) === false) {
+            $size = $unencryptedSize = 0;
+            $realFile = $this->util->stripPartialFileExtension($path);
+            $targetExists = $this->file_exists($realFile) || $this->file_exists($path);
+            $targetIsEncrypted = false;
+            if ($targetExists) {
+                // in case the file exists we require the explicit module as
+                // specified in the file header - otherwise we need to fail hard to
+                // prevent data loss on client side
+                if (!empty($encryptionModuleId)) {
+                    $targetIsEncrypted = true;
+                    $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
+                }
+
+                if ($this->file_exists($path)) {
+                    $size = $this->storage->filesize($path);
+                    $unencryptedSize = $this->filesize($path);
+                } else {
+                    $size = $unencryptedSize = 0;
+                }
+            }
+
+            try {
+                if (
+                    $mode === 'w'
+                    || $mode === 'w+'
+                    || $mode === 'wb'
+                    || $mode === 'wb+'
+                ) {
+                    // if we update a encrypted file with a un-encrypted one we change the db flag
+                    if ($targetIsEncrypted && $encryptionEnabled === false) {
+                        $cache = $this->storage->getCache();
+                        if ($cache) {
+                            $entry = $cache->get($path);
+                            $cache->update($entry->getId(), ['encrypted' => 0]);
+                        }
+                    }
+                    if ($encryptionEnabled) {
+                        // if $encryptionModuleId is empty, the default module will be used
+                        $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
+                        $shouldEncrypt = $encryptionModule->shouldEncrypt($fullPath);
+                        $signed = true;
+                    }
+                } else {
+                    $info = $this->getCache()->get($path);
+                    // only get encryption module if we found one in the header
+                    // or if file should be encrypted according to the file cache
+                    if (!empty($encryptionModuleId)) {
+                        $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
+                        $shouldEncrypt = true;
+                    } elseif (empty($encryptionModuleId) && $info['encrypted'] === true) {
+                        // we come from a old installation. No header and/or no module defined
+                        // but the file is encrypted. In this case we need to use the
+                        // OC_DEFAULT_MODULE to read the file
+                        $encryptionModule = $this->encryptionManager->getEncryptionModule('OC_DEFAULT_MODULE');
+                        $shouldEncrypt = true;
+                        $targetIsEncrypted = true;
+                    }
+                }
+            } catch (ModuleDoesNotExistsException $e) {
+                $this->logger->logException($e, [
+                    'message' => 'Encryption module "' . $encryptionModuleId . '" not found, file will be stored unencrypted',
+                    'level' => ILogger::WARN,
+                    'app' => 'core',
+                ]);
+            }
+
+            // encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt
+            if (!$encryptionEnabled || !$this->shouldEncrypt($path)) {
+                if (!$targetExists || !$targetIsEncrypted) {
+                    $shouldEncrypt = false;
+                }
+            }
+
+            if ($shouldEncrypt === true && $encryptionModule !== null) {
+                $headerSize = $this->getHeaderSize($path);
+                $source = $this->storage->fopen($path, $mode);
+                if (!is_resource($source)) {
+                    return false;
+                }
+                $handle = \OC\Files\Stream\Encryption::wrap($source, $path, $fullPath, $header,
+                    $this->uid, $encryptionModule, $this->storage, $this, $this->util, $this->fileHelper, $mode,
+                    $size, $unencryptedSize, $headerSize, $signed);
+                return $handle;
+            }
+        }
+
+        return $this->storage->fopen($path, $mode);
+    }
+
+
+    /**
+     * perform some plausibility checks if the the unencrypted size is correct.
+     * If not, we calculate the correct unencrypted size and return it
+     *
+     * @param string $path internal path relative to the storage root
+     * @param int $unencryptedSize size of the unencrypted file
+     *
+     * @return int unencrypted size
+     */
+    protected function verifyUnencryptedSize($path, $unencryptedSize) {
+        $size = $this->storage->filesize($path);
+        $result = $unencryptedSize;
+
+        if ($unencryptedSize < 0 ||
+            ($size > 0 && $unencryptedSize === $size)
+        ) {
+            // check if we already calculate the unencrypted size for the
+            // given path to avoid recursions
+            if (isset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]) === false) {
+                $this->fixUnencryptedSizeOf[$this->getFullPath($path)] = true;
+                try {
+                    $result = $this->fixUnencryptedSize($path, $size, $unencryptedSize);
+                } catch (\Exception $e) {
+                    $this->logger->error('Couldn\'t re-calculate unencrypted size for ' . $path);
+                    $this->logger->logException($e);
+                }
+                unset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]);
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * calculate the unencrypted size
+     *
+     * @param string $path internal path relative to the storage root
+     * @param int $size size of the physical file
+     * @param int $unencryptedSize size of the unencrypted file
+     *
+     * @return int calculated unencrypted size
+     */
+    protected function fixUnencryptedSize($path, $size, $unencryptedSize) {
+        $headerSize = $this->getHeaderSize($path);
+        $header = $this->getHeader($path);
+        $encryptionModule = $this->getEncryptionModule($path);
+
+        $stream = $this->storage->fopen($path, 'r');
+
+        // if we couldn't open the file we return the old unencrypted size
+        if (!is_resource($stream)) {
+            $this->logger->error('Could not open ' . $path . '. Recalculation of unencrypted size aborted.');
+            return $unencryptedSize;
+        }
+
+        $newUnencryptedSize = 0;
+        $size -= $headerSize;
+        $blockSize = $this->util->getBlockSize();
+
+        // if a header exists we skip it
+        if ($headerSize > 0) {
+            fread($stream, $headerSize);
+        }
+
+        // fast path, else the calculation for $lastChunkNr is bogus
+        if ($size === 0) {
+            return 0;
+        }
+
+        $signed = isset($header['signed']) && $header['signed'] === 'true';
+        $unencryptedBlockSize = $encryptionModule->getUnencryptedBlockSize($signed);
+
+        // calculate last chunk nr
+        // next highest is end of chunks, one subtracted is last one
+        // we have to read the last chunk, we can't just calculate it (because of padding etc)
+
+        $lastChunkNr = ceil($size / $blockSize) - 1;
+        // calculate last chunk position
+        $lastChunkPos = ($lastChunkNr * $blockSize);
+        // try to fseek to the last chunk, if it fails we have to read the whole file
+        if (@fseek($stream, $lastChunkPos, SEEK_CUR) === 0) {
+            $newUnencryptedSize += $lastChunkNr * $unencryptedBlockSize;
+        }
+
+        $lastChunkContentEncrypted = '';
+        $count = $blockSize;
+
+        while ($count > 0) {
+            $data = fread($stream, $blockSize);
+            $count = strlen($data);
+            $lastChunkContentEncrypted .= $data;
+            if (strlen($lastChunkContentEncrypted) > $blockSize) {
+                $newUnencryptedSize += $unencryptedBlockSize;
+                $lastChunkContentEncrypted = substr($lastChunkContentEncrypted, $blockSize);
+            }
+        }
+
+        fclose($stream);
+
+        // we have to decrypt the last chunk to get it actual size
+        $encryptionModule->begin($this->getFullPath($path), $this->uid, 'r', $header, []);
+        $decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr . 'end');
+        $decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr . 'end');
+
+        // calc the real file size with the size of the last chunk
+        $newUnencryptedSize += strlen($decryptedLastChunk);
+
+        $this->updateUnencryptedSize($this->getFullPath($path), $newUnencryptedSize);
+
+        // write to cache if applicable
+        $cache = $this->storage->getCache();
+        if ($cache) {
+            $entry = $cache->get($path);
+            $cache->update($entry['fileid'], ['size' => $newUnencryptedSize]);
+        }
+
+        return $newUnencryptedSize;
+    }
+
+    /**
+     * @param Storage\IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $preserveMtime
+     * @return bool
+     */
+    public function moveFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = true) {
+        if ($sourceStorage === $this) {
+            return $this->rename($sourceInternalPath, $targetInternalPath);
+        }
+
+        // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed:
+        // - call $this->storage->moveFromStorage() instead of $this->copyBetweenStorage
+        // - copy the file cache update from  $this->copyBetweenStorage to this method
+        // - copy the copyKeys() call from  $this->copyBetweenStorage to this method
+        // - remove $this->copyBetweenStorage
+
+        if (!$sourceStorage->isDeletable($sourceInternalPath)) {
+            return false;
+        }
+
+        $result = $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, true);
+        if ($result) {
+            if ($sourceStorage->is_dir($sourceInternalPath)) {
+                $result &= $sourceStorage->rmdir($sourceInternalPath);
+            } else {
+                $result &= $sourceStorage->unlink($sourceInternalPath);
+            }
+        }
+        return $result;
+    }
+
+
+    /**
+     * @param Storage\IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $preserveMtime
+     * @param bool $isRename
+     * @return bool
+     */
+    public function copyFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false, $isRename = false) {
+
+        // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed:
+        // - call $this->storage->copyFromStorage() instead of $this->copyBetweenStorage
+        // - copy the file cache update from  $this->copyBetweenStorage to this method
+        // - copy the copyKeys() call from  $this->copyBetweenStorage to this method
+        // - remove $this->copyBetweenStorage
+
+        return $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename);
+    }
+
+    /**
+     * Update the encrypted cache version in the database
+     *
+     * @param Storage\IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $isRename
+     * @param bool $keepEncryptionVersion
+     */
+    private function updateEncryptedVersion(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, $keepEncryptionVersion) {
+        $isEncrypted = $this->encryptionManager->isEnabled() && $this->shouldEncrypt($targetInternalPath);
+        $cacheInformation = [
+            'encrypted' => $isEncrypted,
+        ];
+        if ($isEncrypted) {
+            $encryptedVersion = $sourceStorage->getCache()->get($sourceInternalPath)['encryptedVersion'];
+
+            // In case of a move operation from an unencrypted to an encrypted
+            // storage the old encrypted version would stay with "0" while the
+            // correct value would be "1". Thus we manually set the value to "1"
+            // for those cases.
+            // See also https://github.com/owncloud/core/issues/23078
+            if ($encryptedVersion === 0 || !$keepEncryptionVersion) {
+                $encryptedVersion = 1;
+            }
+
+            $cacheInformation['encryptedVersion'] = $encryptedVersion;
+        }
+
+        // in case of a rename we need to manipulate the source cache because
+        // this information will be kept for the new target
+        if ($isRename) {
+            $sourceStorage->getCache()->put($sourceInternalPath, $cacheInformation);
+        } else {
+            $this->getCache()->put($targetInternalPath, $cacheInformation);
+        }
+    }
+
+    /**
+     * copy file between two storages
+     *
+     * @param Storage\IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $preserveMtime
+     * @param bool $isRename
+     * @return bool
+     * @throws \Exception
+     */
+    private function copyBetweenStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename) {
+
+        // for versions we have nothing to do, because versions should always use the
+        // key from the original file. Just create a 1:1 copy and done
+        if ($this->isVersion($targetInternalPath) ||
+            $this->isVersion($sourceInternalPath)) {
+            // remember that we try to create a version so that we can detect it during
+            // fopen($sourceInternalPath) and by-pass the encryption in order to
+            // create a 1:1 copy of the file
+            $this->arrayCache->set('encryption_copy_version_' . $sourceInternalPath, true);
+            $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+            $this->arrayCache->remove('encryption_copy_version_' . $sourceInternalPath);
+            if ($result) {
+                $info = $this->getCache('', $sourceStorage)->get($sourceInternalPath);
+                // make sure that we update the unencrypted size for the version
+                if (isset($info['encrypted']) && $info['encrypted'] === true) {
+                    $this->updateUnencryptedSize(
+                        $this->getFullPath($targetInternalPath),
+                        $info['size']
+                    );
+                }
+                $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, true);
+            }
+            return $result;
+        }
+
+        // first copy the keys that we reuse the existing file key on the target location
+        // and don't create a new one which would break versions for example.
+        $mount = $this->mountManager->findByStorageId($sourceStorage->getId());
+        if (count($mount) === 1) {
+            $mountPoint = $mount[0]->getMountPoint();
+            $source = $mountPoint . '/' . $sourceInternalPath;
+            $target = $this->getFullPath($targetInternalPath);
+            $this->copyKeys($source, $target);
+        } else {
+            $this->logger->error('Could not find mount point, can\'t keep encryption keys');
+        }
+
+        if ($sourceStorage->is_dir($sourceInternalPath)) {
+            $dh = $sourceStorage->opendir($sourceInternalPath);
+            $result = $this->mkdir($targetInternalPath);
+            if (is_resource($dh)) {
+                while ($result and ($file = readdir($dh)) !== false) {
+                    if (!Filesystem::isIgnoredDir($file)) {
+                        $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename);
+                    }
+                }
+            }
+        } else {
+            try {
+                $source = $sourceStorage->fopen($sourceInternalPath, 'r');
+                $target = $this->fopen($targetInternalPath, 'w');
+                [, $result] = \OC_Helper::streamCopy($source, $target);
+                fclose($source);
+                fclose($target);
+            } catch (\Exception $e) {
+                fclose($source);
+                fclose($target);
+                throw $e;
+            }
+            if ($result) {
+                if ($preserveMtime) {
+                    $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath));
+                }
+                $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename, false);
+            } else {
+                // delete partially written target file
+                $this->unlink($targetInternalPath);
+                // delete cache entry that was created by fopen
+                $this->getCache()->remove($targetInternalPath);
+            }
+        }
+        return (bool)$result;
+    }
+
+    /**
+     * 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
+     */
+    public function getLocalFile($path) {
+        if ($this->encryptionManager->isEnabled()) {
+            $cachedFile = $this->getCachedFile($path);
+            if (is_string($cachedFile)) {
+                return $cachedFile;
+            }
+        }
+        return $this->storage->getLocalFile($path);
+    }
+
+    /**
+     * Returns the wrapped storage's value for isLocal()
+     *
+     * @return bool wrapped storage's isLocal() value
+     */
+    public function isLocal() {
+        if ($this->encryptionManager->isEnabled()) {
+            return false;
+        }
+        return $this->storage->isLocal();
+    }
+
+    /**
+     * 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
+     */
+    public function stat($path) {
+        $stat = $this->storage->stat($path);
+        $fileSize = $this->filesize($path);
+        $stat['size'] = $fileSize;
+        $stat[7] = $fileSize;
+        $stat['hasHeader'] = $this->getHeaderSize($path) > 0;
+        return $stat;
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.hash.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string
+     */
+    public function hash($type, $path, $raw = false) {
+        $fh = $this->fopen($path, 'rb');
+        $ctx = hash_init($type);
+        hash_update_stream($ctx, $fh);
+        fclose($fh);
+        return hash_final($ctx, $raw);
+    }
+
+    /**
+     * return full path, including mount point
+     *
+     * @param string $path relative to mount point
+     * @return string full path including mount point
+     */
+    protected function getFullPath($path) {
+        return Filesystem::normalizePath($this->mountPoint . '/' . $path);
+    }
+
+    /**
+     * read first block of encrypted file, typically this will contain the
+     * encryption header
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function readFirstBlock($path) {
+        $firstBlock = '';
+        if ($this->storage->file_exists($path)) {
+            $handle = $this->storage->fopen($path, 'r');
+            $firstBlock = fread($handle, $this->util->getHeaderSize());
+            fclose($handle);
+        }
+        return $firstBlock;
+    }
+
+    /**
+     * return header size of given file
+     *
+     * @param string $path
+     * @return int
+     */
+    protected function getHeaderSize($path) {
+        $headerSize = 0;
+        $realFile = $this->util->stripPartialFileExtension($path);
+        if ($this->storage->file_exists($realFile)) {
+            $path = $realFile;
+        }
+        $firstBlock = $this->readFirstBlock($path);
+
+        if (substr($firstBlock, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) {
+            $headerSize = $this->util->getHeaderSize();
+        }
+
+        return $headerSize;
+    }
+
+    /**
+     * parse raw header to array
+     *
+     * @param string $rawHeader
+     * @return array
+     */
+    protected function parseRawHeader($rawHeader) {
+        $result = [];
+        if (substr($rawHeader, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) {
+            $header = $rawHeader;
+            $endAt = strpos($header, Util::HEADER_END);
+            if ($endAt !== false) {
+                $header = substr($header, 0, $endAt + strlen(Util::HEADER_END));
+
+                // +1 to not start with an ':' which would result in empty element at the beginning
+                $exploded = explode(':', substr($header, strlen(Util::HEADER_START) + 1));
+
+                $element = array_shift($exploded);
+                while ($element !== Util::HEADER_END) {
+                    $result[$element] = array_shift($exploded);
+                    $element = array_shift($exploded);
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * read header from file
+     *
+     * @param string $path
+     * @return array
+     */
+    protected function getHeader($path) {
+        $realFile = $this->util->stripPartialFileExtension($path);
+        $exists = $this->storage->file_exists($realFile);
+        if ($exists) {
+            $path = $realFile;
+        }
+
+        $firstBlock = $this->readFirstBlock($path);
+        $result = $this->parseRawHeader($firstBlock);
+
+        // if the header doesn't contain a encryption module we check if it is a
+        // legacy file. If true, we add the default encryption module
+        if (!isset($result[Util::HEADER_ENCRYPTION_MODULE_KEY])) {
+            if (!empty($result)) {
+                $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE';
+            } elseif ($exists) {
+                // if the header was empty we have to check first if it is a encrypted file at all
+                // We would do query to filecache only if we know that entry in filecache exists
+                $info = $this->getCache()->get($path);
+                if (isset($info['encrypted']) && $info['encrypted'] === true) {
+                    $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE';
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * read encryption module needed to read/write the file located at $path
+     *
+     * @param string $path
+     * @return null|\OCP\Encryption\IEncryptionModule
+     * @throws ModuleDoesNotExistsException
+     * @throws \Exception
+     */
+    protected function getEncryptionModule($path) {
+        $encryptionModule = null;
+        $header = $this->getHeader($path);
+        $encryptionModuleId = $this->util->getEncryptionModuleId($header);
+        if (!empty($encryptionModuleId)) {
+            try {
+                $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
+            } catch (ModuleDoesNotExistsException $e) {
+                $this->logger->critical('Encryption module defined in "' . $path . '" not loaded!');
+                throw $e;
+            }
+        }
+
+        return $encryptionModule;
+    }
+
+    /**
+     * @param string $path
+     * @param int $unencryptedSize
+     */
+    public function updateUnencryptedSize($path, $unencryptedSize) {
+        $this->unencryptedSize[$path] = $unencryptedSize;
+    }
+
+    /**
+     * copy keys to new location
+     *
+     * @param string $source path relative to data/
+     * @param string $target path relative to data/
+     * @return bool
+     */
+    protected function copyKeys($source, $target) {
+        if (!$this->util->isExcluded($source)) {
+            return $this->keyStorage->copyKeys($source, $target);
+        }
+
+        return false;
+    }
+
+    /**
+     * check if path points to a files version
+     *
+     * @param $path
+     * @return bool
+     */
+    protected function isVersion($path) {
+        $normalized = Filesystem::normalizePath($path);
+        return substr($normalized, 0, strlen('/files_versions/')) === '/files_versions/';
+    }
+
+    /**
+     * check if the given storage should be encrypted or not
+     *
+     * @param $path
+     * @return bool
+     */
+    protected function shouldEncrypt($path) {
+        $fullPath = $this->getFullPath($path);
+        $mountPointConfig = $this->mount->getOption('encrypt', true);
+        if ($mountPointConfig === false) {
+            return false;
+        }
+
+        try {
+            $encryptionModule = $this->getEncryptionModule($fullPath);
+        } catch (ModuleDoesNotExistsException $e) {
+            return false;
+        }
+
+        if ($encryptionModule === null) {
+            $encryptionModule = $this->encryptionManager->getEncryptionModule();
+        }
+
+        return $encryptionModule->shouldEncrypt($fullPath);
+    }
+
+    public function writeStream(string $path, $stream, int $size = null): int {
+        // always fall back to fopen
+        $target = $this->fopen($path, 'w');
+        [$count, $result] = \OC_Helper::streamCopy($stream, $target);
+        fclose($target);
+        return $count;
+    }
 }

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

Indentation +500 added lines, -500 removed lines

@@ -39,504 +39,504 @@
  * This restricts access to a subfolder of the wrapped storage with the subfolder becoming the root folder new storage
  */
 class Jail extends Wrapper {
-	/**
-	 * @var string
-	 */
-	protected $rootPath;
-
-	/**
-	 * @param array $arguments ['storage' => $storage, 'mask' => $root]
-	 *
-	 * $storage: The storage that will be wrapper
-	 * $root: The folder in the wrapped storage that will become the root folder of the wrapped storage
-	 */
-	public function __construct($arguments) {
-		parent::__construct($arguments);
-		$this->rootPath = $arguments['root'];
-	}
-
-	public function getUnjailedPath($path) {
-		return trim(Filesystem::normalizePath($this->rootPath . '/' . $path), '/');
-	}
-
-	/**
-	 * This is separate from Wrapper::getWrapperStorage so we can get the jailed storage consistently even if the jail is inside another wrapper
-	 */
-	public function getUnjailedStorage() {
-		return $this->storage;
-	}
-
-
-	public function getJailedPath($path) {
-		$root = rtrim($this->rootPath, '/') . '/';
-
-		if ($path !== $this->rootPath && strpos($path, $root) !== 0) {
-			return null;
-		} else {
-			$path = substr($path, strlen($this->rootPath));
-			return trim($path, '/');
-		}
-	}
-
-	public function getId() {
-		return parent::getId();
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.mkdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function mkdir($path) {
-		return $this->getWrapperStorage()->mkdir($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function rmdir($path) {
-		return $this->getWrapperStorage()->rmdir($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource
-	 */
-	public function opendir($path) {
-		return $this->getWrapperStorage()->opendir($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.is_dir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function is_dir($path) {
-		return $this->getWrapperStorage()->is_dir($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.is_file.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function is_file($path) {
-		return $this->getWrapperStorage()->is_file($this->getUnjailedPath($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
-	 */
-	public function stat($path) {
-		return $this->getWrapperStorage()->stat($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function filetype($path) {
-		return $this->getWrapperStorage()->filetype($this->getUnjailedPath($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
-	 */
-	public function filesize($path) {
-		return $this->getWrapperStorage()->filesize($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * check if a file can be created in $path
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isCreatable($path) {
-		return $this->getWrapperStorage()->isCreatable($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * check if a file can be read
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isReadable($path) {
-		return $this->getWrapperStorage()->isReadable($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * check if a file can be written to
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isUpdatable($path) {
-		return $this->getWrapperStorage()->isUpdatable($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * check if a file can be deleted
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isDeletable($path) {
-		return $this->getWrapperStorage()->isDeletable($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * check if a file can be shared
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function isSharable($path) {
-		return $this->getWrapperStorage()->isSharable($this->getUnjailedPath($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->getWrapperStorage()->getPermissions($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function file_exists($path) {
-		return $this->getWrapperStorage()->file_exists($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.filemtime.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function filemtime($path) {
-		return $this->getWrapperStorage()->filemtime($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.file_get_contents.php
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function file_get_contents($path) {
-		return $this->getWrapperStorage()->file_get_contents($this->getUnjailedPath($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->getWrapperStorage()->file_put_contents($this->getUnjailedPath($path), $data);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public function unlink($path) {
-		return $this->getWrapperStorage()->unlink($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function rename($path1, $path2) {
-		return $this->getWrapperStorage()->rename($this->getUnjailedPath($path1), $this->getUnjailedPath($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->getWrapperStorage()->copy($this->getUnjailedPath($path1), $this->getUnjailedPath($path2));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource
-	 */
-	public function fopen($path, $mode) {
-		return $this->getWrapperStorage()->fopen($this->getUnjailedPath($path), $mode);
-	}
-
-	/**
-	 * 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
-	 */
-	public function getMimeType($path) {
-		return $this->getWrapperStorage()->getMimeType($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.hash.php
-	 *
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return string
-	 */
-	public function hash($type, $path, $raw = false) {
-		return $this->getWrapperStorage()->hash($type, $this->getUnjailedPath($path), $raw);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.free_space.php
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function free_space($path) {
-		return $this->getWrapperStorage()->free_space($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * search for occurrences of $query in file names
-	 *
-	 * @param string $query
-	 * @return array
-	 */
-	public function search($query) {
-		return $this->getWrapperStorage()->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->getWrapperStorage()->touch($this->getUnjailedPath($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
-	 */
-	public function getLocalFile($path) {
-		return $this->getWrapperStorage()->getLocalFile($this->getUnjailedPath($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->getWrapperStorage()->hasUpdated($this->getUnjailedPath($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->getWrapperStorage();
-		}
-		$sourceCache = $this->getWrapperStorage()->getCache($this->getUnjailedPath($path), $storage);
-		return new CacheJail($sourceCache, $this->rootPath);
-	}
-
-	/**
-	 * get the user id of the owner of a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getOwner($path) {
-		return $this->getWrapperStorage()->getOwner($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * get a watcher instance for the cache
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
-	 * @return \OC\Files\Cache\Watcher
-	 */
-	public function getWatcher($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->getWrapperStorage()->getWatcher($this->getUnjailedPath($path), $storage);
-	}
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getETag($path) {
-		return $this->getWrapperStorage()->getETag($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * @param string $path
-	 * @return array
-	 */
-	public function getMetaData($path) {
-		return $this->getWrapperStorage()->getMetaData($this->getUnjailedPath($path));
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function acquireLock($path, $type, ILockingProvider $provider) {
-		$this->getWrapperStorage()->acquireLock($this->getUnjailedPath($path), $type, $provider);
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 */
-	public function releaseLock($path, $type, ILockingProvider $provider) {
-		$this->getWrapperStorage()->releaseLock($this->getUnjailedPath($path), $type, $provider);
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 */
-	public function changeLock($path, $type, ILockingProvider $provider) {
-		$this->getWrapperStorage()->changeLock($this->getUnjailedPath($path), $type, $provider);
-	}
-
-	/**
-	 * Resolve the path for the source of the share
-	 *
-	 * @param string $path
-	 * @return array
-	 */
-	public function resolvePath($path) {
-		return [$this->getWrapperStorage(), $this->getUnjailedPath($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, $targetInternalPath);
-		}
-		return $this->getWrapperStorage()->copyFromStorage($sourceStorage, $sourceInternalPath, $this->getUnjailedPath($targetInternalPath));
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		if ($sourceStorage === $this) {
-			return $this->rename($sourceInternalPath, $targetInternalPath);
-		}
-		return $this->getWrapperStorage()->moveFromStorage($sourceStorage, $sourceInternalPath, $this->getUnjailedPath($targetInternalPath));
-	}
-
-	public function getPropagator($storage = null) {
-		if (isset($this->propagator)) {
-			return $this->propagator;
-		}
-
-		if (!$storage) {
-			$storage = $this;
-		}
-		$this->propagator = new JailPropagator($storage, \OC::$server->getDatabaseConnection());
-		return $this->propagator;
-	}
-
-	public function writeStream(string $path, $stream, int $size = null): int {
-		$storage = $this->getWrapperStorage();
-		if ($storage->instanceOfStorage(IWriteStreamStorage::class)) {
-			/** @var IWriteStreamStorage $storage */
-			return $storage->writeStream($this->getUnjailedPath($path), $stream, $size);
-		} else {
-			$target = $this->fopen($path, 'w');
-			list($count, $result) = \OC_Helper::streamCopy($stream, $target);
-			fclose($stream);
-			fclose($target);
-			return $count;
-		}
-	}
-
-	public function getDirectoryContent($directory): \Traversable {
-		return $this->getWrapperStorage()->getDirectoryContent($this->getUnjailedPath($directory));
-	}
+    /**
+     * @var string
+     */
+    protected $rootPath;
+
+    /**
+     * @param array $arguments ['storage' => $storage, 'mask' => $root]
+     *
+     * $storage: The storage that will be wrapper
+     * $root: The folder in the wrapped storage that will become the root folder of the wrapped storage
+     */
+    public function __construct($arguments) {
+        parent::__construct($arguments);
+        $this->rootPath = $arguments['root'];
+    }
+
+    public function getUnjailedPath($path) {
+        return trim(Filesystem::normalizePath($this->rootPath . '/' . $path), '/');
+    }
+
+    /**
+     * This is separate from Wrapper::getWrapperStorage so we can get the jailed storage consistently even if the jail is inside another wrapper
+     */
+    public function getUnjailedStorage() {
+        return $this->storage;
+    }
+
+
+    public function getJailedPath($path) {
+        $root = rtrim($this->rootPath, '/') . '/';
+
+        if ($path !== $this->rootPath && strpos($path, $root) !== 0) {
+            return null;
+        } else {
+            $path = substr($path, strlen($this->rootPath));
+            return trim($path, '/');
+        }
+    }
+
+    public function getId() {
+        return parent::getId();
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.mkdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function mkdir($path) {
+        return $this->getWrapperStorage()->mkdir($this->getUnjailedPath($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function rmdir($path) {
+        return $this->getWrapperStorage()->rmdir($this->getUnjailedPath($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource
+     */
+    public function opendir($path) {
+        return $this->getWrapperStorage()->opendir($this->getUnjailedPath($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.is_dir.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function is_dir($path) {
+        return $this->getWrapperStorage()->is_dir($this->getUnjailedPath($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.is_file.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function is_file($path) {
+        return $this->getWrapperStorage()->is_file($this->getUnjailedPath($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
+     */
+    public function stat($path) {
+        return $this->getWrapperStorage()->stat($this->getUnjailedPath($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function filetype($path) {
+        return $this->getWrapperStorage()->filetype($this->getUnjailedPath($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
+     */
+    public function filesize($path) {
+        return $this->getWrapperStorage()->filesize($this->getUnjailedPath($path));
+    }
+
+    /**
+     * check if a file can be created in $path
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isCreatable($path) {
+        return $this->getWrapperStorage()->isCreatable($this->getUnjailedPath($path));
+    }
+
+    /**
+     * check if a file can be read
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isReadable($path) {
+        return $this->getWrapperStorage()->isReadable($this->getUnjailedPath($path));
+    }
+
+    /**
+     * check if a file can be written to
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isUpdatable($path) {
+        return $this->getWrapperStorage()->isUpdatable($this->getUnjailedPath($path));
+    }
+
+    /**
+     * check if a file can be deleted
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isDeletable($path) {
+        return $this->getWrapperStorage()->isDeletable($this->getUnjailedPath($path));
+    }
+
+    /**
+     * check if a file can be shared
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function isSharable($path) {
+        return $this->getWrapperStorage()->isSharable($this->getUnjailedPath($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->getWrapperStorage()->getPermissions($this->getUnjailedPath($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function file_exists($path) {
+        return $this->getWrapperStorage()->file_exists($this->getUnjailedPath($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.filemtime.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function filemtime($path) {
+        return $this->getWrapperStorage()->filemtime($this->getUnjailedPath($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.file_get_contents.php
+     *
+     * @param string $path
+     * @return string
+     */
+    public function file_get_contents($path) {
+        return $this->getWrapperStorage()->file_get_contents($this->getUnjailedPath($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->getWrapperStorage()->file_put_contents($this->getUnjailedPath($path), $data);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     */
+    public function unlink($path) {
+        return $this->getWrapperStorage()->unlink($this->getUnjailedPath($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function rename($path1, $path2) {
+        return $this->getWrapperStorage()->rename($this->getUnjailedPath($path1), $this->getUnjailedPath($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->getWrapperStorage()->copy($this->getUnjailedPath($path1), $this->getUnjailedPath($path2));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource
+     */
+    public function fopen($path, $mode) {
+        return $this->getWrapperStorage()->fopen($this->getUnjailedPath($path), $mode);
+    }
+
+    /**
+     * 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
+     */
+    public function getMimeType($path) {
+        return $this->getWrapperStorage()->getMimeType($this->getUnjailedPath($path));
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.hash.php
+     *
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return string
+     */
+    public function hash($type, $path, $raw = false) {
+        return $this->getWrapperStorage()->hash($type, $this->getUnjailedPath($path), $raw);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.free_space.php
+     *
+     * @param string $path
+     * @return int
+     */
+    public function free_space($path) {
+        return $this->getWrapperStorage()->free_space($this->getUnjailedPath($path));
+    }
+
+    /**
+     * search for occurrences of $query in file names
+     *
+     * @param string $query
+     * @return array
+     */
+    public function search($query) {
+        return $this->getWrapperStorage()->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->getWrapperStorage()->touch($this->getUnjailedPath($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
+     */
+    public function getLocalFile($path) {
+        return $this->getWrapperStorage()->getLocalFile($this->getUnjailedPath($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->getWrapperStorage()->hasUpdated($this->getUnjailedPath($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->getWrapperStorage();
+        }
+        $sourceCache = $this->getWrapperStorage()->getCache($this->getUnjailedPath($path), $storage);
+        return new CacheJail($sourceCache, $this->rootPath);
+    }
+
+    /**
+     * get the user id of the owner of a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getOwner($path) {
+        return $this->getWrapperStorage()->getOwner($this->getUnjailedPath($path));
+    }
+
+    /**
+     * get a watcher instance for the cache
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
+     * @return \OC\Files\Cache\Watcher
+     */
+    public function getWatcher($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return $this->getWrapperStorage()->getWatcher($this->getUnjailedPath($path), $storage);
+    }
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getETag($path) {
+        return $this->getWrapperStorage()->getETag($this->getUnjailedPath($path));
+    }
+
+    /**
+     * @param string $path
+     * @return array
+     */
+    public function getMetaData($path) {
+        return $this->getWrapperStorage()->getMetaData($this->getUnjailedPath($path));
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function acquireLock($path, $type, ILockingProvider $provider) {
+        $this->getWrapperStorage()->acquireLock($this->getUnjailedPath($path), $type, $provider);
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     */
+    public function releaseLock($path, $type, ILockingProvider $provider) {
+        $this->getWrapperStorage()->releaseLock($this->getUnjailedPath($path), $type, $provider);
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     */
+    public function changeLock($path, $type, ILockingProvider $provider) {
+        $this->getWrapperStorage()->changeLock($this->getUnjailedPath($path), $type, $provider);
+    }
+
+    /**
+     * Resolve the path for the source of the share
+     *
+     * @param string $path
+     * @return array
+     */
+    public function resolvePath($path) {
+        return [$this->getWrapperStorage(), $this->getUnjailedPath($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, $targetInternalPath);
+        }
+        return $this->getWrapperStorage()->copyFromStorage($sourceStorage, $sourceInternalPath, $this->getUnjailedPath($targetInternalPath));
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        if ($sourceStorage === $this) {
+            return $this->rename($sourceInternalPath, $targetInternalPath);
+        }
+        return $this->getWrapperStorage()->moveFromStorage($sourceStorage, $sourceInternalPath, $this->getUnjailedPath($targetInternalPath));
+    }
+
+    public function getPropagator($storage = null) {
+        if (isset($this->propagator)) {
+            return $this->propagator;
+        }
+
+        if (!$storage) {
+            $storage = $this;
+        }
+        $this->propagator = new JailPropagator($storage, \OC::$server->getDatabaseConnection());
+        return $this->propagator;
+    }
+
+    public function writeStream(string $path, $stream, int $size = null): int {
+        $storage = $this->getWrapperStorage();
+        if ($storage->instanceOfStorage(IWriteStreamStorage::class)) {
+            /** @var IWriteStreamStorage $storage */
+            return $storage->writeStream($this->getUnjailedPath($path), $stream, $size);
+        } else {
+            $target = $this->fopen($path, 'w');
+            list($count, $result) = \OC_Helper::streamCopy($stream, $target);
+            fclose($stream);
+            fclose($target);
+            return $count;
+        }
+    }
+
+    public function getDirectoryContent($directory): \Traversable {
+        return $this->getWrapperStorage()->getDirectoryContent($this->getUnjailedPath($directory));
+    }
 }

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

Indentation +502 added lines, -502 removed lines

@@ -37,506 +37,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 (bool) !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
-	 */
-	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
-	 */
-	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 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
-	 */
-	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
-	 */
-	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
-	 */
-	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
-	 */
-	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
-	 */
-	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
-	 */
-	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
-	 */
-	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
-	 */
-	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
-	 */
-	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
-	 */
-	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 (bool) !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
+     */
+    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
+     */
+    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 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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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/Storage/Wrapper/Quota.php

Indentation +204 added lines, -204 removed lines

@@ -36,208 +36,208 @@
 
 class Quota extends Wrapper {
 
-	/**
-	 * @var int $quota
-	 */
-	protected $quota;
-
-	/**
-	 * @var string $sizeRoot
-	 */
-	protected $sizeRoot;
-
-	private $config;
-
-	/**
-	 * @param array $parameters
-	 */
-	public function __construct($parameters) {
-		parent::__construct($parameters);
-		$this->quota = $parameters['quota'];
-		$this->sizeRoot = isset($parameters['root']) ? $parameters['root'] : '';
-		$this->config = \OC::$server->getSystemConfig();
-	}
-
-	/**
-	 * @return int quota value
-	 */
-	public function getQuota() {
-		return $this->quota;
-	}
-
-	/**
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage $storage
-	 */
-	protected function getSize($path, $storage = null) {
-		if ($this->config->getValue('quota_include_external_storage', false)) {
-			$rootInfo = Filesystem::getFileInfo('', 'ext');
-			if ($rootInfo) {
-				return $rootInfo->getSize(true);
-			}
-			return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
-		} else {
-			if (is_null($storage)) {
-				$cache = $this->getCache();
-			} else {
-				$cache = $storage->getCache();
-			}
-			$data = $cache->get($path);
-			if ($data instanceof ICacheEntry and isset($data['size'])) {
-				return $data['size'];
-			} else {
-				return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
-			}
-		}
-	}
-
-	/**
-	 * Get free space as limited by the quota
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function free_space($path) {
-		if ($this->quota < 0 || strpos($path, 'cache') === 0 || strpos($path, 'uploads') === 0) {
-			return $this->storage->free_space($path);
-		} else {
-			$used = $this->getSize($this->sizeRoot);
-			if ($used < 0) {
-				return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
-			} else {
-				$free = $this->storage->free_space($path);
-				$quotaFree = max($this->quota - $used, 0);
-				// if free space is known
-				if ($free >= 0) {
-					$free = min($free, $quotaFree);
-				} else {
-					$free = $quotaFree;
-				}
-				return $free;
-			}
-		}
-	}
-
-	/**
-	 * 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) {
-		$free = $this->free_space($path);
-		if ($free < 0 or strlen($data) < $free) {
-			return $this->storage->file_put_contents($path, $data);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.copy.php
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return bool
-	 */
-	public function copy($source, $target) {
-		$free = $this->free_space($target);
-		if ($free < 0 or $this->getSize($source) < $free) {
-			return $this->storage->copy($source, $target);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource
-	 */
-	public function fopen($path, $mode) {
-		$source = $this->storage->fopen($path, $mode);
-
-		// don't apply quota for part files
-		if (!$this->isPartFile($path)) {
-			$free = $this->free_space($path);
-			if ($source && $free >= 0 && $mode !== 'r' && $mode !== 'rb') {
-				// only apply quota for files, not metadata, trash or others
-				if ($this->shouldApplyQuota($path)) {
-					return \OC\Files\Stream\Quota::wrap($source, $free);
-				}
-			}
-		}
-		return $source;
-	}
-
-	/**
-	 * Checks whether the given path is a part file
-	 *
-	 * @param string $path Path that may identify a .part file
-	 * @return string File path without .part extension
-	 * @note this is needed for reusing keys
-	 */
-	private function isPartFile($path) {
-		$extension = pathinfo($path, PATHINFO_EXTENSION);
-
-		return ($extension === 'part');
-	}
-
-	/**
-	 * Only apply quota for files, not metadata, trash or others
-	 */
-	private function shouldApplyQuota(string $path): bool {
-		return strpos(ltrim($path, '/'), 'files/') === 0;
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		$free = $this->free_space($targetInternalPath);
-		if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
-			return $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		$free = $this->free_space($targetInternalPath);
-		if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
-			return $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		} else {
-			return false;
-		}
-	}
-
-	public function mkdir($path) {
-		$free = $this->free_space($path);
-		if ($this->shouldApplyQuota($path) && $free === 0.0) {
-			return false;
-		}
-
-		return parent::mkdir($path);
-	}
-
-	public function touch($path, $mtime = null) {
-		$free = $this->free_space($path);
-		if ($free === 0.0) {
-			return false;
-		}
-
-		return parent::touch($path, $mtime);
-	}
+    /**
+     * @var int $quota
+     */
+    protected $quota;
+
+    /**
+     * @var string $sizeRoot
+     */
+    protected $sizeRoot;
+
+    private $config;
+
+    /**
+     * @param array $parameters
+     */
+    public function __construct($parameters) {
+        parent::__construct($parameters);
+        $this->quota = $parameters['quota'];
+        $this->sizeRoot = isset($parameters['root']) ? $parameters['root'] : '';
+        $this->config = \OC::$server->getSystemConfig();
+    }
+
+    /**
+     * @return int quota value
+     */
+    public function getQuota() {
+        return $this->quota;
+    }
+
+    /**
+     * @param string $path
+     * @param \OC\Files\Storage\Storage $storage
+     */
+    protected function getSize($path, $storage = null) {
+        if ($this->config->getValue('quota_include_external_storage', false)) {
+            $rootInfo = Filesystem::getFileInfo('', 'ext');
+            if ($rootInfo) {
+                return $rootInfo->getSize(true);
+            }
+            return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
+        } else {
+            if (is_null($storage)) {
+                $cache = $this->getCache();
+            } else {
+                $cache = $storage->getCache();
+            }
+            $data = $cache->get($path);
+            if ($data instanceof ICacheEntry and isset($data['size'])) {
+                return $data['size'];
+            } else {
+                return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
+            }
+        }
+    }
+
+    /**
+     * Get free space as limited by the quota
+     *
+     * @param string $path
+     * @return int
+     */
+    public function free_space($path) {
+        if ($this->quota < 0 || strpos($path, 'cache') === 0 || strpos($path, 'uploads') === 0) {
+            return $this->storage->free_space($path);
+        } else {
+            $used = $this->getSize($this->sizeRoot);
+            if ($used < 0) {
+                return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
+            } else {
+                $free = $this->storage->free_space($path);
+                $quotaFree = max($this->quota - $used, 0);
+                // if free space is known
+                if ($free >= 0) {
+                    $free = min($free, $quotaFree);
+                } else {
+                    $free = $quotaFree;
+                }
+                return $free;
+            }
+        }
+    }
+
+    /**
+     * 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) {
+        $free = $this->free_space($path);
+        if ($free < 0 or strlen($data) < $free) {
+            return $this->storage->file_put_contents($path, $data);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.copy.php
+     *
+     * @param string $source
+     * @param string $target
+     * @return bool
+     */
+    public function copy($source, $target) {
+        $free = $this->free_space($target);
+        if ($free < 0 or $this->getSize($source) < $free) {
+            return $this->storage->copy($source, $target);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource
+     */
+    public function fopen($path, $mode) {
+        $source = $this->storage->fopen($path, $mode);
+
+        // don't apply quota for part files
+        if (!$this->isPartFile($path)) {
+            $free = $this->free_space($path);
+            if ($source && $free >= 0 && $mode !== 'r' && $mode !== 'rb') {
+                // only apply quota for files, not metadata, trash or others
+                if ($this->shouldApplyQuota($path)) {
+                    return \OC\Files\Stream\Quota::wrap($source, $free);
+                }
+            }
+        }
+        return $source;
+    }
+
+    /**
+     * Checks whether the given path is a part file
+     *
+     * @param string $path Path that may identify a .part file
+     * @return string File path without .part extension
+     * @note this is needed for reusing keys
+     */
+    private function isPartFile($path) {
+        $extension = pathinfo($path, PATHINFO_EXTENSION);
+
+        return ($extension === 'part');
+    }
+
+    /**
+     * Only apply quota for files, not metadata, trash or others
+     */
+    private function shouldApplyQuota(string $path): bool {
+        return strpos(ltrim($path, '/'), 'files/') === 0;
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        $free = $this->free_space($targetInternalPath);
+        if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
+            return $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        $free = $this->free_space($targetInternalPath);
+        if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
+            return $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        } else {
+            return false;
+        }
+    }
+
+    public function mkdir($path) {
+        $free = $this->free_space($path);
+        if ($this->shouldApplyQuota($path) && $free === 0.0) {
+            return false;
+        }
+
+        return parent::mkdir($path);
+    }
+
+    public function touch($path, $mtime = null) {
+        $free = $this->free_space($path);
+        if ($free === 0.0) {
+            return false;
+        }
+
+        return parent::touch($path, $mtime);
+    }
 }

lib/private/legacy/OC_Image.php

Indentation +1224 added lines, -1224 removed lines

@@ -45,569 +45,569 @@ 
  * Class for basic image manipulation
  */
 class OC_Image implements \OCP\IImage {
-	/** @var false|resource */
-	protected $resource = false; // tmp resource.
-	/** @var int */
-	protected $imageType = IMAGETYPE_PNG; // Default to png if file type isn't evident.
-	/** @var string */
-	protected $mimeType = 'image/png'; // Default to png
-	/** @var int */
-	protected $bitDepth = 24;
-	/** @var null|string */
-	protected $filePath = null;
-	/** @var finfo */
-	private $fileInfo;
-	/** @var \OCP\ILogger */
-	private $logger;
-	/** @var \OCP\IConfig */
-	private $config;
-	/** @var array */
-	private $exif;
-
-	/**
-	 * Constructor.
-	 *
-	 * @param resource|string $imageRef The path to a local file, a base64 encoded string or a resource created by
-	 * an imagecreate* function.
-	 * @param \OCP\ILogger $logger
-	 * @param \OCP\IConfig $config
-	 * @throws \InvalidArgumentException in case the $imageRef parameter is not null
-	 */
-	public function __construct($imageRef = null, \OCP\ILogger $logger = null, \OCP\IConfig $config = null) {
-		$this->logger = $logger;
-		if ($logger === null) {
-			$this->logger = \OC::$server->getLogger();
-		}
-		$this->config = $config;
-		if ($config === null) {
-			$this->config = \OC::$server->getConfig();
-		}
-
-		if (\OC_Util::fileInfoLoaded()) {
-			$this->fileInfo = new finfo(FILEINFO_MIME_TYPE);
-		}
-
-		if ($imageRef !== null) {
-			throw new \InvalidArgumentException('The first parameter in the constructor is not supported anymore. Please use any of the load* methods of the image object to load an image.');
-		}
-	}
-
-	/**
-	 * Determine whether the object contains an image resource.
-	 *
-	 * @return bool
-	 */
-	public function valid() { // apparently you can't name a method 'empty'...
-		if (is_resource($this->resource)) {
-			return true;
-		}
-		if (is_object($this->resource) && get_class($this->resource) === 'GdImage') {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Returns the MIME type of the image or an empty string if no image is loaded.
-	 *
-	 * @return string
-	 */
-	public function mimeType() {
-		return $this->valid() ? $this->mimeType : '';
-	}
-
-	/**
-	 * Returns the width of the image or -1 if no image is loaded.
-	 *
-	 * @return int
-	 */
-	public function width() {
-		return $this->valid() ? imagesx($this->resource) : -1;
-	}
-
-	/**
-	 * Returns the height of the image or -1 if no image is loaded.
-	 *
-	 * @return int
-	 */
-	public function height() {
-		return $this->valid() ? imagesy($this->resource) : -1;
-	}
-
-	/**
-	 * Returns the width when the image orientation is top-left.
-	 *
-	 * @return int
-	 */
-	public function widthTopLeft() {
-		$o = $this->getOrientation();
-		$this->logger->debug('OC_Image->widthTopLeft() Orientation: ' . $o, ['app' => 'core']);
-		switch ($o) {
-			case -1:
-			case 1:
-			case 2: // Not tested
-			case 3:
-			case 4: // Not tested
-				return $this->width();
-			case 5: // Not tested
-			case 6:
-			case 7: // Not tested
-			case 8:
-				return $this->height();
-		}
-		return $this->width();
-	}
-
-	/**
-	 * Returns the height when the image orientation is top-left.
-	 *
-	 * @return int
-	 */
-	public function heightTopLeft() {
-		$o = $this->getOrientation();
-		$this->logger->debug('OC_Image->heightTopLeft() Orientation: ' . $o, ['app' => 'core']);
-		switch ($o) {
-			case -1:
-			case 1:
-			case 2: // Not tested
-			case 3:
-			case 4: // Not tested
-				return $this->height();
-			case 5: // Not tested
-			case 6:
-			case 7: // Not tested
-			case 8:
-				return $this->width();
-		}
-		return $this->height();
-	}
-
-	/**
-	 * Outputs the image.
-	 *
-	 * @param string $mimeType
-	 * @return bool
-	 */
-	public function show($mimeType = null) {
-		if ($mimeType === null) {
-			$mimeType = $this->mimeType();
-		}
-		header('Content-Type: ' . $mimeType);
-		return $this->_output(null, $mimeType);
-	}
-
-	/**
-	 * Saves the image.
-	 *
-	 * @param string $filePath
-	 * @param string $mimeType
-	 * @return bool
-	 */
-
-	public function save($filePath = null, $mimeType = null) {
-		if ($mimeType === null) {
-			$mimeType = $this->mimeType();
-		}
-		if ($filePath === null) {
-			if ($this->filePath === null) {
-				$this->logger->error(__METHOD__ . '(): called with no path.', ['app' => 'core']);
-				return false;
-			} else {
-				$filePath = $this->filePath;
-			}
-		}
-		return $this->_output($filePath, $mimeType);
-	}
-
-	/**
-	 * Outputs/saves the image.
-	 *
-	 * @param string $filePath
-	 * @param string $mimeType
-	 * @return bool
-	 * @throws Exception
-	 */
-	private function _output($filePath = null, $mimeType = null) {
-		if ($filePath) {
-			if (!file_exists(dirname($filePath))) {
-				mkdir(dirname($filePath), 0777, true);
-			}
-			$isWritable = is_writable(dirname($filePath));
-			if (!$isWritable) {
-				$this->logger->error(__METHOD__ . '(): Directory \'' . dirname($filePath) . '\' is not writable.', ['app' => 'core']);
-				return false;
-			} elseif ($isWritable && file_exists($filePath) && !is_writable($filePath)) {
-				$this->logger->error(__METHOD__ . '(): File \'' . $filePath . '\' is not writable.', ['app' => 'core']);
-				return false;
-			}
-		}
-		if (!$this->valid()) {
-			return false;
-		}
-
-		$imageType = $this->imageType;
-		if ($mimeType !== null) {
-			switch ($mimeType) {
-				case 'image/gif':
-					$imageType = IMAGETYPE_GIF;
-					break;
-				case 'image/jpeg':
-					$imageType = IMAGETYPE_JPEG;
-					break;
-				case 'image/png':
-					$imageType = IMAGETYPE_PNG;
-					break;
-				case 'image/x-xbitmap':
-					$imageType = IMAGETYPE_XBM;
-					break;
-				case 'image/bmp':
-				case 'image/x-ms-bmp':
-					$imageType = IMAGETYPE_BMP;
-					break;
-				default:
-					throw new Exception('\OC_Image::_output(): "' . $mimeType . '" is not supported when forcing a specific output format');
-			}
-		}
-
-		switch ($imageType) {
-			case IMAGETYPE_GIF:
-				$retVal = imagegif($this->resource, $filePath);
-				break;
-			case IMAGETYPE_JPEG:
-				$retVal = imagejpeg($this->resource, $filePath, $this->getJpegQuality());
-				break;
-			case IMAGETYPE_PNG:
-				$retVal = imagepng($this->resource, $filePath);
-				break;
-			case IMAGETYPE_XBM:
-				if (function_exists('imagexbm')) {
-					$retVal = imagexbm($this->resource, $filePath);
-				} else {
-					throw new Exception('\OC_Image::_output(): imagexbm() is not supported.');
-				}
-
-				break;
-			case IMAGETYPE_WBMP:
-				$retVal = imagewbmp($this->resource, $filePath);
-				break;
-			case IMAGETYPE_BMP:
-				$retVal = imagebmp($this->resource, $filePath, $this->bitDepth);
-				break;
-			default:
-				$retVal = imagepng($this->resource, $filePath);
-		}
-		return $retVal;
-	}
-
-	/**
-	 * Prints the image when called as $image().
-	 */
-	public function __invoke() {
-		return $this->show();
-	}
-
-	/**
-	 * @param resource Returns the image resource in any.
-	 * @throws \InvalidArgumentException in case the supplied resource does not have the type "gd"
-	 */
-	public function setResource($resource) {
-		// For PHP<8
-		if (is_resource($resource) && get_resource_type($resource) === 'gd') {
-			$this->resource = $resource;
-			return;
-		}
-		// PHP 8 has real objects for GD stuff
-		if (is_object($resource) && get_class($resource) === 'GdImage') {
-			$this->resource = $resource;
-			return;
-		}
-		throw new \InvalidArgumentException('Supplied resource is not of type "gd".');
-	}
-
-	/**
-	 * @return resource Returns the image resource in any.
-	 */
-	public function resource() {
-		return $this->resource;
-	}
-
-	/**
-	 * @return string Returns the mimetype of the data. Returns the empty string
-	 * if the data is not valid.
-	 */
-	public function dataMimeType() {
-		if (!$this->valid()) {
-			return '';
-		}
-
-		switch ($this->mimeType) {
-			case 'image/png':
-			case 'image/jpeg':
-			case 'image/gif':
-				return $this->mimeType;
-			default:
-				return 'image/png';
-		}
-	}
-
-	/**
-	 * @return null|string Returns the raw image data.
-	 */
-	public function data() {
-		if (!$this->valid()) {
-			return null;
-		}
-		ob_start();
-		switch ($this->mimeType) {
-			case "image/png":
-				$res = imagepng($this->resource);
-				break;
-			case "image/jpeg":
-				$quality = $this->getJpegQuality();
-				if ($quality !== null) {
-					$res = imagejpeg($this->resource, null, $quality);
-				} else {
-					$res = imagejpeg($this->resource);
-				}
-				break;
-			case "image/gif":
-				$res = imagegif($this->resource);
-				break;
-			default:
-				$res = imagepng($this->resource);
-				$this->logger->info('OC_Image->data. Could not guess mime-type, defaulting to png', ['app' => 'core']);
-				break;
-		}
-		if (!$res) {
-			$this->logger->error('OC_Image->data. Error getting image data.', ['app' => 'core']);
-		}
-		return ob_get_clean();
-	}
-
-	/**
-	 * @return string - base64 encoded, which is suitable for embedding in a VCard.
-	 */
-	public function __toString() {
-		return base64_encode($this->data());
-	}
-
-	/**
-	 * @return int|null
-	 */
-	protected function getJpegQuality() {
-		$quality = $this->config->getAppValue('preview', 'jpeg_quality', 90);
-		if ($quality !== null) {
-			$quality = min(100, max(10, (int) $quality));
-		}
-		return $quality;
-	}
-
-	/**
-	 * (I'm open for suggestions on better method name ;)
-	 * Get the orientation based on EXIF data.
-	 *
-	 * @return int The orientation or -1 if no EXIF data is available.
-	 */
-	public function getOrientation() {
-		if ($this->exif !== null) {
-			return $this->exif['Orientation'];
-		}
-
-		if ($this->imageType !== IMAGETYPE_JPEG) {
-			$this->logger->debug('OC_Image->fixOrientation() Image is not a JPEG.', ['app' => 'core']);
-			return -1;
-		}
-		if (!is_callable('exif_read_data')) {
-			$this->logger->debug('OC_Image->fixOrientation() Exif module not enabled.', ['app' => 'core']);
-			return -1;
-		}
-		if (!$this->valid()) {
-			$this->logger->debug('OC_Image->fixOrientation() No image loaded.', ['app' => 'core']);
-			return -1;
-		}
-		if (is_null($this->filePath) || !is_readable($this->filePath)) {
-			$this->logger->debug('OC_Image->fixOrientation() No readable file path set.', ['app' => 'core']);
-			return -1;
-		}
-		$exif = @exif_read_data($this->filePath, 'IFD0');
-		if (!$exif) {
-			return -1;
-		}
-		if (!isset($exif['Orientation'])) {
-			return -1;
-		}
-		$this->exif = $exif;
-		return $exif['Orientation'];
-	}
-
-	public function readExif($data) {
-		if (!is_callable('exif_read_data')) {
-			$this->logger->debug('OC_Image->fixOrientation() Exif module not enabled.', ['app' => 'core']);
-			return;
-		}
-		if (!$this->valid()) {
-			$this->logger->debug('OC_Image->fixOrientation() No image loaded.', ['app' => 'core']);
-			return;
-		}
-
-		$exif = @exif_read_data('data://image/jpeg;base64,' . base64_encode($data));
-		if (!$exif) {
-			return;
-		}
-		if (!isset($exif['Orientation'])) {
-			return;
-		}
-		$this->exif = $exif;
-	}
-
-	/**
-	 * (I'm open for suggestions on better method name ;)
-	 * Fixes orientation based on EXIF data.
-	 *
-	 * @return bool
-	 */
-	public function fixOrientation() {
-		$o = $this->getOrientation();
-		$this->logger->debug('OC_Image->fixOrientation() Orientation: ' . $o, ['app' => 'core']);
-		$rotate = 0;
-		$flip = false;
-		switch ($o) {
-			case -1:
-				return false; //Nothing to fix
-			case 1:
-				$rotate = 0;
-				break;
-			case 2:
-				$rotate = 0;
-				$flip = true;
-				break;
-			case 3:
-				$rotate = 180;
-				break;
-			case 4:
-				$rotate = 180;
-				$flip = true;
-				break;
-			case 5:
-				$rotate = 90;
-				$flip = true;
-				break;
-			case 6:
-				$rotate = 270;
-				break;
-			case 7:
-				$rotate = 270;
-				$flip = true;
-				break;
-			case 8:
-				$rotate = 90;
-				break;
-		}
-		if ($flip && function_exists('imageflip')) {
-			imageflip($this->resource, IMG_FLIP_HORIZONTAL);
-		}
-		if ($rotate) {
-			$res = imagerotate($this->resource, $rotate, 0);
-			if ($res) {
-				if (imagealphablending($res, true)) {
-					if (imagesavealpha($res, true)) {
-						imagedestroy($this->resource);
-						$this->resource = $res;
-						return true;
-					} else {
-						$this->logger->debug('OC_Image->fixOrientation() Error during alpha-saving', ['app' => 'core']);
-						return false;
-					}
-				} else {
-					$this->logger->debug('OC_Image->fixOrientation() Error during alpha-blending', ['app' => 'core']);
-					return false;
-				}
-			} else {
-				$this->logger->debug('OC_Image->fixOrientation() Error during orientation fixing', ['app' => 'core']);
-				return false;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * Loads an image from an open file handle.
-	 * It is the responsibility of the caller to position the pointer at the correct place and to close the handle again.
-	 *
-	 * @param resource $handle
-	 * @return resource|false An image resource or false on error
-	 */
-	public function loadFromFileHandle($handle) {
-		$contents = stream_get_contents($handle);
-		if ($this->loadFromData($contents)) {
-			return $this->resource;
-		}
-		return false;
-	}
-
-	/**
-	 * Loads an image from a local file.
-	 *
-	 * @param bool|string $imagePath The path to a local file.
-	 * @return bool|resource An image resource or false on error
-	 */
-	public function loadFromFile($imagePath = false) {
-		// exif_imagetype throws "read error!" if file is less than 12 byte
-		if (!@is_file($imagePath) || !file_exists($imagePath) || filesize($imagePath) < 12 || !is_readable($imagePath)) {
-			return false;
-		}
-		$iType = exif_imagetype($imagePath);
-		switch ($iType) {
-			case IMAGETYPE_GIF:
-				if (imagetypes() & IMG_GIF) {
-					$this->resource = imagecreatefromgif($imagePath);
-					// Preserve transparency
-					imagealphablending($this->resource, true);
-					imagesavealpha($this->resource, true);
-				} else {
-					$this->logger->debug('OC_Image->loadFromFile, GIF images not supported: ' . $imagePath, ['app' => 'core']);
-				}
-				break;
-			case IMAGETYPE_JPEG:
-				if (imagetypes() & IMG_JPG) {
-					if (getimagesize($imagePath) !== false) {
-						$this->resource = @imagecreatefromjpeg($imagePath);
-					} else {
-						$this->logger->debug('OC_Image->loadFromFile, JPG image not valid: ' . $imagePath, ['app' => 'core']);
-					}
-				} else {
-					$this->logger->debug('OC_Image->loadFromFile, JPG images not supported: ' . $imagePath, ['app' => 'core']);
-				}
-				break;
-			case IMAGETYPE_PNG:
-				if (imagetypes() & IMG_PNG) {
-					$this->resource = @imagecreatefrompng($imagePath);
-					// Preserve transparency
-					imagealphablending($this->resource, true);
-					imagesavealpha($this->resource, true);
-				} else {
-					$this->logger->debug('OC_Image->loadFromFile, PNG images not supported: ' . $imagePath, ['app' => 'core']);
-				}
-				break;
-			case IMAGETYPE_XBM:
-				if (imagetypes() & IMG_XPM) {
-					$this->resource = @imagecreatefromxbm($imagePath);
-				} else {
-					$this->logger->debug('OC_Image->loadFromFile, XBM/XPM images not supported: ' . $imagePath, ['app' => 'core']);
-				}
-				break;
-			case IMAGETYPE_WBMP:
-				if (imagetypes() & IMG_WBMP) {
-					$this->resource = @imagecreatefromwbmp($imagePath);
-				} else {
-					$this->logger->debug('OC_Image->loadFromFile, WBMP images not supported: ' . $imagePath, ['app' => 'core']);
-				}
-				break;
-			case IMAGETYPE_BMP:
-				$this->resource = $this->imagecreatefrombmp($imagePath);
-				break;
-			/*
+    /** @var false|resource */
+    protected $resource = false; // tmp resource.
+    /** @var int */
+    protected $imageType = IMAGETYPE_PNG; // Default to png if file type isn't evident.
+    /** @var string */
+    protected $mimeType = 'image/png'; // Default to png
+    /** @var int */
+    protected $bitDepth = 24;
+    /** @var null|string */
+    protected $filePath = null;
+    /** @var finfo */
+    private $fileInfo;
+    /** @var \OCP\ILogger */
+    private $logger;
+    /** @var \OCP\IConfig */
+    private $config;
+    /** @var array */
+    private $exif;
+
+    /**
+     * Constructor.
+     *
+     * @param resource|string $imageRef The path to a local file, a base64 encoded string or a resource created by
+     * an imagecreate* function.
+     * @param \OCP\ILogger $logger
+     * @param \OCP\IConfig $config
+     * @throws \InvalidArgumentException in case the $imageRef parameter is not null
+     */
+    public function __construct($imageRef = null, \OCP\ILogger $logger = null, \OCP\IConfig $config = null) {
+        $this->logger = $logger;
+        if ($logger === null) {
+            $this->logger = \OC::$server->getLogger();
+        }
+        $this->config = $config;
+        if ($config === null) {
+            $this->config = \OC::$server->getConfig();
+        }
+
+        if (\OC_Util::fileInfoLoaded()) {
+            $this->fileInfo = new finfo(FILEINFO_MIME_TYPE);
+        }
+
+        if ($imageRef !== null) {
+            throw new \InvalidArgumentException('The first parameter in the constructor is not supported anymore. Please use any of the load* methods of the image object to load an image.');
+        }
+    }
+
+    /**
+     * Determine whether the object contains an image resource.
+     *
+     * @return bool
+     */
+    public function valid() { // apparently you can't name a method 'empty'...
+        if (is_resource($this->resource)) {
+            return true;
+        }
+        if (is_object($this->resource) && get_class($this->resource) === 'GdImage') {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Returns the MIME type of the image or an empty string if no image is loaded.
+     *
+     * @return string
+     */
+    public function mimeType() {
+        return $this->valid() ? $this->mimeType : '';
+    }
+
+    /**
+     * Returns the width of the image or -1 if no image is loaded.
+     *
+     * @return int
+     */
+    public function width() {
+        return $this->valid() ? imagesx($this->resource) : -1;
+    }
+
+    /**
+     * Returns the height of the image or -1 if no image is loaded.
+     *
+     * @return int
+     */
+    public function height() {
+        return $this->valid() ? imagesy($this->resource) : -1;
+    }
+
+    /**
+     * Returns the width when the image orientation is top-left.
+     *
+     * @return int
+     */
+    public function widthTopLeft() {
+        $o = $this->getOrientation();
+        $this->logger->debug('OC_Image->widthTopLeft() Orientation: ' . $o, ['app' => 'core']);
+        switch ($o) {
+            case -1:
+            case 1:
+            case 2: // Not tested
+            case 3:
+            case 4: // Not tested
+                return $this->width();
+            case 5: // Not tested
+            case 6:
+            case 7: // Not tested
+            case 8:
+                return $this->height();
+        }
+        return $this->width();
+    }
+
+    /**
+     * Returns the height when the image orientation is top-left.
+     *
+     * @return int
+     */
+    public function heightTopLeft() {
+        $o = $this->getOrientation();
+        $this->logger->debug('OC_Image->heightTopLeft() Orientation: ' . $o, ['app' => 'core']);
+        switch ($o) {
+            case -1:
+            case 1:
+            case 2: // Not tested
+            case 3:
+            case 4: // Not tested
+                return $this->height();
+            case 5: // Not tested
+            case 6:
+            case 7: // Not tested
+            case 8:
+                return $this->width();
+        }
+        return $this->height();
+    }
+
+    /**
+     * Outputs the image.
+     *
+     * @param string $mimeType
+     * @return bool
+     */
+    public function show($mimeType = null) {
+        if ($mimeType === null) {
+            $mimeType = $this->mimeType();
+        }
+        header('Content-Type: ' . $mimeType);
+        return $this->_output(null, $mimeType);
+    }
+
+    /**
+     * Saves the image.
+     *
+     * @param string $filePath
+     * @param string $mimeType
+     * @return bool
+     */
+
+    public function save($filePath = null, $mimeType = null) {
+        if ($mimeType === null) {
+            $mimeType = $this->mimeType();
+        }
+        if ($filePath === null) {
+            if ($this->filePath === null) {
+                $this->logger->error(__METHOD__ . '(): called with no path.', ['app' => 'core']);
+                return false;
+            } else {
+                $filePath = $this->filePath;
+            }
+        }
+        return $this->_output($filePath, $mimeType);
+    }
+
+    /**
+     * Outputs/saves the image.
+     *
+     * @param string $filePath
+     * @param string $mimeType
+     * @return bool
+     * @throws Exception
+     */
+    private function _output($filePath = null, $mimeType = null) {
+        if ($filePath) {
+            if (!file_exists(dirname($filePath))) {
+                mkdir(dirname($filePath), 0777, true);
+            }
+            $isWritable = is_writable(dirname($filePath));
+            if (!$isWritable) {
+                $this->logger->error(__METHOD__ . '(): Directory \'' . dirname($filePath) . '\' is not writable.', ['app' => 'core']);
+                return false;
+            } elseif ($isWritable && file_exists($filePath) && !is_writable($filePath)) {
+                $this->logger->error(__METHOD__ . '(): File \'' . $filePath . '\' is not writable.', ['app' => 'core']);
+                return false;
+            }
+        }
+        if (!$this->valid()) {
+            return false;
+        }
+
+        $imageType = $this->imageType;
+        if ($mimeType !== null) {
+            switch ($mimeType) {
+                case 'image/gif':
+                    $imageType = IMAGETYPE_GIF;
+                    break;
+                case 'image/jpeg':
+                    $imageType = IMAGETYPE_JPEG;
+                    break;
+                case 'image/png':
+                    $imageType = IMAGETYPE_PNG;
+                    break;
+                case 'image/x-xbitmap':
+                    $imageType = IMAGETYPE_XBM;
+                    break;
+                case 'image/bmp':
+                case 'image/x-ms-bmp':
+                    $imageType = IMAGETYPE_BMP;
+                    break;
+                default:
+                    throw new Exception('\OC_Image::_output(): "' . $mimeType . '" is not supported when forcing a specific output format');
+            }
+        }
+
+        switch ($imageType) {
+            case IMAGETYPE_GIF:
+                $retVal = imagegif($this->resource, $filePath);
+                break;
+            case IMAGETYPE_JPEG:
+                $retVal = imagejpeg($this->resource, $filePath, $this->getJpegQuality());
+                break;
+            case IMAGETYPE_PNG:
+                $retVal = imagepng($this->resource, $filePath);
+                break;
+            case IMAGETYPE_XBM:
+                if (function_exists('imagexbm')) {
+                    $retVal = imagexbm($this->resource, $filePath);
+                } else {
+                    throw new Exception('\OC_Image::_output(): imagexbm() is not supported.');
+                }
+
+                break;
+            case IMAGETYPE_WBMP:
+                $retVal = imagewbmp($this->resource, $filePath);
+                break;
+            case IMAGETYPE_BMP:
+                $retVal = imagebmp($this->resource, $filePath, $this->bitDepth);
+                break;
+            default:
+                $retVal = imagepng($this->resource, $filePath);
+        }
+        return $retVal;
+    }
+
+    /**
+     * Prints the image when called as $image().
+     */
+    public function __invoke() {
+        return $this->show();
+    }
+
+    /**
+     * @param resource Returns the image resource in any.
+     * @throws \InvalidArgumentException in case the supplied resource does not have the type "gd"
+     */
+    public function setResource($resource) {
+        // For PHP<8
+        if (is_resource($resource) && get_resource_type($resource) === 'gd') {
+            $this->resource = $resource;
+            return;
+        }
+        // PHP 8 has real objects for GD stuff
+        if (is_object($resource) && get_class($resource) === 'GdImage') {
+            $this->resource = $resource;
+            return;
+        }
+        throw new \InvalidArgumentException('Supplied resource is not of type "gd".');
+    }
+
+    /**
+     * @return resource Returns the image resource in any.
+     */
+    public function resource() {
+        return $this->resource;
+    }
+
+    /**
+     * @return string Returns the mimetype of the data. Returns the empty string
+     * if the data is not valid.
+     */
+    public function dataMimeType() {
+        if (!$this->valid()) {
+            return '';
+        }
+
+        switch ($this->mimeType) {
+            case 'image/png':
+            case 'image/jpeg':
+            case 'image/gif':
+                return $this->mimeType;
+            default:
+                return 'image/png';
+        }
+    }
+
+    /**
+     * @return null|string Returns the raw image data.
+     */
+    public function data() {
+        if (!$this->valid()) {
+            return null;
+        }
+        ob_start();
+        switch ($this->mimeType) {
+            case "image/png":
+                $res = imagepng($this->resource);
+                break;
+            case "image/jpeg":
+                $quality = $this->getJpegQuality();
+                if ($quality !== null) {
+                    $res = imagejpeg($this->resource, null, $quality);
+                } else {
+                    $res = imagejpeg($this->resource);
+                }
+                break;
+            case "image/gif":
+                $res = imagegif($this->resource);
+                break;
+            default:
+                $res = imagepng($this->resource);
+                $this->logger->info('OC_Image->data. Could not guess mime-type, defaulting to png', ['app' => 'core']);
+                break;
+        }
+        if (!$res) {
+            $this->logger->error('OC_Image->data. Error getting image data.', ['app' => 'core']);
+        }
+        return ob_get_clean();
+    }
+
+    /**
+     * @return string - base64 encoded, which is suitable for embedding in a VCard.
+     */
+    public function __toString() {
+        return base64_encode($this->data());
+    }
+
+    /**
+     * @return int|null
+     */
+    protected function getJpegQuality() {
+        $quality = $this->config->getAppValue('preview', 'jpeg_quality', 90);
+        if ($quality !== null) {
+            $quality = min(100, max(10, (int) $quality));
+        }
+        return $quality;
+    }
+
+    /**
+     * (I'm open for suggestions on better method name ;)
+     * Get the orientation based on EXIF data.
+     *
+     * @return int The orientation or -1 if no EXIF data is available.
+     */
+    public function getOrientation() {
+        if ($this->exif !== null) {
+            return $this->exif['Orientation'];
+        }
+
+        if ($this->imageType !== IMAGETYPE_JPEG) {
+            $this->logger->debug('OC_Image->fixOrientation() Image is not a JPEG.', ['app' => 'core']);
+            return -1;
+        }
+        if (!is_callable('exif_read_data')) {
+            $this->logger->debug('OC_Image->fixOrientation() Exif module not enabled.', ['app' => 'core']);
+            return -1;
+        }
+        if (!$this->valid()) {
+            $this->logger->debug('OC_Image->fixOrientation() No image loaded.', ['app' => 'core']);
+            return -1;
+        }
+        if (is_null($this->filePath) || !is_readable($this->filePath)) {
+            $this->logger->debug('OC_Image->fixOrientation() No readable file path set.', ['app' => 'core']);
+            return -1;
+        }
+        $exif = @exif_read_data($this->filePath, 'IFD0');
+        if (!$exif) {
+            return -1;
+        }
+        if (!isset($exif['Orientation'])) {
+            return -1;
+        }
+        $this->exif = $exif;
+        return $exif['Orientation'];
+    }
+
+    public function readExif($data) {
+        if (!is_callable('exif_read_data')) {
+            $this->logger->debug('OC_Image->fixOrientation() Exif module not enabled.', ['app' => 'core']);
+            return;
+        }
+        if (!$this->valid()) {
+            $this->logger->debug('OC_Image->fixOrientation() No image loaded.', ['app' => 'core']);
+            return;
+        }
+
+        $exif = @exif_read_data('data://image/jpeg;base64,' . base64_encode($data));
+        if (!$exif) {
+            return;
+        }
+        if (!isset($exif['Orientation'])) {
+            return;
+        }
+        $this->exif = $exif;
+    }
+
+    /**
+     * (I'm open for suggestions on better method name ;)
+     * Fixes orientation based on EXIF data.
+     *
+     * @return bool
+     */
+    public function fixOrientation() {
+        $o = $this->getOrientation();
+        $this->logger->debug('OC_Image->fixOrientation() Orientation: ' . $o, ['app' => 'core']);
+        $rotate = 0;
+        $flip = false;
+        switch ($o) {
+            case -1:
+                return false; //Nothing to fix
+            case 1:
+                $rotate = 0;
+                break;
+            case 2:
+                $rotate = 0;
+                $flip = true;
+                break;
+            case 3:
+                $rotate = 180;
+                break;
+            case 4:
+                $rotate = 180;
+                $flip = true;
+                break;
+            case 5:
+                $rotate = 90;
+                $flip = true;
+                break;
+            case 6:
+                $rotate = 270;
+                break;
+            case 7:
+                $rotate = 270;
+                $flip = true;
+                break;
+            case 8:
+                $rotate = 90;
+                break;
+        }
+        if ($flip && function_exists('imageflip')) {
+            imageflip($this->resource, IMG_FLIP_HORIZONTAL);
+        }
+        if ($rotate) {
+            $res = imagerotate($this->resource, $rotate, 0);
+            if ($res) {
+                if (imagealphablending($res, true)) {
+                    if (imagesavealpha($res, true)) {
+                        imagedestroy($this->resource);
+                        $this->resource = $res;
+                        return true;
+                    } else {
+                        $this->logger->debug('OC_Image->fixOrientation() Error during alpha-saving', ['app' => 'core']);
+                        return false;
+                    }
+                } else {
+                    $this->logger->debug('OC_Image->fixOrientation() Error during alpha-blending', ['app' => 'core']);
+                    return false;
+                }
+            } else {
+                $this->logger->debug('OC_Image->fixOrientation() Error during orientation fixing', ['app' => 'core']);
+                return false;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Loads an image from an open file handle.
+     * It is the responsibility of the caller to position the pointer at the correct place and to close the handle again.
+     *
+     * @param resource $handle
+     * @return resource|false An image resource or false on error
+     */
+    public function loadFromFileHandle($handle) {
+        $contents = stream_get_contents($handle);
+        if ($this->loadFromData($contents)) {
+            return $this->resource;
+        }
+        return false;
+    }
+
+    /**
+     * Loads an image from a local file.
+     *
+     * @param bool|string $imagePath The path to a local file.
+     * @return bool|resource An image resource or false on error
+     */
+    public function loadFromFile($imagePath = false) {
+        // exif_imagetype throws "read error!" if file is less than 12 byte
+        if (!@is_file($imagePath) || !file_exists($imagePath) || filesize($imagePath) < 12 || !is_readable($imagePath)) {
+            return false;
+        }
+        $iType = exif_imagetype($imagePath);
+        switch ($iType) {
+            case IMAGETYPE_GIF:
+                if (imagetypes() & IMG_GIF) {
+                    $this->resource = imagecreatefromgif($imagePath);
+                    // Preserve transparency
+                    imagealphablending($this->resource, true);
+                    imagesavealpha($this->resource, true);
+                } else {
+                    $this->logger->debug('OC_Image->loadFromFile, GIF images not supported: ' . $imagePath, ['app' => 'core']);
+                }
+                break;
+            case IMAGETYPE_JPEG:
+                if (imagetypes() & IMG_JPG) {
+                    if (getimagesize($imagePath) !== false) {
+                        $this->resource = @imagecreatefromjpeg($imagePath);
+                    } else {
+                        $this->logger->debug('OC_Image->loadFromFile, JPG image not valid: ' . $imagePath, ['app' => 'core']);
+                    }
+                } else {
+                    $this->logger->debug('OC_Image->loadFromFile, JPG images not supported: ' . $imagePath, ['app' => 'core']);
+                }
+                break;
+            case IMAGETYPE_PNG:
+                if (imagetypes() & IMG_PNG) {
+                    $this->resource = @imagecreatefrompng($imagePath);
+                    // Preserve transparency
+                    imagealphablending($this->resource, true);
+                    imagesavealpha($this->resource, true);
+                } else {
+                    $this->logger->debug('OC_Image->loadFromFile, PNG images not supported: ' . $imagePath, ['app' => 'core']);
+                }
+                break;
+            case IMAGETYPE_XBM:
+                if (imagetypes() & IMG_XPM) {
+                    $this->resource = @imagecreatefromxbm($imagePath);
+                } else {
+                    $this->logger->debug('OC_Image->loadFromFile, XBM/XPM images not supported: ' . $imagePath, ['app' => 'core']);
+                }
+                break;
+            case IMAGETYPE_WBMP:
+                if (imagetypes() & IMG_WBMP) {
+                    $this->resource = @imagecreatefromwbmp($imagePath);
+                } else {
+                    $this->logger->debug('OC_Image->loadFromFile, WBMP images not supported: ' . $imagePath, ['app' => 'core']);
+                }
+                break;
+            case IMAGETYPE_BMP:
+                $this->resource = $this->imagecreatefrombmp($imagePath);
+                break;
+            /*
 			case IMAGETYPE_TIFF_II: // (intel byte order)
 				break;
 			case IMAGETYPE_TIFF_MM: // (motorola byte order)
@@ -631,671 +631,671 @@ 
 			case IMAGETYPE_PSD:
 				break;
 			*/
-			default:
-
-				// this is mostly file created from encrypted file
-				$this->resource = imagecreatefromstring(\OC\Files\Filesystem::file_get_contents(\OC\Files\Filesystem::getLocalPath($imagePath)));
-				$iType = IMAGETYPE_PNG;
-				$this->logger->debug('OC_Image->loadFromFile, Default', ['app' => 'core']);
-				break;
-		}
-		if ($this->valid()) {
-			$this->imageType = $iType;
-			$this->mimeType = image_type_to_mime_type($iType);
-			$this->filePath = $imagePath;
-		}
-		return $this->resource;
-	}
-
-	/**
-	 * Loads an image from a string of data.
-	 *
-	 * @param string $str A string of image data as read from a file.
-	 * @return bool|resource An image resource or false on error
-	 */
-	public function loadFromData($str) {
-		if (is_resource($str)) {
-			return false;
-		}
-		$this->resource = @imagecreatefromstring($str);
-		if ($this->fileInfo) {
-			$this->mimeType = $this->fileInfo->buffer($str);
-		}
-		if (is_resource($this->resource)) {
-			imagealphablending($this->resource, false);
-			imagesavealpha($this->resource, true);
-		}
-
-		if (!$this->resource) {
-			$this->logger->debug('OC_Image->loadFromFile, could not load', ['app' => 'core']);
-			return false;
-		}
-		return $this->resource;
-	}
-
-	/**
-	 * Loads an image from a base64 encoded string.
-	 *
-	 * @param string $str A string base64 encoded string of image data.
-	 * @return bool|resource An image resource or false on error
-	 */
-	public function loadFromBase64($str) {
-		if (!is_string($str)) {
-			return false;
-		}
-		$data = base64_decode($str);
-		if ($data) { // try to load from string data
-			$this->resource = @imagecreatefromstring($data);
-			if ($this->fileInfo) {
-				$this->mimeType = $this->fileInfo->buffer($data);
-			}
-			if (!$this->resource) {
-				$this->logger->debug('OC_Image->loadFromBase64, could not load', ['app' => 'core']);
-				return false;
-			}
-			return $this->resource;
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Create a new image from file or URL
-	 *
-	 * @link http://www.programmierer-forum.de/function-imagecreatefrombmp-laeuft-mit-allen-bitraten-t143137.htm
-	 * @version 1.00
-	 * @param string $fileName <p>
-	 * Path to the BMP image.
-	 * </p>
-	 * @return bool|resource an image resource identifier on success, <b>FALSE</b> on errors.
-	 */
-	private function imagecreatefrombmp($fileName) {
-		if (!($fh = fopen($fileName, 'rb'))) {
-			$this->logger->warning('imagecreatefrombmp: Can not open ' . $fileName, ['app' => 'core']);
-			return false;
-		}
-		// read file header
-		$meta = unpack('vtype/Vfilesize/Vreserved/Voffset', fread($fh, 14));
-		// check for bitmap
-		if ($meta['type'] != 19778) {
-			fclose($fh);
-			$this->logger->warning('imagecreatefrombmp: Can not open ' . $fileName . ' is not a bitmap!', ['app' => 'core']);
-			return false;
-		}
-		// read image header
-		$meta += unpack('Vheadersize/Vwidth/Vheight/vplanes/vbits/Vcompression/Vimagesize/Vxres/Vyres/Vcolors/Vimportant', fread($fh, 40));
-		// read additional 16bit header
-		if ($meta['bits'] == 16) {
-			$meta += unpack('VrMask/VgMask/VbMask', fread($fh, 12));
-		}
-		// set bytes and padding
-		$meta['bytes'] = $meta['bits'] / 8;
-		$this->bitDepth = $meta['bits']; //remember the bit depth for the imagebmp call
-		$meta['decal'] = 4 - (4 * (($meta['width'] * $meta['bytes'] / 4) - floor($meta['width'] * $meta['bytes'] / 4)));
-		if ($meta['decal'] == 4) {
-			$meta['decal'] = 0;
-		}
-		// obtain imagesize
-		if ($meta['imagesize'] < 1) {
-			$meta['imagesize'] = $meta['filesize'] - $meta['offset'];
-			// in rare cases filesize is equal to offset so we need to read physical size
-			if ($meta['imagesize'] < 1) {
-				$meta['imagesize'] = @filesize($fileName) - $meta['offset'];
-				if ($meta['imagesize'] < 1) {
-					fclose($fh);
-					$this->logger->warning('imagecreatefrombmp: Can not obtain file size of ' . $fileName . ' is not a bitmap!', ['app' => 'core']);
-					return false;
-				}
-			}
-		}
-		// calculate colors
-		$meta['colors'] = !$meta['colors'] ? pow(2, $meta['bits']) : $meta['colors'];
-		// read color palette
-		$palette = [];
-		if ($meta['bits'] < 16) {
-			$palette = unpack('l' . $meta['colors'], fread($fh, $meta['colors'] * 4));
-			// in rare cases the color value is signed
-			if ($palette[1] < 0) {
-				foreach ($palette as $i => $color) {
-					$palette[$i] = $color + 16777216;
-				}
-			}
-		}
-		// create gd image
-		$im = imagecreatetruecolor($meta['width'], $meta['height']);
-		if ($im == false) {
-			fclose($fh);
-			$this->logger->warning(
-				'imagecreatefrombmp: imagecreatetruecolor failed for file "' . $fileName . '" with dimensions ' . $meta['width'] . 'x' . $meta['height'],
-				['app' => 'core']);
-			return false;
-		}
-
-		$data = fread($fh, $meta['imagesize']);
-		$p = 0;
-		$vide = chr(0);
-		$y = $meta['height'] - 1;
-		$error = 'imagecreatefrombmp: ' . $fileName . ' has not enough data!';
-		// loop through the image data beginning with the lower left corner
-		while ($y >= 0) {
-			$x = 0;
-			while ($x < $meta['width']) {
-				switch ($meta['bits']) {
-					case 32:
-					case 24:
-						if (!($part = substr($data, $p, 3))) {
-							$this->logger->warning($error, ['app' => 'core']);
-							return $im;
-						}
-						$color = @unpack('V', $part . $vide);
-						break;
-					case 16:
-						if (!($part = substr($data, $p, 2))) {
-							fclose($fh);
-							$this->logger->warning($error, ['app' => 'core']);
-							return $im;
-						}
-						$color = @unpack('v', $part);
-						$color[1] = (($color[1] & 0xf800) >> 8) * 65536 + (($color[1] & 0x07e0) >> 3) * 256 + (($color[1] & 0x001f) << 3);
-						break;
-					case 8:
-						$color = @unpack('n', $vide . ($data[$p] ?? ''));
-						$color[1] = isset($palette[$color[1] + 1]) ? $palette[$color[1] + 1] : $palette[1];
-						break;
-					case 4:
-						$color = @unpack('n', $vide . ($data[floor($p)] ?? ''));
-						$color[1] = ($p * 2) % 2 == 0 ? $color[1] >> 4 : $color[1] & 0x0F;
-						$color[1] = isset($palette[$color[1] + 1]) ? $palette[$color[1] + 1] : $palette[1];
-						break;
-					case 1:
-						$color = @unpack('n', $vide . ($data[floor($p)] ?? ''));
-						switch (($p * 8) % 8) {
-							case 0:
-								$color[1] = $color[1] >> 7;
-								break;
-							case 1:
-								$color[1] = ($color[1] & 0x40) >> 6;
-								break;
-							case 2:
-								$color[1] = ($color[1] & 0x20) >> 5;
-								break;
-							case 3:
-								$color[1] = ($color[1] & 0x10) >> 4;
-								break;
-							case 4:
-								$color[1] = ($color[1] & 0x8) >> 3;
-								break;
-							case 5:
-								$color[1] = ($color[1] & 0x4) >> 2;
-								break;
-							case 6:
-								$color[1] = ($color[1] & 0x2) >> 1;
-								break;
-							case 7:
-								$color[1] = ($color[1] & 0x1);
-								break;
-						}
-						$color[1] = isset($palette[$color[1] + 1]) ? $palette[$color[1] + 1] : $palette[1];
-						break;
-					default:
-						fclose($fh);
-						$this->logger->warning('imagecreatefrombmp: ' . $fileName . ' has ' . $meta['bits'] . ' bits and this is not supported!', ['app' => 'core']);
-						return false;
-				}
-				imagesetpixel($im, $x, $y, $color[1]);
-				$x++;
-				$p += $meta['bytes'];
-			}
-			$y--;
-			$p += $meta['decal'];
-		}
-		fclose($fh);
-		return $im;
-	}
-
-	/**
-	 * Resizes the image preserving ratio.
-	 *
-	 * @param integer $maxSize The maximum size of either the width or height.
-	 * @return bool
-	 */
-	public function resize($maxSize) {
-		$result = $this->resizeNew($maxSize);
-		imagedestroy($this->resource);
-		$this->resource = $result;
-		return is_resource($result);
-	}
-
-	/**
-	 * @param $maxSize
-	 * @return resource | bool
-	 */
-	private function resizeNew($maxSize) {
-		if (!$this->valid()) {
-			$this->logger->error(__METHOD__ . '(): No image loaded', ['app' => 'core']);
-			return false;
-		}
-		$widthOrig = imagesx($this->resource);
-		$heightOrig = imagesy($this->resource);
-		$ratioOrig = $widthOrig / $heightOrig;
-
-		if ($ratioOrig > 1) {
-			$newHeight = round($maxSize / $ratioOrig);
-			$newWidth = $maxSize;
-		} else {
-			$newWidth = round($maxSize * $ratioOrig);
-			$newHeight = $maxSize;
-		}
-
-		return $this->preciseResizeNew((int)round($newWidth), (int)round($newHeight));
-	}
-
-	/**
-	 * @param int $width
-	 * @param int $height
-	 * @return bool
-	 */
-	public function preciseResize(int $width, int $height): bool {
-		$result = $this->preciseResizeNew($width, $height);
-		imagedestroy($this->resource);
-		$this->resource = $result;
-		return is_resource($result);
-	}
-
-
-	/**
-	 * @param int $width
-	 * @param int $height
-	 * @return resource | bool
-	 */
-	public function preciseResizeNew(int $width, int $height) {
-		if (!$this->valid()) {
-			$this->logger->error(__METHOD__ . '(): No image loaded', ['app' => 'core']);
-			return false;
-		}
-		$widthOrig = imagesx($this->resource);
-		$heightOrig = imagesy($this->resource);
-		$process = imagecreatetruecolor($width, $height);
-		if ($process === false) {
-			$this->logger->error(__METHOD__ . '(): Error creating true color image', ['app' => 'core']);
-			return false;
-		}
-
-		// preserve transparency
-		if ($this->imageType == IMAGETYPE_GIF or $this->imageType == IMAGETYPE_PNG) {
-			imagecolortransparent($process, imagecolorallocatealpha($process, 0, 0, 0, 127));
-			imagealphablending($process, false);
-			imagesavealpha($process, true);
-		}
-
-		$res = imagecopyresampled($process, $this->resource, 0, 0, 0, 0, $width, $height, $widthOrig, $heightOrig);
-		if ($res === false) {
-			$this->logger->error(__METHOD__ . '(): Error re-sampling process image', ['app' => 'core']);
-			imagedestroy($process);
-			return false;
-		}
-		return $process;
-	}
-
-	/**
-	 * Crops the image to the middle square. If the image is already square it just returns.
-	 *
-	 * @param int $size maximum size for the result (optional)
-	 * @return bool for success or failure
-	 */
-	public function centerCrop($size = 0) {
-		if (!$this->valid()) {
-			$this->logger->error('OC_Image->centerCrop, No image loaded', ['app' => 'core']);
-			return false;
-		}
-		$widthOrig = imagesx($this->resource);
-		$heightOrig = imagesy($this->resource);
-		if ($widthOrig === $heightOrig and $size == 0) {
-			return true;
-		}
-		$ratioOrig = $widthOrig / $heightOrig;
-		$width = $height = min($widthOrig, $heightOrig);
-
-		if ($ratioOrig > 1) {
-			$x = ($widthOrig / 2) - ($width / 2);
-			$y = 0;
-		} else {
-			$y = ($heightOrig / 2) - ($height / 2);
-			$x = 0;
-		}
-		if ($size > 0) {
-			$targetWidth = $size;
-			$targetHeight = $size;
-		} else {
-			$targetWidth = $width;
-			$targetHeight = $height;
-		}
-		$process = imagecreatetruecolor($targetWidth, $targetHeight);
-		if ($process == false) {
-			$this->logger->error('OC_Image->centerCrop, Error creating true color image', ['app' => 'core']);
-			imagedestroy($process);
-			return false;
-		}
-
-		// preserve transparency
-		if ($this->imageType == IMAGETYPE_GIF or $this->imageType == IMAGETYPE_PNG) {
-			imagecolortransparent($process, imagecolorallocatealpha($process, 0, 0, 0, 127));
-			imagealphablending($process, false);
-			imagesavealpha($process, true);
-		}
-
-		imagecopyresampled($process, $this->resource, 0, 0, $x, $y, $targetWidth, $targetHeight, $width, $height);
-		if ($process == false) {
-			$this->logger->error('OC_Image->centerCrop, Error re-sampling process image ' . $width . 'x' . $height, ['app' => 'core']);
-			imagedestroy($process);
-			return false;
-		}
-		imagedestroy($this->resource);
-		$this->resource = $process;
-		return true;
-	}
-
-	/**
-	 * Crops the image from point $x$y with dimension $wx$h.
-	 *
-	 * @param int $x Horizontal position
-	 * @param int $y Vertical position
-	 * @param int $w Width
-	 * @param int $h Height
-	 * @return bool for success or failure
-	 */
-	public function crop(int $x, int $y, int $w, int $h): bool {
-		$result = $this->cropNew($x, $y, $w, $h);
-		imagedestroy($this->resource);
-		$this->resource = $result;
-		return is_resource($result);
-	}
-
-	/**
-	 * Crops the image from point $x$y with dimension $wx$h.
-	 *
-	 * @param int $x Horizontal position
-	 * @param int $y Vertical position
-	 * @param int $w Width
-	 * @param int $h Height
-	 * @return resource | bool
-	 */
-	public function cropNew(int $x, int $y, int $w, int $h) {
-		if (!$this->valid()) {
-			$this->logger->error(__METHOD__ . '(): No image loaded', ['app' => 'core']);
-			return false;
-		}
-		$process = imagecreatetruecolor($w, $h);
-		if ($process == false) {
-			$this->logger->error(__METHOD__ . '(): Error creating true color image', ['app' => 'core']);
-			imagedestroy($process);
-			return false;
-		}
-
-		// preserve transparency
-		if ($this->imageType == IMAGETYPE_GIF or $this->imageType == IMAGETYPE_PNG) {
-			imagecolortransparent($process, imagecolorallocatealpha($process, 0, 0, 0, 127));
-			imagealphablending($process, false);
-			imagesavealpha($process, true);
-		}
-
-		imagecopyresampled($process, $this->resource, 0, 0, $x, $y, $w, $h, $w, $h);
-		if ($process == false) {
-			$this->logger->error(__METHOD__ . '(): Error re-sampling process image ' . $w . 'x' . $h, ['app' => 'core']);
-			imagedestroy($process);
-			return false;
-		}
-		return $process;
-	}
-
-	/**
-	 * Resizes the image to fit within a boundary while preserving ratio.
-	 *
-	 * Warning: Images smaller than $maxWidth x $maxHeight will end up being scaled up
-	 *
-	 * @param integer $maxWidth
-	 * @param integer $maxHeight
-	 * @return bool
-	 */
-	public function fitIn($maxWidth, $maxHeight) {
-		if (!$this->valid()) {
-			$this->logger->error(__METHOD__ . '(): No image loaded', ['app' => 'core']);
-			return false;
-		}
-		$widthOrig = imagesx($this->resource);
-		$heightOrig = imagesy($this->resource);
-		$ratio = $widthOrig / $heightOrig;
-
-		$newWidth = min($maxWidth, $ratio * $maxHeight);
-		$newHeight = min($maxHeight, $maxWidth / $ratio);
-
-		$this->preciseResize((int)round($newWidth), (int)round($newHeight));
-		return true;
-	}
-
-	/**
-	 * Shrinks larger images to fit within specified boundaries while preserving ratio.
-	 *
-	 * @param integer $maxWidth
-	 * @param integer $maxHeight
-	 * @return bool
-	 */
-	public function scaleDownToFit($maxWidth, $maxHeight) {
-		if (!$this->valid()) {
-			$this->logger->error(__METHOD__ . '(): No image loaded', ['app' => 'core']);
-			return false;
-		}
-		$widthOrig = imagesx($this->resource);
-		$heightOrig = imagesy($this->resource);
-
-		if ($widthOrig > $maxWidth || $heightOrig > $maxHeight) {
-			return $this->fitIn($maxWidth, $maxHeight);
-		}
-
-		return false;
-	}
-
-	public function copy(): IImage {
-		$image = new OC_Image(null, $this->logger, $this->config);
-		$image->resource = imagecreatetruecolor($this->width(), $this->height());
-		imagecopy(
-			$image->resource(),
-			$this->resource(),
-			0,
-			0,
-			0,
-			0,
-			$this->width(),
-			$this->height()
-		);
-
-		return $image;
-	}
-
-	public function cropCopy(int $x, int $y, int $w, int $h): IImage {
-		$image = new OC_Image(null, $this->logger, $this->config);
-		$image->imageType = $this->imageType;
-		$image->mimeType = $this->mimeType;
-		$image->bitDepth = $this->bitDepth;
-		$image->resource = $this->cropNew($x, $y, $w, $h);
-
-		return $image;
-	}
-
-	public function preciseResizeCopy(int $width, int $height): IImage {
-		$image = new OC_Image(null, $this->logger, $this->config);
-		$image->imageType = $this->imageType;
-		$image->mimeType = $this->mimeType;
-		$image->bitDepth = $this->bitDepth;
-		$image->resource = $this->preciseResizeNew($width, $height);
-
-		return $image;
-	}
-
-	public function resizeCopy(int $maxSize): IImage {
-		$image = new OC_Image(null, $this->logger, $this->config);
-		$image->imageType = $this->imageType;
-		$image->mimeType = $this->mimeType;
-		$image->bitDepth = $this->bitDepth;
-		$image->resource = $this->resizeNew($maxSize);
-
-		return $image;
-	}
-
-
-	/**
-	 * Resizes the image preserving ratio, returning a new copy
-	 *
-	 * @param integer $maxSize The maximum size of either the width or height.
-	 * @return bool
-	 */
-	public function copyResize($maxSize): IImage {
-	}
-
-	/**
-	 * Destroys the current image and resets the object
-	 */
-	public function destroy() {
-		if ($this->valid()) {
-			imagedestroy($this->resource);
-		}
-		$this->resource = null;
-	}
-
-	public function __destruct() {
-		$this->destroy();
-	}
+            default:
+
+                // this is mostly file created from encrypted file
+                $this->resource = imagecreatefromstring(\OC\Files\Filesystem::file_get_contents(\OC\Files\Filesystem::getLocalPath($imagePath)));
+                $iType = IMAGETYPE_PNG;
+                $this->logger->debug('OC_Image->loadFromFile, Default', ['app' => 'core']);
+                break;
+        }
+        if ($this->valid()) {
+            $this->imageType = $iType;
+            $this->mimeType = image_type_to_mime_type($iType);
+            $this->filePath = $imagePath;
+        }
+        return $this->resource;
+    }
+
+    /**
+     * Loads an image from a string of data.
+     *
+     * @param string $str A string of image data as read from a file.
+     * @return bool|resource An image resource or false on error
+     */
+    public function loadFromData($str) {
+        if (is_resource($str)) {
+            return false;
+        }
+        $this->resource = @imagecreatefromstring($str);
+        if ($this->fileInfo) {
+            $this->mimeType = $this->fileInfo->buffer($str);
+        }
+        if (is_resource($this->resource)) {
+            imagealphablending($this->resource, false);
+            imagesavealpha($this->resource, true);
+        }
+
+        if (!$this->resource) {
+            $this->logger->debug('OC_Image->loadFromFile, could not load', ['app' => 'core']);
+            return false;
+        }
+        return $this->resource;
+    }
+
+    /**
+     * Loads an image from a base64 encoded string.
+     *
+     * @param string $str A string base64 encoded string of image data.
+     * @return bool|resource An image resource or false on error
+     */
+    public function loadFromBase64($str) {
+        if (!is_string($str)) {
+            return false;
+        }
+        $data = base64_decode($str);
+        if ($data) { // try to load from string data
+            $this->resource = @imagecreatefromstring($data);
+            if ($this->fileInfo) {
+                $this->mimeType = $this->fileInfo->buffer($data);
+            }
+            if (!$this->resource) {
+                $this->logger->debug('OC_Image->loadFromBase64, could not load', ['app' => 'core']);
+                return false;
+            }
+            return $this->resource;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Create a new image from file or URL
+     *
+     * @link http://www.programmierer-forum.de/function-imagecreatefrombmp-laeuft-mit-allen-bitraten-t143137.htm
+     * @version 1.00
+     * @param string $fileName <p>
+     * Path to the BMP image.
+     * </p>
+     * @return bool|resource an image resource identifier on success, <b>FALSE</b> on errors.
+     */
+    private function imagecreatefrombmp($fileName) {
+        if (!($fh = fopen($fileName, 'rb'))) {
+            $this->logger->warning('imagecreatefrombmp: Can not open ' . $fileName, ['app' => 'core']);
+            return false;
+        }
+        // read file header
+        $meta = unpack('vtype/Vfilesize/Vreserved/Voffset', fread($fh, 14));
+        // check for bitmap
+        if ($meta['type'] != 19778) {
+            fclose($fh);
+            $this->logger->warning('imagecreatefrombmp: Can not open ' . $fileName . ' is not a bitmap!', ['app' => 'core']);
+            return false;
+        }
+        // read image header
+        $meta += unpack('Vheadersize/Vwidth/Vheight/vplanes/vbits/Vcompression/Vimagesize/Vxres/Vyres/Vcolors/Vimportant', fread($fh, 40));
+        // read additional 16bit header
+        if ($meta['bits'] == 16) {
+            $meta += unpack('VrMask/VgMask/VbMask', fread($fh, 12));
+        }
+        // set bytes and padding
+        $meta['bytes'] = $meta['bits'] / 8;
+        $this->bitDepth = $meta['bits']; //remember the bit depth for the imagebmp call
+        $meta['decal'] = 4 - (4 * (($meta['width'] * $meta['bytes'] / 4) - floor($meta['width'] * $meta['bytes'] / 4)));
+        if ($meta['decal'] == 4) {
+            $meta['decal'] = 0;
+        }
+        // obtain imagesize
+        if ($meta['imagesize'] < 1) {
+            $meta['imagesize'] = $meta['filesize'] - $meta['offset'];
+            // in rare cases filesize is equal to offset so we need to read physical size
+            if ($meta['imagesize'] < 1) {
+                $meta['imagesize'] = @filesize($fileName) - $meta['offset'];
+                if ($meta['imagesize'] < 1) {
+                    fclose($fh);
+                    $this->logger->warning('imagecreatefrombmp: Can not obtain file size of ' . $fileName . ' is not a bitmap!', ['app' => 'core']);
+                    return false;
+                }
+            }
+        }
+        // calculate colors
+        $meta['colors'] = !$meta['colors'] ? pow(2, $meta['bits']) : $meta['colors'];
+        // read color palette
+        $palette = [];
+        if ($meta['bits'] < 16) {
+            $palette = unpack('l' . $meta['colors'], fread($fh, $meta['colors'] * 4));
+            // in rare cases the color value is signed
+            if ($palette[1] < 0) {
+                foreach ($palette as $i => $color) {
+                    $palette[$i] = $color + 16777216;
+                }
+            }
+        }
+        // create gd image
+        $im = imagecreatetruecolor($meta['width'], $meta['height']);
+        if ($im == false) {
+            fclose($fh);
+            $this->logger->warning(
+                'imagecreatefrombmp: imagecreatetruecolor failed for file "' . $fileName . '" with dimensions ' . $meta['width'] . 'x' . $meta['height'],
+                ['app' => 'core']);
+            return false;
+        }
+
+        $data = fread($fh, $meta['imagesize']);
+        $p = 0;
+        $vide = chr(0);
+        $y = $meta['height'] - 1;
+        $error = 'imagecreatefrombmp: ' . $fileName . ' has not enough data!';
+        // loop through the image data beginning with the lower left corner
+        while ($y >= 0) {
+            $x = 0;
+            while ($x < $meta['width']) {
+                switch ($meta['bits']) {
+                    case 32:
+                    case 24:
+                        if (!($part = substr($data, $p, 3))) {
+                            $this->logger->warning($error, ['app' => 'core']);
+                            return $im;
+                        }
+                        $color = @unpack('V', $part . $vide);
+                        break;
+                    case 16:
+                        if (!($part = substr($data, $p, 2))) {
+                            fclose($fh);
+                            $this->logger->warning($error, ['app' => 'core']);
+                            return $im;
+                        }
+                        $color = @unpack('v', $part);
+                        $color[1] = (($color[1] & 0xf800) >> 8) * 65536 + (($color[1] & 0x07e0) >> 3) * 256 + (($color[1] & 0x001f) << 3);
+                        break;
+                    case 8:
+                        $color = @unpack('n', $vide . ($data[$p] ?? ''));
+                        $color[1] = isset($palette[$color[1] + 1]) ? $palette[$color[1] + 1] : $palette[1];
+                        break;
+                    case 4:
+                        $color = @unpack('n', $vide . ($data[floor($p)] ?? ''));
+                        $color[1] = ($p * 2) % 2 == 0 ? $color[1] >> 4 : $color[1] & 0x0F;
+                        $color[1] = isset($palette[$color[1] + 1]) ? $palette[$color[1] + 1] : $palette[1];
+                        break;
+                    case 1:
+                        $color = @unpack('n', $vide . ($data[floor($p)] ?? ''));
+                        switch (($p * 8) % 8) {
+                            case 0:
+                                $color[1] = $color[1] >> 7;
+                                break;
+                            case 1:
+                                $color[1] = ($color[1] & 0x40) >> 6;
+                                break;
+                            case 2:
+                                $color[1] = ($color[1] & 0x20) >> 5;
+                                break;
+                            case 3:
+                                $color[1] = ($color[1] & 0x10) >> 4;
+                                break;
+                            case 4:
+                                $color[1] = ($color[1] & 0x8) >> 3;
+                                break;
+                            case 5:
+                                $color[1] = ($color[1] & 0x4) >> 2;
+                                break;
+                            case 6:
+                                $color[1] = ($color[1] & 0x2) >> 1;
+                                break;
+                            case 7:
+                                $color[1] = ($color[1] & 0x1);
+                                break;
+                        }
+                        $color[1] = isset($palette[$color[1] + 1]) ? $palette[$color[1] + 1] : $palette[1];
+                        break;
+                    default:
+                        fclose($fh);
+                        $this->logger->warning('imagecreatefrombmp: ' . $fileName . ' has ' . $meta['bits'] . ' bits and this is not supported!', ['app' => 'core']);
+                        return false;
+                }
+                imagesetpixel($im, $x, $y, $color[1]);
+                $x++;
+                $p += $meta['bytes'];
+            }
+            $y--;
+            $p += $meta['decal'];
+        }
+        fclose($fh);
+        return $im;
+    }
+
+    /**
+     * Resizes the image preserving ratio.
+     *
+     * @param integer $maxSize The maximum size of either the width or height.
+     * @return bool
+     */
+    public function resize($maxSize) {
+        $result = $this->resizeNew($maxSize);
+        imagedestroy($this->resource);
+        $this->resource = $result;
+        return is_resource($result);
+    }
+
+    /**
+     * @param $maxSize
+     * @return resource | bool
+     */
+    private function resizeNew($maxSize) {
+        if (!$this->valid()) {
+            $this->logger->error(__METHOD__ . '(): No image loaded', ['app' => 'core']);
+            return false;
+        }
+        $widthOrig = imagesx($this->resource);
+        $heightOrig = imagesy($this->resource);
+        $ratioOrig = $widthOrig / $heightOrig;
+
+        if ($ratioOrig > 1) {
+            $newHeight = round($maxSize / $ratioOrig);
+            $newWidth = $maxSize;
+        } else {
+            $newWidth = round($maxSize * $ratioOrig);
+            $newHeight = $maxSize;
+        }
+
+        return $this->preciseResizeNew((int)round($newWidth), (int)round($newHeight));
+    }
+
+    /**
+     * @param int $width
+     * @param int $height
+     * @return bool
+     */
+    public function preciseResize(int $width, int $height): bool {
+        $result = $this->preciseResizeNew($width, $height);
+        imagedestroy($this->resource);
+        $this->resource = $result;
+        return is_resource($result);
+    }
+
+
+    /**
+     * @param int $width
+     * @param int $height
+     * @return resource | bool
+     */
+    public function preciseResizeNew(int $width, int $height) {
+        if (!$this->valid()) {
+            $this->logger->error(__METHOD__ . '(): No image loaded', ['app' => 'core']);
+            return false;
+        }
+        $widthOrig = imagesx($this->resource);
+        $heightOrig = imagesy($this->resource);
+        $process = imagecreatetruecolor($width, $height);
+        if ($process === false) {
+            $this->logger->error(__METHOD__ . '(): Error creating true color image', ['app' => 'core']);
+            return false;
+        }
+
+        // preserve transparency
+        if ($this->imageType == IMAGETYPE_GIF or $this->imageType == IMAGETYPE_PNG) {
+            imagecolortransparent($process, imagecolorallocatealpha($process, 0, 0, 0, 127));
+            imagealphablending($process, false);
+            imagesavealpha($process, true);
+        }
+
+        $res = imagecopyresampled($process, $this->resource, 0, 0, 0, 0, $width, $height, $widthOrig, $heightOrig);
+        if ($res === false) {
+            $this->logger->error(__METHOD__ . '(): Error re-sampling process image', ['app' => 'core']);
+            imagedestroy($process);
+            return false;
+        }
+        return $process;
+    }
+
+    /**
+     * Crops the image to the middle square. If the image is already square it just returns.
+     *
+     * @param int $size maximum size for the result (optional)
+     * @return bool for success or failure
+     */
+    public function centerCrop($size = 0) {
+        if (!$this->valid()) {
+            $this->logger->error('OC_Image->centerCrop, No image loaded', ['app' => 'core']);
+            return false;
+        }
+        $widthOrig = imagesx($this->resource);
+        $heightOrig = imagesy($this->resource);
+        if ($widthOrig === $heightOrig and $size == 0) {
+            return true;
+        }
+        $ratioOrig = $widthOrig / $heightOrig;
+        $width = $height = min($widthOrig, $heightOrig);
+
+        if ($ratioOrig > 1) {
+            $x = ($widthOrig / 2) - ($width / 2);
+            $y = 0;
+        } else {
+            $y = ($heightOrig / 2) - ($height / 2);
+            $x = 0;
+        }
+        if ($size > 0) {
+            $targetWidth = $size;
+            $targetHeight = $size;
+        } else {
+            $targetWidth = $width;
+            $targetHeight = $height;
+        }
+        $process = imagecreatetruecolor($targetWidth, $targetHeight);
+        if ($process == false) {
+            $this->logger->error('OC_Image->centerCrop, Error creating true color image', ['app' => 'core']);
+            imagedestroy($process);
+            return false;
+        }
+
+        // preserve transparency
+        if ($this->imageType == IMAGETYPE_GIF or $this->imageType == IMAGETYPE_PNG) {
+            imagecolortransparent($process, imagecolorallocatealpha($process, 0, 0, 0, 127));
+            imagealphablending($process, false);
+            imagesavealpha($process, true);
+        }
+
+        imagecopyresampled($process, $this->resource, 0, 0, $x, $y, $targetWidth, $targetHeight, $width, $height);
+        if ($process == false) {
+            $this->logger->error('OC_Image->centerCrop, Error re-sampling process image ' . $width . 'x' . $height, ['app' => 'core']);
+            imagedestroy($process);
+            return false;
+        }
+        imagedestroy($this->resource);
+        $this->resource = $process;
+        return true;
+    }
+
+    /**
+     * Crops the image from point $x$y with dimension $wx$h.
+     *
+     * @param int $x Horizontal position
+     * @param int $y Vertical position
+     * @param int $w Width
+     * @param int $h Height
+     * @return bool for success or failure
+     */
+    public function crop(int $x, int $y, int $w, int $h): bool {
+        $result = $this->cropNew($x, $y, $w, $h);
+        imagedestroy($this->resource);
+        $this->resource = $result;
+        return is_resource($result);
+    }
+
+    /**
+     * Crops the image from point $x$y with dimension $wx$h.
+     *
+     * @param int $x Horizontal position
+     * @param int $y Vertical position
+     * @param int $w Width
+     * @param int $h Height
+     * @return resource | bool
+     */
+    public function cropNew(int $x, int $y, int $w, int $h) {
+        if (!$this->valid()) {
+            $this->logger->error(__METHOD__ . '(): No image loaded', ['app' => 'core']);
+            return false;
+        }
+        $process = imagecreatetruecolor($w, $h);
+        if ($process == false) {
+            $this->logger->error(__METHOD__ . '(): Error creating true color image', ['app' => 'core']);
+            imagedestroy($process);
+            return false;
+        }
+
+        // preserve transparency
+        if ($this->imageType == IMAGETYPE_GIF or $this->imageType == IMAGETYPE_PNG) {
+            imagecolortransparent($process, imagecolorallocatealpha($process, 0, 0, 0, 127));
+            imagealphablending($process, false);
+            imagesavealpha($process, true);
+        }
+
+        imagecopyresampled($process, $this->resource, 0, 0, $x, $y, $w, $h, $w, $h);
+        if ($process == false) {
+            $this->logger->error(__METHOD__ . '(): Error re-sampling process image ' . $w . 'x' . $h, ['app' => 'core']);
+            imagedestroy($process);
+            return false;
+        }
+        return $process;
+    }
+
+    /**
+     * Resizes the image to fit within a boundary while preserving ratio.
+     *
+     * Warning: Images smaller than $maxWidth x $maxHeight will end up being scaled up
+     *
+     * @param integer $maxWidth
+     * @param integer $maxHeight
+     * @return bool
+     */
+    public function fitIn($maxWidth, $maxHeight) {
+        if (!$this->valid()) {
+            $this->logger->error(__METHOD__ . '(): No image loaded', ['app' => 'core']);
+            return false;
+        }
+        $widthOrig = imagesx($this->resource);
+        $heightOrig = imagesy($this->resource);
+        $ratio = $widthOrig / $heightOrig;
+
+        $newWidth = min($maxWidth, $ratio * $maxHeight);
+        $newHeight = min($maxHeight, $maxWidth / $ratio);
+
+        $this->preciseResize((int)round($newWidth), (int)round($newHeight));
+        return true;
+    }
+
+    /**
+     * Shrinks larger images to fit within specified boundaries while preserving ratio.
+     *
+     * @param integer $maxWidth
+     * @param integer $maxHeight
+     * @return bool
+     */
+    public function scaleDownToFit($maxWidth, $maxHeight) {
+        if (!$this->valid()) {
+            $this->logger->error(__METHOD__ . '(): No image loaded', ['app' => 'core']);
+            return false;
+        }
+        $widthOrig = imagesx($this->resource);
+        $heightOrig = imagesy($this->resource);
+
+        if ($widthOrig > $maxWidth || $heightOrig > $maxHeight) {
+            return $this->fitIn($maxWidth, $maxHeight);
+        }
+
+        return false;
+    }
+
+    public function copy(): IImage {
+        $image = new OC_Image(null, $this->logger, $this->config);
+        $image->resource = imagecreatetruecolor($this->width(), $this->height());
+        imagecopy(
+            $image->resource(),
+            $this->resource(),
+            0,
+            0,
+            0,
+            0,
+            $this->width(),
+            $this->height()
+        );
+
+        return $image;
+    }
+
+    public function cropCopy(int $x, int $y, int $w, int $h): IImage {
+        $image = new OC_Image(null, $this->logger, $this->config);
+        $image->imageType = $this->imageType;
+        $image->mimeType = $this->mimeType;
+        $image->bitDepth = $this->bitDepth;
+        $image->resource = $this->cropNew($x, $y, $w, $h);
+
+        return $image;
+    }
+
+    public function preciseResizeCopy(int $width, int $height): IImage {
+        $image = new OC_Image(null, $this->logger, $this->config);
+        $image->imageType = $this->imageType;
+        $image->mimeType = $this->mimeType;
+        $image->bitDepth = $this->bitDepth;
+        $image->resource = $this->preciseResizeNew($width, $height);
+
+        return $image;
+    }
+
+    public function resizeCopy(int $maxSize): IImage {
+        $image = new OC_Image(null, $this->logger, $this->config);
+        $image->imageType = $this->imageType;
+        $image->mimeType = $this->mimeType;
+        $image->bitDepth = $this->bitDepth;
+        $image->resource = $this->resizeNew($maxSize);
+
+        return $image;
+    }
+
+
+    /**
+     * Resizes the image preserving ratio, returning a new copy
+     *
+     * @param integer $maxSize The maximum size of either the width or height.
+     * @return bool
+     */
+    public function copyResize($maxSize): IImage {
+    }
+
+    /**
+     * Destroys the current image and resets the object
+     */
+    public function destroy() {
+        if ($this->valid()) {
+            imagedestroy($this->resource);
+        }
+        $this->resource = null;
+    }
+
+    public function __destruct() {
+        $this->destroy();
+    }
 }
 
 if (!function_exists('imagebmp')) {
-	/**
-	 * Output a BMP image to either the browser or a file
-	 *
-	 * @link http://www.ugia.cn/wp-data/imagebmp.php
-	 * @author legend <legendsky@hotmail.com>
-	 * @link http://www.programmierer-forum.de/imagebmp-gute-funktion-gefunden-t143716.htm
-	 * @author mgutt <marc@gutt.it>
-	 * @version 1.00
-	 * @param resource $im
-	 * @param string $fileName [optional] <p>The path to save the file to.</p>
-	 * @param int $bit [optional] <p>Bit depth, (default is 24).</p>
-	 * @param int $compression [optional]
-	 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
-	 */
-	function imagebmp($im, $fileName = '', $bit = 24, $compression = 0) {
-		if (!in_array($bit, [1, 4, 8, 16, 24, 32])) {
-			$bit = 24;
-		} elseif ($bit == 32) {
-			$bit = 24;
-		}
-		$bits = (int)pow(2, $bit);
-		imagetruecolortopalette($im, true, $bits);
-		$width = imagesx($im);
-		$height = imagesy($im);
-		$colorsNum = imagecolorstotal($im);
-		$rgbQuad = '';
-		if ($bit <= 8) {
-			for ($i = 0; $i < $colorsNum; $i++) {
-				$colors = imagecolorsforindex($im, $i);
-				$rgbQuad .= chr($colors['blue']) . chr($colors['green']) . chr($colors['red']) . "\0";
-			}
-			$bmpData = '';
-			if ($compression == 0 || $bit < 8) {
-				$compression = 0;
-				$extra = '';
-				$padding = 4 - ceil($width / (8 / $bit)) % 4;
-				if ($padding % 4 != 0) {
-					$extra = str_repeat("\0", $padding);
-				}
-				for ($j = $height - 1; $j >= 0; $j--) {
-					$i = 0;
-					while ($i < $width) {
-						$bin = 0;
-						$limit = $width - $i < 8 / $bit ? (8 / $bit - $width + $i) * $bit : 0;
-						for ($k = 8 - $bit; $k >= $limit; $k -= $bit) {
-							$index = imagecolorat($im, $i, $j);
-							$bin |= $index << $k;
-							$i++;
-						}
-						$bmpData .= chr($bin);
-					}
-					$bmpData .= $extra;
-				}
-			} // RLE8
-			elseif ($compression == 1 && $bit == 8) {
-				for ($j = $height - 1; $j >= 0; $j--) {
-					$lastIndex = null;
-					$sameNum = 0;
-					for ($i = 0; $i <= $width; $i++) {
-						$index = imagecolorat($im, $i, $j);
-						if ($index !== $lastIndex || $sameNum > 255) {
-							if ($sameNum != 0) {
-								$bmpData .= chr($sameNum) . chr($lastIndex);
-							}
-							$lastIndex = $index;
-							$sameNum = 1;
-						} else {
-							$sameNum++;
-						}
-					}
-					$bmpData .= "\0\0";
-				}
-				$bmpData .= "\0\1";
-			}
-			$sizeQuad = strlen($rgbQuad);
-			$sizeData = strlen($bmpData);
-		} else {
-			$extra = '';
-			$padding = 4 - ($width * ($bit / 8)) % 4;
-			if ($padding % 4 != 0) {
-				$extra = str_repeat("\0", $padding);
-			}
-			$bmpData = '';
-			for ($j = $height - 1; $j >= 0; $j--) {
-				for ($i = 0; $i < $width; $i++) {
-					$index = imagecolorat($im, $i, $j);
-					$colors = imagecolorsforindex($im, $index);
-					if ($bit == 16) {
-						$bin = 0 << $bit;
-						$bin |= ($colors['red'] >> 3) << 10;
-						$bin |= ($colors['green'] >> 3) << 5;
-						$bin |= $colors['blue'] >> 3;
-						$bmpData .= pack("v", $bin);
-					} else {
-						$bmpData .= pack("c*", $colors['blue'], $colors['green'], $colors['red']);
-					}
-				}
-				$bmpData .= $extra;
-			}
-			$sizeQuad = 0;
-			$sizeData = strlen($bmpData);
-			$colorsNum = 0;
-		}
-		$fileHeader = 'BM' . pack('V3', 54 + $sizeQuad + $sizeData, 0, 54 + $sizeQuad);
-		$infoHeader = pack('V3v2V*', 0x28, $width, $height, 1, $bit, $compression, $sizeData, 0, 0, $colorsNum, 0);
-		if ($fileName != '') {
-			$fp = fopen($fileName, 'wb');
-			fwrite($fp, $fileHeader . $infoHeader . $rgbQuad . $bmpData);
-			fclose($fp);
-			return true;
-		}
-		echo $fileHeader . $infoHeader . $rgbQuad . $bmpData;
-		return true;
-	}
+    /**
+     * Output a BMP image to either the browser or a file
+     *
+     * @link http://www.ugia.cn/wp-data/imagebmp.php
+     * @author legend <legendsky@hotmail.com>
+     * @link http://www.programmierer-forum.de/imagebmp-gute-funktion-gefunden-t143716.htm
+     * @author mgutt <marc@gutt.it>
+     * @version 1.00
+     * @param resource $im
+     * @param string $fileName [optional] <p>The path to save the file to.</p>
+     * @param int $bit [optional] <p>Bit depth, (default is 24).</p>
+     * @param int $compression [optional]
+     * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+     */
+    function imagebmp($im, $fileName = '', $bit = 24, $compression = 0) {
+        if (!in_array($bit, [1, 4, 8, 16, 24, 32])) {
+            $bit = 24;
+        } elseif ($bit == 32) {
+            $bit = 24;
+        }
+        $bits = (int)pow(2, $bit);
+        imagetruecolortopalette($im, true, $bits);
+        $width = imagesx($im);
+        $height = imagesy($im);
+        $colorsNum = imagecolorstotal($im);
+        $rgbQuad = '';
+        if ($bit <= 8) {
+            for ($i = 0; $i < $colorsNum; $i++) {
+                $colors = imagecolorsforindex($im, $i);
+                $rgbQuad .= chr($colors['blue']) . chr($colors['green']) . chr($colors['red']) . "\0";
+            }
+            $bmpData = '';
+            if ($compression == 0 || $bit < 8) {
+                $compression = 0;
+                $extra = '';
+                $padding = 4 - ceil($width / (8 / $bit)) % 4;
+                if ($padding % 4 != 0) {
+                    $extra = str_repeat("\0", $padding);
+                }
+                for ($j = $height - 1; $j >= 0; $j--) {
+                    $i = 0;
+                    while ($i < $width) {
+                        $bin = 0;
+                        $limit = $width - $i < 8 / $bit ? (8 / $bit - $width + $i) * $bit : 0;
+                        for ($k = 8 - $bit; $k >= $limit; $k -= $bit) {
+                            $index = imagecolorat($im, $i, $j);
+                            $bin |= $index << $k;
+                            $i++;
+                        }
+                        $bmpData .= chr($bin);
+                    }
+                    $bmpData .= $extra;
+                }
+            } // RLE8
+            elseif ($compression == 1 && $bit == 8) {
+                for ($j = $height - 1; $j >= 0; $j--) {
+                    $lastIndex = null;
+                    $sameNum = 0;
+                    for ($i = 0; $i <= $width; $i++) {
+                        $index = imagecolorat($im, $i, $j);
+                        if ($index !== $lastIndex || $sameNum > 255) {
+                            if ($sameNum != 0) {
+                                $bmpData .= chr($sameNum) . chr($lastIndex);
+                            }
+                            $lastIndex = $index;
+                            $sameNum = 1;
+                        } else {
+                            $sameNum++;
+                        }
+                    }
+                    $bmpData .= "\0\0";
+                }
+                $bmpData .= "\0\1";
+            }
+            $sizeQuad = strlen($rgbQuad);
+            $sizeData = strlen($bmpData);
+        } else {
+            $extra = '';
+            $padding = 4 - ($width * ($bit / 8)) % 4;
+            if ($padding % 4 != 0) {
+                $extra = str_repeat("\0", $padding);
+            }
+            $bmpData = '';
+            for ($j = $height - 1; $j >= 0; $j--) {
+                for ($i = 0; $i < $width; $i++) {
+                    $index = imagecolorat($im, $i, $j);
+                    $colors = imagecolorsforindex($im, $index);
+                    if ($bit == 16) {
+                        $bin = 0 << $bit;
+                        $bin |= ($colors['red'] >> 3) << 10;
+                        $bin |= ($colors['green'] >> 3) << 5;
+                        $bin |= $colors['blue'] >> 3;
+                        $bmpData .= pack("v", $bin);
+                    } else {
+                        $bmpData .= pack("c*", $colors['blue'], $colors['green'], $colors['red']);
+                    }
+                }
+                $bmpData .= $extra;
+            }
+            $sizeQuad = 0;
+            $sizeData = strlen($bmpData);
+            $colorsNum = 0;
+        }
+        $fileHeader = 'BM' . pack('V3', 54 + $sizeQuad + $sizeData, 0, 54 + $sizeQuad);
+        $infoHeader = pack('V3v2V*', 0x28, $width, $height, 1, $bit, $compression, $sizeData, 0, 0, $colorsNum, 0);
+        if ($fileName != '') {
+            $fp = fopen($fileName, 'wb');
+            fwrite($fp, $fileHeader . $infoHeader . $rgbQuad . $bmpData);
+            fclose($fp);
+            return true;
+        }
+        echo $fileHeader . $infoHeader . $rgbQuad . $bmpData;
+        return true;
+    }
 }
 
 if (!function_exists('exif_imagetype')) {
-	/**
-	 * Workaround if exif_imagetype does not exist
-	 *
-	 * @link https://www.php.net/manual/en/function.exif-imagetype.php#80383
-	 * @param string $fileName
-	 * @return string|boolean
-	 */
-	function exif_imagetype($fileName) {
-		if (($info = getimagesize($fileName)) !== false) {
-			return $info[2];
-		}
-		return false;
-	}
+    /**
+     * Workaround if exif_imagetype does not exist
+     *
+     * @link https://www.php.net/manual/en/function.exif-imagetype.php#80383
+     * @param string $fileName
+     * @return string|boolean
+     */
+    function exif_imagetype($fileName) {
+        if (($info = getimagesize($fileName)) !== false) {
+            return $info[2];
+        }
+        return false;
+    }
 }

lib/private/legacy/OC_Helper.php

Indentation +559 added lines, -559 removed lines

@@ -50,563 +50,563 @@
  * Collection of useful functions
  */
 class OC_Helper {
-	private static $templateManager;
-
-	/**
-	 * Make a human file size
-	 * @param int $bytes file size in bytes
-	 * @return string a human readable file size
-	 *
-	 * Makes 2048 to 2 kB.
-	 */
-	public static function humanFileSize($bytes) {
-		if ($bytes < 0) {
-			return "?";
-		}
-		if ($bytes < 1024) {
-			return "$bytes B";
-		}
-		$bytes = round($bytes / 1024, 0);
-		if ($bytes < 1024) {
-			return "$bytes KB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes MB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes GB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes TB";
-		}
-
-		$bytes = round($bytes / 1024, 1);
-		return "$bytes PB";
-	}
-
-	/**
-	 * Make a computer file size
-	 * @param string $str file size in human readable format
-	 * @return float|bool a file size in bytes
-	 *
-	 * Makes 2kB to 2048.
-	 *
-	 * Inspired by: https://www.php.net/manual/en/function.filesize.php#92418
-	 */
-	public static function computerFileSize($str) {
-		$str = strtolower($str);
-		if (is_numeric($str)) {
-			return (float)$str;
-		}
-
-		$bytes_array = [
-			'b' => 1,
-			'k' => 1024,
-			'kb' => 1024,
-			'mb' => 1024 * 1024,
-			'm' => 1024 * 1024,
-			'gb' => 1024 * 1024 * 1024,
-			'g' => 1024 * 1024 * 1024,
-			'tb' => 1024 * 1024 * 1024 * 1024,
-			't' => 1024 * 1024 * 1024 * 1024,
-			'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
-			'p' => 1024 * 1024 * 1024 * 1024 * 1024,
-		];
-
-		$bytes = (float)$str;
-
-		if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && !empty($bytes_array[$matches[1]])) {
-			$bytes *= $bytes_array[$matches[1]];
-		} else {
-			return false;
-		}
-
-		$bytes = round($bytes);
-
-		return $bytes;
-	}
-
-	/**
-	 * Recursive copying of folders
-	 * @param string $src source folder
-	 * @param string $dest target folder
-	 *
-	 */
-	public static function copyr($src, $dest) {
-		if (is_dir($src)) {
-			if (!is_dir($dest)) {
-				mkdir($dest);
-			}
-			$files = scandir($src);
-			foreach ($files as $file) {
-				if ($file != "." && $file != "..") {
-					self::copyr("$src/$file", "$dest/$file");
-				}
-			}
-		} elseif (file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) {
-			copy($src, $dest);
-		}
-	}
-
-	/**
-	 * Recursive deletion of folders
-	 * @param string $dir path to the folder
-	 * @param bool $deleteSelf if set to false only the content of the folder will be deleted
-	 * @return bool
-	 */
-	public static function rmdirr($dir, $deleteSelf = true) {
-		if (is_dir($dir)) {
-			$files = new RecursiveIteratorIterator(
-				new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
-				RecursiveIteratorIterator::CHILD_FIRST
-			);
-
-			foreach ($files as $fileInfo) {
-				/** @var SplFileInfo $fileInfo */
-				if ($fileInfo->isLink()) {
-					unlink($fileInfo->getPathname());
-				} elseif ($fileInfo->isDir()) {
-					rmdir($fileInfo->getRealPath());
-				} else {
-					unlink($fileInfo->getRealPath());
-				}
-			}
-			if ($deleteSelf) {
-				rmdir($dir);
-			}
-		} elseif (file_exists($dir)) {
-			if ($deleteSelf) {
-				unlink($dir);
-			}
-		}
-		if (!$deleteSelf) {
-			return true;
-		}
-
-		return !file_exists($dir);
-	}
-
-	/**
-	 * @deprecated 18.0.0
-	 * @return \OC\Files\Type\TemplateManager
-	 */
-	public static function getFileTemplateManager() {
-		if (!self::$templateManager) {
-			self::$templateManager = new \OC\Files\Type\TemplateManager();
-		}
-		return self::$templateManager;
-	}
-
-	/**
-	 * detect if a given program is found in the search PATH
-	 *
-	 * @param string $name
-	 * @param bool $path
-	 * @internal param string $program name
-	 * @internal param string $optional search path, defaults to $PATH
-	 * @return bool    true if executable program found in path
-	 */
-	public static function canExecute($name, $path = false) {
-		// path defaults to PATH from environment if not set
-		if ($path === false) {
-			$path = getenv("PATH");
-		}
-		// we look for an executable file of that name
-		$exts = [""];
-		$check_fn = "is_executable";
-		// Default check will be done with $path directories :
-		$dirs = explode(PATH_SEPARATOR, $path);
-		// WARNING : We have to check if open_basedir is enabled :
-		$obd = OC::$server->get(IniGetWrapper::class)->getString('open_basedir');
-		if ($obd != "none") {
-			$obd_values = explode(PATH_SEPARATOR, $obd);
-			if (count($obd_values) > 0 and $obd_values[0]) {
-				// open_basedir is in effect !
-				// We need to check if the program is in one of these dirs :
-				$dirs = $obd_values;
-			}
-		}
-		foreach ($dirs as $dir) {
-			foreach ($exts as $ext) {
-				if ($check_fn("$dir/$name" . $ext)) {
-					return true;
-				}
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * copy the contents of one stream to another
-	 *
-	 * @param resource $source
-	 * @param resource $target
-	 * @return array the number of bytes copied and result
-	 */
-	public static function streamCopy($source, $target) {
-		if (!$source or !$target) {
-			return [0, false];
-		}
-		$bufSize = 8192;
-		$result = true;
-		$count = 0;
-		while (!feof($source)) {
-			$buf = fread($source, $bufSize);
-			$bytesWritten = fwrite($target, $buf);
-			if ($bytesWritten !== false) {
-				$count += $bytesWritten;
-			}
-			// note: strlen is expensive so only use it when necessary,
-			// on the last block
-			if ($bytesWritten === false
-				|| ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
-			) {
-				// write error, could be disk full ?
-				$result = false;
-				break;
-			}
-		}
-		return [$count, $result];
-	}
-
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 *
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 */
-	public static function buildNotExistingFileName($path, $filename) {
-		$view = \OC\Files\Filesystem::getView();
-		return self::buildNotExistingFileNameForView($path, $filename, $view);
-	}
-
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 *
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 */
-	public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
-		if ($path === '/') {
-			$path = '';
-		}
-		if ($pos = strrpos($filename, '.')) {
-			$name = substr($filename, 0, $pos);
-			$ext = substr($filename, $pos);
-		} else {
-			$name = $filename;
-			$ext = '';
-		}
-
-		$newpath = $path . '/' . $filename;
-		if ($view->file_exists($newpath)) {
-			if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
-				//Replace the last "(number)" with "(number+1)"
-				$last_match = count($matches[0]) - 1;
-				$counter = $matches[1][$last_match][0] + 1;
-				$offset = $matches[0][$last_match][1];
-				$match_length = strlen($matches[0][$last_match][0]);
-			} else {
-				$counter = 2;
-				$match_length = 0;
-				$offset = false;
-			}
-			do {
-				if ($offset) {
-					//Replace the last "(number)" with "(number+1)"
-					$newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
-				} else {
-					$newname = $name . ' (' . $counter . ')';
-				}
-				$newpath = $path . '/' . $newname . $ext;
-				$counter++;
-			} while ($view->file_exists($newpath));
-		}
-
-		return $newpath;
-	}
-
-	/**
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 *
-	 * @param array $input The array to work on
-	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
-	 *
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 * based on https://www.php.net/manual/en/function.array-change-key-case.php#107715
-	 *
-	 */
-	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
-		$case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
-		$ret = [];
-		foreach ($input as $k => $v) {
-			$ret[mb_convert_case($k, $case, $encoding)] = $v;
-		}
-		return $ret;
-	}
-
-	/**
-	 * performs a search in a nested array
-	 * @param array $haystack the array to be searched
-	 * @param string $needle the search string
-	 * @param mixed $index optional, only search this key name
-	 * @return mixed the key of the matching field, otherwise false
-	 *
-	 * performs a search in a nested array
-	 *
-	 * taken from https://www.php.net/manual/en/function.array-search.php#97645
-	 */
-	public static function recursiveArraySearch($haystack, $needle, $index = null) {
-		$aIt = new RecursiveArrayIterator($haystack);
-		$it = new RecursiveIteratorIterator($aIt);
-
-		while ($it->valid()) {
-			if (((isset($index) and ($it->key() == $index)) or !isset($index)) and ($it->current() == $needle)) {
-				return $aIt->key();
-			}
-
-			$it->next();
-		}
-
-		return false;
-	}
-
-	/**
-	 * calculates the maximum upload size respecting system settings, free space and user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
-	 * @return int number of bytes representing
-	 */
-	public static function maxUploadFilesize($dir, $freeSpace = null) {
-		if (is_null($freeSpace) || $freeSpace < 0) {
-			$freeSpace = self::freeSpace($dir);
-		}
-		return min($freeSpace, self::uploadLimit());
-	}
-
-	/**
-	 * Calculate free space left within user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @return int number of bytes representing
-	 */
-	public static function freeSpace($dir) {
-		$freeSpace = \OC\Files\Filesystem::free_space($dir);
-		if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-			$freeSpace = max($freeSpace, 0);
-			return $freeSpace;
-		} else {
-			return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
-		}
-	}
-
-	/**
-	 * Calculate PHP upload limit
-	 *
-	 * @return int PHP upload file size limit
-	 */
-	public static function uploadLimit() {
-		$ini = \OC::$server->get(IniGetWrapper::class);
-		$upload_max_filesize = OCP\Util::computerFileSize($ini->get('upload_max_filesize'));
-		$post_max_size = OCP\Util::computerFileSize($ini->get('post_max_size'));
-		if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
-			return INF;
-		} elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
-			return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
-		} else {
-			return min($upload_max_filesize, $post_max_size);
-		}
-	}
-
-	/**
-	 * Checks if a function is available
-	 *
-	 * @param string $function_name
-	 * @return bool
-	 */
-	public static function is_function_enabled($function_name) {
-		if (!function_exists($function_name)) {
-			return false;
-		}
-		$ini = \OC::$server->get(IniGetWrapper::class);
-		$disabled = explode(',', $ini->get('disable_functions') ?: '');
-		$disabled = array_map('trim', $disabled);
-		if (in_array($function_name, $disabled)) {
-			return false;
-		}
-		$disabled = explode(',', $ini->get('suhosin.executor.func.blacklist') ?: '');
-		$disabled = array_map('trim', $disabled);
-		if (in_array($function_name, $disabled)) {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * Try to find a program
-	 *
-	 * @param string $program
-	 * @return null|string
-	 */
-	public static function findBinaryPath($program) {
-		$memcache = \OC::$server->getMemCacheFactory()->createDistributed('findBinaryPath');
-		if ($memcache->hasKey($program)) {
-			return $memcache->get($program);
-		}
-		$result = null;
-		if (self::is_function_enabled('exec')) {
-			$exeSniffer = new ExecutableFinder();
-			// Returns null if nothing is found
-			$result = $exeSniffer->find($program, null, ['/usr/local/sbin', '/usr/local/bin', '/usr/sbin', '/usr/bin', '/sbin', '/bin', '/opt/bin']);
-		}
-		// store the value for 5 minutes
-		$memcache->set($program, $result, 300);
-		return $result;
-	}
-
-	/**
-	 * Calculate the disc space for the given path
-	 *
-	 * BEWARE: this requires that Util::setupFS() was called
-	 * already !
-	 *
-	 * @param string $path
-	 * @param \OCP\Files\FileInfo $rootInfo (optional)
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	public static function getStorageInfo($path, $rootInfo = null) {
-		// return storage info without adding mount points
-		$includeExtStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
-
-		if (!$rootInfo) {
-			$rootInfo = \OC\Files\Filesystem::getFileInfo($path, $includeExtStorage ? 'ext' : false);
-		}
-		if (!$rootInfo instanceof \OCP\Files\FileInfo) {
-			throw new \OCP\Files\NotFoundException();
-		}
-		$used = $rootInfo->getSize();
-		if ($used < 0) {
-			$used = 0;
-		}
-		$quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
-		$mount = $rootInfo->getMountPoint();
-		$storage = $mount->getStorage();
-		$sourceStorage = $storage;
-		if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
-			$includeExtStorage = false;
-			$sourceStorage = $storage->getSourceStorage();
-		}
-		if ($includeExtStorage) {
-			if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
-				|| $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
-			) {
-				/** @var \OC\Files\Storage\Home $storage */
-				$user = $storage->getUser();
-			} else {
-				$user = \OC::$server->getUserSession()->getUser();
-			}
-			$quota = OC_Util::getUserQuota($user);
-			if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-				// always get free space / total space from root + mount points
-				return self::getGlobalStorageInfo($quota);
-			}
-		}
-
-		// TODO: need a better way to get total space from storage
-		if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
-			/** @var \OC\Files\Storage\Wrapper\Quota $storage */
-			$quota = $sourceStorage->getQuota();
-		}
-		$free = $sourceStorage->free_space($rootInfo->getInternalPath());
-		if ($free >= 0) {
-			$total = $free + $used;
-		} else {
-			$total = $free; //either unknown or unlimited
-		}
-		if ($total > 0) {
-			if ($quota > 0 && $total > $quota) {
-				$total = $quota;
-			}
-			// prevent division by zero or error codes (negative values)
-			$relative = round(($used / $total) * 10000) / 100;
-		} else {
-			$relative = 0;
-		}
-
-		$ownerId = $storage->getOwner($path);
-		$ownerDisplayName = '';
-		$owner = \OC::$server->getUserManager()->get($ownerId);
-		if ($owner) {
-			$ownerDisplayName = $owner->getDisplayName();
-		}
-		if (substr_count($mount->getMountPoint(), '/') < 3) {
-			$mountPoint = '';
-		} else {
-			[,,,$mountPoint] = explode('/', $mount->getMountPoint(), 4);
-		}
-
-		return [
-			'free' => $free,
-			'used' => $used,
-			'quota' => $quota,
-			'total' => $total,
-			'relative' => $relative,
-			'owner' => $ownerId,
-			'ownerDisplayName' => $ownerDisplayName,
-			'mountType' => $mount->getMountType(),
-			'mountPoint' => trim($mountPoint, '/'),
-		];
-	}
-
-	/**
-	 * Get storage info including all mount points and quota
-	 *
-	 * @param int $quota
-	 * @return array
-	 */
-	private static function getGlobalStorageInfo($quota) {
-		$rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
-		$used = $rootInfo['size'];
-		if ($used < 0) {
-			$used = 0;
-		}
-
-		$total = $quota;
-		$free = $quota - $used;
-
-		if ($total > 0) {
-			if ($quota > 0 && $total > $quota) {
-				$total = $quota;
-			}
-			// prevent division by zero or error codes (negative values)
-			$relative = round(($used / $total) * 10000) / 100;
-		} else {
-			$relative = 0;
-		}
-
-		return [
-			'free' => $free,
-			'used' => $used,
-			'total' => $total,
-			'relative' => $relative,
-			'quota' => $quota
-		];
-	}
-
-	/**
-	 * Returns whether the config file is set manually to read-only
-	 * @return bool
-	 */
-	public static function isReadOnlyConfigEnabled() {
-		return \OC::$server->getConfig()->getSystemValue('config_is_read_only', false);
-	}
+    private static $templateManager;
+
+    /**
+     * Make a human file size
+     * @param int $bytes file size in bytes
+     * @return string a human readable file size
+     *
+     * Makes 2048 to 2 kB.
+     */
+    public static function humanFileSize($bytes) {
+        if ($bytes < 0) {
+            return "?";
+        }
+        if ($bytes < 1024) {
+            return "$bytes B";
+        }
+        $bytes = round($bytes / 1024, 0);
+        if ($bytes < 1024) {
+            return "$bytes KB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes MB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes GB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes TB";
+        }
+
+        $bytes = round($bytes / 1024, 1);
+        return "$bytes PB";
+    }
+
+    /**
+     * Make a computer file size
+     * @param string $str file size in human readable format
+     * @return float|bool a file size in bytes
+     *
+     * Makes 2kB to 2048.
+     *
+     * Inspired by: https://www.php.net/manual/en/function.filesize.php#92418
+     */
+    public static function computerFileSize($str) {
+        $str = strtolower($str);
+        if (is_numeric($str)) {
+            return (float)$str;
+        }
+
+        $bytes_array = [
+            'b' => 1,
+            'k' => 1024,
+            'kb' => 1024,
+            'mb' => 1024 * 1024,
+            'm' => 1024 * 1024,
+            'gb' => 1024 * 1024 * 1024,
+            'g' => 1024 * 1024 * 1024,
+            'tb' => 1024 * 1024 * 1024 * 1024,
+            't' => 1024 * 1024 * 1024 * 1024,
+            'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
+            'p' => 1024 * 1024 * 1024 * 1024 * 1024,
+        ];
+
+        $bytes = (float)$str;
+
+        if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && !empty($bytes_array[$matches[1]])) {
+            $bytes *= $bytes_array[$matches[1]];
+        } else {
+            return false;
+        }
+
+        $bytes = round($bytes);
+
+        return $bytes;
+    }
+
+    /**
+     * Recursive copying of folders
+     * @param string $src source folder
+     * @param string $dest target folder
+     *
+     */
+    public static function copyr($src, $dest) {
+        if (is_dir($src)) {
+            if (!is_dir($dest)) {
+                mkdir($dest);
+            }
+            $files = scandir($src);
+            foreach ($files as $file) {
+                if ($file != "." && $file != "..") {
+                    self::copyr("$src/$file", "$dest/$file");
+                }
+            }
+        } elseif (file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) {
+            copy($src, $dest);
+        }
+    }
+
+    /**
+     * Recursive deletion of folders
+     * @param string $dir path to the folder
+     * @param bool $deleteSelf if set to false only the content of the folder will be deleted
+     * @return bool
+     */
+    public static function rmdirr($dir, $deleteSelf = true) {
+        if (is_dir($dir)) {
+            $files = new RecursiveIteratorIterator(
+                new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
+                RecursiveIteratorIterator::CHILD_FIRST
+            );
+
+            foreach ($files as $fileInfo) {
+                /** @var SplFileInfo $fileInfo */
+                if ($fileInfo->isLink()) {
+                    unlink($fileInfo->getPathname());
+                } elseif ($fileInfo->isDir()) {
+                    rmdir($fileInfo->getRealPath());
+                } else {
+                    unlink($fileInfo->getRealPath());
+                }
+            }
+            if ($deleteSelf) {
+                rmdir($dir);
+            }
+        } elseif (file_exists($dir)) {
+            if ($deleteSelf) {
+                unlink($dir);
+            }
+        }
+        if (!$deleteSelf) {
+            return true;
+        }
+
+        return !file_exists($dir);
+    }
+
+    /**
+     * @deprecated 18.0.0
+     * @return \OC\Files\Type\TemplateManager
+     */
+    public static function getFileTemplateManager() {
+        if (!self::$templateManager) {
+            self::$templateManager = new \OC\Files\Type\TemplateManager();
+        }
+        return self::$templateManager;
+    }
+
+    /**
+     * detect if a given program is found in the search PATH
+     *
+     * @param string $name
+     * @param bool $path
+     * @internal param string $program name
+     * @internal param string $optional search path, defaults to $PATH
+     * @return bool    true if executable program found in path
+     */
+    public static function canExecute($name, $path = false) {
+        // path defaults to PATH from environment if not set
+        if ($path === false) {
+            $path = getenv("PATH");
+        }
+        // we look for an executable file of that name
+        $exts = [""];
+        $check_fn = "is_executable";
+        // Default check will be done with $path directories :
+        $dirs = explode(PATH_SEPARATOR, $path);
+        // WARNING : We have to check if open_basedir is enabled :
+        $obd = OC::$server->get(IniGetWrapper::class)->getString('open_basedir');
+        if ($obd != "none") {
+            $obd_values = explode(PATH_SEPARATOR, $obd);
+            if (count($obd_values) > 0 and $obd_values[0]) {
+                // open_basedir is in effect !
+                // We need to check if the program is in one of these dirs :
+                $dirs = $obd_values;
+            }
+        }
+        foreach ($dirs as $dir) {
+            foreach ($exts as $ext) {
+                if ($check_fn("$dir/$name" . $ext)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * copy the contents of one stream to another
+     *
+     * @param resource $source
+     * @param resource $target
+     * @return array the number of bytes copied and result
+     */
+    public static function streamCopy($source, $target) {
+        if (!$source or !$target) {
+            return [0, false];
+        }
+        $bufSize = 8192;
+        $result = true;
+        $count = 0;
+        while (!feof($source)) {
+            $buf = fread($source, $bufSize);
+            $bytesWritten = fwrite($target, $buf);
+            if ($bytesWritten !== false) {
+                $count += $bytesWritten;
+            }
+            // note: strlen is expensive so only use it when necessary,
+            // on the last block
+            if ($bytesWritten === false
+                || ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
+            ) {
+                // write error, could be disk full ?
+                $result = false;
+                break;
+            }
+        }
+        return [$count, $result];
+    }
+
+    /**
+     * Adds a suffix to the name in case the file exists
+     *
+     * @param string $path
+     * @param string $filename
+     * @return string
+     */
+    public static function buildNotExistingFileName($path, $filename) {
+        $view = \OC\Files\Filesystem::getView();
+        return self::buildNotExistingFileNameForView($path, $filename, $view);
+    }
+
+    /**
+     * Adds a suffix to the name in case the file exists
+     *
+     * @param string $path
+     * @param string $filename
+     * @return string
+     */
+    public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
+        if ($path === '/') {
+            $path = '';
+        }
+        if ($pos = strrpos($filename, '.')) {
+            $name = substr($filename, 0, $pos);
+            $ext = substr($filename, $pos);
+        } else {
+            $name = $filename;
+            $ext = '';
+        }
+
+        $newpath = $path . '/' . $filename;
+        if ($view->file_exists($newpath)) {
+            if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
+                //Replace the last "(number)" with "(number+1)"
+                $last_match = count($matches[0]) - 1;
+                $counter = $matches[1][$last_match][0] + 1;
+                $offset = $matches[0][$last_match][1];
+                $match_length = strlen($matches[0][$last_match][0]);
+            } else {
+                $counter = 2;
+                $match_length = 0;
+                $offset = false;
+            }
+            do {
+                if ($offset) {
+                    //Replace the last "(number)" with "(number+1)"
+                    $newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
+                } else {
+                    $newname = $name . ' (' . $counter . ')';
+                }
+                $newpath = $path . '/' . $newname . $ext;
+                $counter++;
+            } while ($view->file_exists($newpath));
+        }
+
+        return $newpath;
+    }
+
+    /**
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     *
+     * @param array $input The array to work on
+     * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @return array
+     *
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     * based on https://www.php.net/manual/en/function.array-change-key-case.php#107715
+     *
+     */
+    public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
+        $case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
+        $ret = [];
+        foreach ($input as $k => $v) {
+            $ret[mb_convert_case($k, $case, $encoding)] = $v;
+        }
+        return $ret;
+    }
+
+    /**
+     * performs a search in a nested array
+     * @param array $haystack the array to be searched
+     * @param string $needle the search string
+     * @param mixed $index optional, only search this key name
+     * @return mixed the key of the matching field, otherwise false
+     *
+     * performs a search in a nested array
+     *
+     * taken from https://www.php.net/manual/en/function.array-search.php#97645
+     */
+    public static function recursiveArraySearch($haystack, $needle, $index = null) {
+        $aIt = new RecursiveArrayIterator($haystack);
+        $it = new RecursiveIteratorIterator($aIt);
+
+        while ($it->valid()) {
+            if (((isset($index) and ($it->key() == $index)) or !isset($index)) and ($it->current() == $needle)) {
+                return $aIt->key();
+            }
+
+            $it->next();
+        }
+
+        return false;
+    }
+
+    /**
+     * calculates the maximum upload size respecting system settings, free space and user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
+     * @return int number of bytes representing
+     */
+    public static function maxUploadFilesize($dir, $freeSpace = null) {
+        if (is_null($freeSpace) || $freeSpace < 0) {
+            $freeSpace = self::freeSpace($dir);
+        }
+        return min($freeSpace, self::uploadLimit());
+    }
+
+    /**
+     * Calculate free space left within user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @return int number of bytes representing
+     */
+    public static function freeSpace($dir) {
+        $freeSpace = \OC\Files\Filesystem::free_space($dir);
+        if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+            $freeSpace = max($freeSpace, 0);
+            return $freeSpace;
+        } else {
+            return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
+        }
+    }
+
+    /**
+     * Calculate PHP upload limit
+     *
+     * @return int PHP upload file size limit
+     */
+    public static function uploadLimit() {
+        $ini = \OC::$server->get(IniGetWrapper::class);
+        $upload_max_filesize = OCP\Util::computerFileSize($ini->get('upload_max_filesize'));
+        $post_max_size = OCP\Util::computerFileSize($ini->get('post_max_size'));
+        if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
+            return INF;
+        } elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
+            return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
+        } else {
+            return min($upload_max_filesize, $post_max_size);
+        }
+    }
+
+    /**
+     * Checks if a function is available
+     *
+     * @param string $function_name
+     * @return bool
+     */
+    public static function is_function_enabled($function_name) {
+        if (!function_exists($function_name)) {
+            return false;
+        }
+        $ini = \OC::$server->get(IniGetWrapper::class);
+        $disabled = explode(',', $ini->get('disable_functions') ?: '');
+        $disabled = array_map('trim', $disabled);
+        if (in_array($function_name, $disabled)) {
+            return false;
+        }
+        $disabled = explode(',', $ini->get('suhosin.executor.func.blacklist') ?: '');
+        $disabled = array_map('trim', $disabled);
+        if (in_array($function_name, $disabled)) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Try to find a program
+     *
+     * @param string $program
+     * @return null|string
+     */
+    public static function findBinaryPath($program) {
+        $memcache = \OC::$server->getMemCacheFactory()->createDistributed('findBinaryPath');
+        if ($memcache->hasKey($program)) {
+            return $memcache->get($program);
+        }
+        $result = null;
+        if (self::is_function_enabled('exec')) {
+            $exeSniffer = new ExecutableFinder();
+            // Returns null if nothing is found
+            $result = $exeSniffer->find($program, null, ['/usr/local/sbin', '/usr/local/bin', '/usr/sbin', '/usr/bin', '/sbin', '/bin', '/opt/bin']);
+        }
+        // store the value for 5 minutes
+        $memcache->set($program, $result, 300);
+        return $result;
+    }
+
+    /**
+     * Calculate the disc space for the given path
+     *
+     * BEWARE: this requires that Util::setupFS() was called
+     * already !
+     *
+     * @param string $path
+     * @param \OCP\Files\FileInfo $rootInfo (optional)
+     * @return array
+     * @throws \OCP\Files\NotFoundException
+     */
+    public static function getStorageInfo($path, $rootInfo = null) {
+        // return storage info without adding mount points
+        $includeExtStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
+
+        if (!$rootInfo) {
+            $rootInfo = \OC\Files\Filesystem::getFileInfo($path, $includeExtStorage ? 'ext' : false);
+        }
+        if (!$rootInfo instanceof \OCP\Files\FileInfo) {
+            throw new \OCP\Files\NotFoundException();
+        }
+        $used = $rootInfo->getSize();
+        if ($used < 0) {
+            $used = 0;
+        }
+        $quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
+        $mount = $rootInfo->getMountPoint();
+        $storage = $mount->getStorage();
+        $sourceStorage = $storage;
+        if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
+            $includeExtStorage = false;
+            $sourceStorage = $storage->getSourceStorage();
+        }
+        if ($includeExtStorage) {
+            if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
+                || $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
+            ) {
+                /** @var \OC\Files\Storage\Home $storage */
+                $user = $storage->getUser();
+            } else {
+                $user = \OC::$server->getUserSession()->getUser();
+            }
+            $quota = OC_Util::getUserQuota($user);
+            if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+                // always get free space / total space from root + mount points
+                return self::getGlobalStorageInfo($quota);
+            }
+        }
+
+        // TODO: need a better way to get total space from storage
+        if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
+            /** @var \OC\Files\Storage\Wrapper\Quota $storage */
+            $quota = $sourceStorage->getQuota();
+        }
+        $free = $sourceStorage->free_space($rootInfo->getInternalPath());
+        if ($free >= 0) {
+            $total = $free + $used;
+        } else {
+            $total = $free; //either unknown or unlimited
+        }
+        if ($total > 0) {
+            if ($quota > 0 && $total > $quota) {
+                $total = $quota;
+            }
+            // prevent division by zero or error codes (negative values)
+            $relative = round(($used / $total) * 10000) / 100;
+        } else {
+            $relative = 0;
+        }
+
+        $ownerId = $storage->getOwner($path);
+        $ownerDisplayName = '';
+        $owner = \OC::$server->getUserManager()->get($ownerId);
+        if ($owner) {
+            $ownerDisplayName = $owner->getDisplayName();
+        }
+        if (substr_count($mount->getMountPoint(), '/') < 3) {
+            $mountPoint = '';
+        } else {
+            [,,,$mountPoint] = explode('/', $mount->getMountPoint(), 4);
+        }
+
+        return [
+            'free' => $free,
+            'used' => $used,
+            'quota' => $quota,
+            'total' => $total,
+            'relative' => $relative,
+            'owner' => $ownerId,
+            'ownerDisplayName' => $ownerDisplayName,
+            'mountType' => $mount->getMountType(),
+            'mountPoint' => trim($mountPoint, '/'),
+        ];
+    }
+
+    /**
+     * Get storage info including all mount points and quota
+     *
+     * @param int $quota
+     * @return array
+     */
+    private static function getGlobalStorageInfo($quota) {
+        $rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
+        $used = $rootInfo['size'];
+        if ($used < 0) {
+            $used = 0;
+        }
+
+        $total = $quota;
+        $free = $quota - $used;
+
+        if ($total > 0) {
+            if ($quota > 0 && $total > $quota) {
+                $total = $quota;
+            }
+            // prevent division by zero or error codes (negative values)
+            $relative = round(($used / $total) * 10000) / 100;
+        } else {
+            $relative = 0;
+        }
+
+        return [
+            'free' => $free,
+            'used' => $used,
+            'total' => $total,
+            'relative' => $relative,
+            'quota' => $quota
+        ];
+    }
+
+    /**
+     * Returns whether the config file is set manually to read-only
+     * @return bool
+     */
+    public static function isReadOnlyConfigEnabled() {
+        return \OC::$server->getConfig()->getSystemValue('config_is_read_only', false);
+    }
 }

apps/settings/templates/settings/admin/server.php

Indentation +26 added lines, -26 removed lines

@@ -30,19 +30,19 @@ 
 	<h2 class="inlineblock"><?php p($l->t('Background jobs'));?></h2>
 	<p class="cronlog inlineblock">
 		<?php if ($_['lastcron'] !== false) {
-	$relative_time = relative_modified_date($_['lastcron']);
-	$maxAgeRelativeTime = relative_modified_date($_['cronMaxAge']);
+    $relative_time = relative_modified_date($_['lastcron']);
+    $maxAgeRelativeTime = relative_modified_date($_['cronMaxAge']);
 
-	$formatter = \OC::$server->getDateTimeFormatter();
-	$absolute_time = $formatter->formatDateTime($_['lastcron'], 'long', 'long');
-	$maxAgeAbsoluteTime = $formatter->formatDateTime($_['cronMaxAge'], 'long', 'long');
-	if (time() - $_['lastcron'] > 600) { ?>
+    $formatter = \OC::$server->getDateTimeFormatter();
+    $absolute_time = $formatter->formatDateTime($_['lastcron'], 'long', 'long');
+    $maxAgeAbsoluteTime = $formatter->formatDateTime($_['cronMaxAge'], 'long', 'long');
+    if (time() - $_['lastcron'] > 600) { ?>
 				<span class="status error"></span>
 				<span class="crondate" title="<?php p($absolute_time);?>">
 					<?php p($l->t("Last job execution ran %s. Something seems wrong.", [$relative_time]));?>
 				</span>
 			<?php } elseif (time() - $_['cronMaxAge'] > 12 * 3600) {
-		if ($_['backgroundjobs_mode'] === 'cron') { ?>
+        if ($_['backgroundjobs_mode'] === 'cron') { ?>
 						<span class="status warning"></span>
 						<span class="crondate" title="<?php p($maxAgeAbsoluteTime);?>">
 							<?php p($l->t("Some jobs haven’t been executed since %s. Please consider increasing the execution frequency.", [$maxAgeRelativeTime]));?>
@@ -53,7 +53,7 @@ 
 							<?php p($l->t("Some jobs didn’t execute since %s. Please consider switching to system cron.", [$maxAgeRelativeTime]));?>
 						</span>
 					<?php }
-	} else { ?>
+    } else { ?>
 				<span class="status success"></span>
 				<span class="crondate" title="<?php p($absolute_time);?>">
 					<?php p($l->t("Last job ran %s.", [$relative_time]));?>
@@ -62,7 +62,7 @@ 
 } else { ?>
 			<span class="status error"></span>
 			<?php p($l->t("Background job didn’t run yet!"));
-		} ?>
+        } ?>
 	</p>
 	<a target="_blank" rel="noreferrer noopener" class="icon-info"
 	   title="<?php p($l->t('Open documentation'));?>"
@@ -75,38 +75,38 @@ 
 			<p>
 				<input type="radio" name="mode" value="ajax" class="radio"
 					   id="backgroundjobs_ajax" <?php if ($_['backgroundjobs_mode'] === "ajax") {
-			print_unescaped('checked="checked"');
-		} ?>>
+            print_unescaped('checked="checked"');
+        } ?>>
 				<label for="backgroundjobs_ajax">AJAX</label><br/>
 				<em><?php p($l->t("Execute one task with each page loaded.")); ?></em>
 			</p>
 			<p>
 				<input type="radio" name="mode" value="webcron" class="radio"
 					   id="backgroundjobs_webcron" <?php if ($_['backgroundjobs_mode'] === "webcron") {
-			print_unescaped('checked="checked"');
-		} ?>>
+            print_unescaped('checked="checked"');
+        } ?>>
 				<label for="backgroundjobs_webcron">Webcron</label><br/>
 				<em><?php p($l->t("cron.php is registered at a webcron service to call cron.php every 5 minutes over HTTP.")); ?></em>
 			</p>
 			<p>
 				<input type="radio" name="mode" value="cron" class="radio"
 					   id="backgroundjobs_cron" <?php if ($_['backgroundjobs_mode'] === "cron") {
-			print_unescaped('checked="checked"');
-		}
-				if (!$_['cli_based_cron_possible']) {
-					print_unescaped('disabled');
-				}?>>
+            print_unescaped('checked="checked"');
+        }
+                if (!$_['cli_based_cron_possible']) {
+                    print_unescaped('disabled');
+                }?>>
 				<label for="backgroundjobs_cron">Cron</label><br/>
 				<em><?php p($l->t("Use system cron service to call the cron.php file every 5 minutes.")); ?>
 					<?php if ($_['cli_based_cron_possible']) {
-					p($l->t('The cron.php needs to be executed by the system user "%s".', [$_['cli_based_cron_user']]));
-				} else {
-					print_unescaped(str_replace(
-							['{linkstart}', '{linkend}'],
-							['<a href="https://www.php.net/manual/en/book.posix.php">', ' ↗</a>'],
-							$l->t('To run this you need the PHP POSIX extension. See {linkstart}PHP documentation{linkend} for more details.')
-						));
-				} ?></em>
+                    p($l->t('The cron.php needs to be executed by the system user "%s".', [$_['cli_based_cron_user']]));
+                } else {
+                    print_unescaped(str_replace(
+                            ['{linkstart}', '{linkend}'],
+                            ['<a href="https://www.php.net/manual/en/book.posix.php">', ' ↗</a>'],
+                            $l->t('To run this you need the PHP POSIX extension. See {linkstart}PHP documentation{linkend} for more details.')
+                        ));
+                } ?></em>
 
 			</p>
 		</fieldset>