nextcloud / server

lib/private/Cache/File.php

Indentation +157 added lines, -157 removed lines

@@ -38,170 +38,170 @@
 
 class File implements ICache {
 
-	/** @var View */
-	protected $storage;
+    /** @var View */
+    protected $storage;
 
-	/**
-	 * Returns the cache storage for the logged in user
-	 *
-	 * @return \OC\Files\View cache storage
-	 * @throws \OC\ForbiddenException
-	 * @throws \OC\User\NoUserException
-	 */
-	protected function getStorage() {
-		if ($this->storage !== null) {
-			return $this->storage;
-		}
-		if (\OC::$server->getUserSession()->isLoggedIn()) {
-			$rootView = new View();
-			$user = \OC::$server->getUserSession()->getUser();
-			Filesystem::initMountPoints($user->getUID());
-			if (!$rootView->file_exists('/' . $user->getUID() . '/cache')) {
-				$rootView->mkdir('/' . $user->getUID() . '/cache');
-			}
-			$this->storage = new View('/' . $user->getUID() . '/cache');
-			return $this->storage;
-		} else {
-			\OCP\Util::writeLog('core', 'Can\'t get cache storage, user not logged in', ILogger::ERROR);
-			throw new \OC\ForbiddenException('Can\t get cache storage, user not logged in');
-		}
-	}
+    /**
+     * Returns the cache storage for the logged in user
+     *
+     * @return \OC\Files\View cache storage
+     * @throws \OC\ForbiddenException
+     * @throws \OC\User\NoUserException
+     */
+    protected function getStorage() {
+        if ($this->storage !== null) {
+            return $this->storage;
+        }
+        if (\OC::$server->getUserSession()->isLoggedIn()) {
+            $rootView = new View();
+            $user = \OC::$server->getUserSession()->getUser();
+            Filesystem::initMountPoints($user->getUID());
+            if (!$rootView->file_exists('/' . $user->getUID() . '/cache')) {
+                $rootView->mkdir('/' . $user->getUID() . '/cache');
+            }
+            $this->storage = new View('/' . $user->getUID() . '/cache');
+            return $this->storage;
+        } else {
+            \OCP\Util::writeLog('core', 'Can\'t get cache storage, user not logged in', ILogger::ERROR);
+            throw new \OC\ForbiddenException('Can\t get cache storage, user not logged in');
+        }
+    }
 
-	/**
-	 * @param string $key
-	 * @return mixed|null
-	 * @throws \OC\ForbiddenException
-	 */
-	public function get($key) {
-		$result = null;
-		if ($this->hasKey($key)) {
-			$storage = $this->getStorage();
-			$result = $storage->file_get_contents($key);
-		}
-		return $result;
-	}
+    /**
+     * @param string $key
+     * @return mixed|null
+     * @throws \OC\ForbiddenException
+     */
+    public function get($key) {
+        $result = null;
+        if ($this->hasKey($key)) {
+            $storage = $this->getStorage();
+            $result = $storage->file_get_contents($key);
+        }
+        return $result;
+    }
 
-	/**
-	 * Returns the size of the stored/cached data
-	 *
-	 * @param string $key
-	 * @return int
-	 */
-	public function size($key) {
-		$result = 0;
-		if ($this->hasKey($key)) {
-			$storage = $this->getStorage();
-			$result = $storage->filesize($key);
-		}
-		return $result;
-	}
+    /**
+     * Returns the size of the stored/cached data
+     *
+     * @param string $key
+     * @return int
+     */
+    public function size($key) {
+        $result = 0;
+        if ($this->hasKey($key)) {
+            $storage = $this->getStorage();
+            $result = $storage->filesize($key);
+        }
+        return $result;
+    }
 
-	/**
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl
-	 * @return bool|mixed
-	 * @throws \OC\ForbiddenException
-	 */
-	public function set($key, $value, $ttl = 0) {
-		$storage = $this->getStorage();
-		$result = false;
-		// unique id to avoid chunk collision, just in case
-		$uniqueId = \OC::$server->getSecureRandom()->generate(
-			16,
-			ISecureRandom::CHAR_DIGITS . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER
-		);
+    /**
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl
+     * @return bool|mixed
+     * @throws \OC\ForbiddenException
+     */
+    public function set($key, $value, $ttl = 0) {
+        $storage = $this->getStorage();
+        $result = false;
+        // unique id to avoid chunk collision, just in case
+        $uniqueId = \OC::$server->getSecureRandom()->generate(
+            16,
+            ISecureRandom::CHAR_DIGITS . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER
+        );
 
-		// use part file to prevent hasKey() to find the key
-		// while it is being written
-		$keyPart = $key . '.' . $uniqueId . '.part';
-		if ($storage and $storage->file_put_contents($keyPart, $value)) {
-			if ($ttl === 0) {
-				$ttl = 86400; // 60*60*24
-			}
-			$result = $storage->touch($keyPart, time() + $ttl);
-			$result &= $storage->rename($keyPart, $key);
-		}
-		return $result;
-	}
+        // use part file to prevent hasKey() to find the key
+        // while it is being written
+        $keyPart = $key . '.' . $uniqueId . '.part';
+        if ($storage and $storage->file_put_contents($keyPart, $value)) {
+            if ($ttl === 0) {
+                $ttl = 86400; // 60*60*24
+            }
+            $result = $storage->touch($keyPart, time() + $ttl);
+            $result &= $storage->rename($keyPart, $key);
+        }
+        return $result;
+    }
 
-	/**
-	 * @param string $key
-	 * @return bool
-	 * @throws \OC\ForbiddenException
-	 */
-	public function hasKey($key) {
-		$storage = $this->getStorage();
-		if ($storage && $storage->is_file($key) && $storage->isReadable($key)) {
-			return true;
-		}
-		return false;
-	}
+    /**
+     * @param string $key
+     * @return bool
+     * @throws \OC\ForbiddenException
+     */
+    public function hasKey($key) {
+        $storage = $this->getStorage();
+        if ($storage && $storage->is_file($key) && $storage->isReadable($key)) {
+            return true;
+        }
+        return false;
+    }
 
-	/**
-	 * @param string $key
-	 * @return bool|mixed
-	 * @throws \OC\ForbiddenException
-	 */
-	public function remove($key) {
-		$storage = $this->getStorage();
-		if (!$storage) {
-			return false;
-		}
-		return $storage->unlink($key);
-	}
+    /**
+     * @param string $key
+     * @return bool|mixed
+     * @throws \OC\ForbiddenException
+     */
+    public function remove($key) {
+        $storage = $this->getStorage();
+        if (!$storage) {
+            return false;
+        }
+        return $storage->unlink($key);
+    }
 
-	/**
-	 * @param string $prefix
-	 * @return bool
-	 * @throws \OC\ForbiddenException
-	 */
-	public function clear($prefix = '') {
-		$storage = $this->getStorage();
-		if ($storage and $storage->is_dir('/')) {
-			$dh = $storage->opendir('/');
-			if (is_resource($dh)) {
-				while (($file = readdir($dh)) !== false) {
-					if ($file != '.' and $file != '..' and ($prefix === '' || strpos($file, $prefix) === 0)) {
-						$storage->unlink('/' . $file);
-					}
-				}
-			}
-		}
-		return true;
-	}
+    /**
+     * @param string $prefix
+     * @return bool
+     * @throws \OC\ForbiddenException
+     */
+    public function clear($prefix = '') {
+        $storage = $this->getStorage();
+        if ($storage and $storage->is_dir('/')) {
+            $dh = $storage->opendir('/');
+            if (is_resource($dh)) {
+                while (($file = readdir($dh)) !== false) {
+                    if ($file != '.' and $file != '..' and ($prefix === '' || strpos($file, $prefix) === 0)) {
+                        $storage->unlink('/' . $file);
+                    }
+                }
+            }
+        }
+        return true;
+    }
 
-	/**
-	 * Runs GC
-	 * @throws \OC\ForbiddenException
-	 */
-	public function gc() {
-		$storage = $this->getStorage();
-		if ($storage) {
-			// extra hour safety, in case of stray part chunks that take longer to write,
-			// because touch() is only called after the chunk was finished
-			$now = time() - 3600;
-			$dh = $storage->opendir('/');
-			if (!is_resource($dh)) {
-				return null;
-			}
-			while (($file = readdir($dh)) !== false) {
-				if ($file != '.' and $file != '..') {
-					try {
-						$mtime = $storage->filemtime('/' . $file);
-						if ($mtime < $now) {
-							$storage->unlink('/' . $file);
-						}
-					} catch (\OCP\Lock\LockedException $e) {
-						// ignore locked chunks
-						\OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', ['app' => 'core']);
-					} catch (\OCP\Files\ForbiddenException $e) {
-						\OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "' . $file . '"', ['app' => 'core']);
-					} catch (\OCP\Files\LockNotAcquiredException $e) {
-						\OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', ['app' => 'core']);
-					}
-				}
-			}
-		}
-	}
+    /**
+     * Runs GC
+     * @throws \OC\ForbiddenException
+     */
+    public function gc() {
+        $storage = $this->getStorage();
+        if ($storage) {
+            // extra hour safety, in case of stray part chunks that take longer to write,
+            // because touch() is only called after the chunk was finished
+            $now = time() - 3600;
+            $dh = $storage->opendir('/');
+            if (!is_resource($dh)) {
+                return null;
+            }
+            while (($file = readdir($dh)) !== false) {
+                if ($file != '.' and $file != '..') {
+                    try {
+                        $mtime = $storage->filemtime('/' . $file);
+                        if ($mtime < $now) {
+                            $storage->unlink('/' . $file);
+                        }
+                    } catch (\OCP\Lock\LockedException $e) {
+                        // ignore locked chunks
+                        \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', ['app' => 'core']);
+                    } catch (\OCP\Files\ForbiddenException $e) {
+                        \OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "' . $file . '"', ['app' => 'core']);
+                    } catch (\OCP\Files\LockNotAcquiredException $e) {
+                        \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', ['app' => 'core']);
+                    }
+                }
+            }
+        }
+    }
 }

lib/private/Files/Storage/DAV.php

Indentation +809 added lines, -809 removed lines

@@ -65,813 +65,813 @@
  * @package OC\Files\Storage
  */
 class DAV extends Common {
-	/** @var string */
-	protected $password;
-	/** @var string */
-	protected $user;
-	/** @var string|null */
-	protected $authType;
-	/** @var string */
-	protected $host;
-	/** @var bool */
-	protected $secure;
-	/** @var string */
-	protected $root;
-	/** @var string */
-	protected $certPath;
-	/** @var bool */
-	protected $ready;
-	/** @var Client */
-	protected $client;
-	/** @var ArrayCache */
-	protected $statCache;
-	/** @var IClientService */
-	protected $httpClientService;
-	/** @var ICertificateManager */
-	protected $certManager;
-
-	/**
-	 * @param array $params
-	 * @throws \Exception
-	 */
-	public function __construct($params) {
-		$this->statCache = new ArrayCache();
-		$this->httpClientService = \OC::$server->getHTTPClientService();
-		if (isset($params['host']) && isset($params['user']) && isset($params['password'])) {
-			$host = $params['host'];
-			//remove leading http[s], will be generated in createBaseUri()
-			if (substr($host, 0, 8) == "https://") {
-				$host = substr($host, 8);
-			} elseif (substr($host, 0, 7) == "http://") {
-				$host = substr($host, 7);
-			}
-			$this->host = $host;
-			$this->user = $params['user'];
-			$this->password = $params['password'];
-			if (isset($params['authType'])) {
-				$this->authType = $params['authType'];
-			}
-			if (isset($params['secure'])) {
-				if (is_string($params['secure'])) {
-					$this->secure = ($params['secure'] === 'true');
-				} else {
-					$this->secure = (bool)$params['secure'];
-				}
-			} else {
-				$this->secure = false;
-			}
-			if ($this->secure === true) {
-				// inject mock for testing
-				$this->certManager = \OC::$server->getCertificateManager();
-			}
-			$this->root = $params['root'] ?? '/';
-			$this->root = '/' . ltrim($this->root, '/');
-			$this->root = rtrim($this->root, '/') . '/';
-		} else {
-			throw new \Exception('Invalid webdav storage configuration');
-		}
-	}
-
-	protected function init() {
-		if ($this->ready) {
-			return;
-		}
-		$this->ready = true;
-
-		$settings = [
-			'baseUri' => $this->createBaseUri(),
-			'userName' => $this->user,
-			'password' => $this->password,
-		];
-		if ($this->authType !== null) {
-			$settings['authType'] = $this->authType;
-		}
-
-		$proxy = \OC::$server->getConfig()->getSystemValue('proxy', '');
-		if ($proxy !== '') {
-			$settings['proxy'] = $proxy;
-		}
-
-		$this->client = new Client($settings);
-		$this->client->setThrowExceptions(true);
-
-		if ($this->secure === true) {
-			$certPath = $this->certManager->getAbsoluteBundlePath();
-			if (file_exists($certPath)) {
-				$this->certPath = $certPath;
-			}
-			if ($this->certPath) {
-				$this->client->addCurlSetting(CURLOPT_CAINFO, $this->certPath);
-			}
-		}
-	}
-
-	/**
-	 * Clear the stat cache
-	 */
-	public function clearStatCache() {
-		$this->statCache->clear();
-	}
-
-	/** {@inheritdoc} */
-	public function getId() {
-		return 'webdav::' . $this->user . '@' . $this->host . '/' . $this->root;
-	}
-
-	/** {@inheritdoc} */
-	public function createBaseUri() {
-		$baseUri = 'http';
-		if ($this->secure) {
-			$baseUri .= 's';
-		}
-		$baseUri .= '://' . $this->host . $this->root;
-		return $baseUri;
-	}
-
-	/** {@inheritdoc} */
-	public function mkdir($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		$result = $this->simpleResponse('MKCOL', $path, null, 201);
-		if ($result) {
-			$this->statCache->set($path, true);
-		}
-		return $result;
-	}
-
-	/** {@inheritdoc} */
-	public function rmdir($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		// FIXME: some WebDAV impl return 403 when trying to DELETE
-		// a non-empty folder
-		$result = $this->simpleResponse('DELETE', $path . '/', null, 204);
-		$this->statCache->clear($path . '/');
-		$this->statCache->remove($path);
-		return $result;
-	}
-
-	/** {@inheritdoc} */
-	public function opendir($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		try {
-			$response = $this->client->propFind(
-				$this->encodePath($path),
-				['{DAV:}getetag'],
-				1
-			);
-			if ($response === false) {
-				return false;
-			}
-			$content = [];
-			$files = array_keys($response);
-			array_shift($files); //the first entry is the current directory
-
-			if (!$this->statCache->hasKey($path)) {
-				$this->statCache->set($path, true);
-			}
-			foreach ($files as $file) {
-				$file = urldecode($file);
-				// do not store the real entry, we might not have all properties
-				if (!$this->statCache->hasKey($path)) {
-					$this->statCache->set($file, true);
-				}
-				$file = basename($file);
-				$content[] = $file;
-			}
-			return IteratorDirectory::wrap($content);
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-		}
-		return false;
-	}
-
-	/**
-	 * Propfind call with cache handling.
-	 *
-	 * First checks if information is cached.
-	 * If not, request it from the server then store to cache.
-	 *
-	 * @param string $path path to propfind
-	 *
-	 * @return array|boolean propfind response or false if the entry was not found
-	 *
-	 * @throws ClientHttpException
-	 */
-	protected function propfind($path) {
-		$path = $this->cleanPath($path);
-		$cachedResponse = $this->statCache->get($path);
-		// we either don't know it, or we know it exists but need more details
-		if (is_null($cachedResponse) || $cachedResponse === true) {
-			$this->init();
-			try {
-				$response = $this->client->propFind(
-					$this->encodePath($path),
-					[
-						'{DAV:}getlastmodified',
-						'{DAV:}getcontentlength',
-						'{DAV:}getcontenttype',
-						'{http://owncloud.org/ns}permissions',
-						'{http://open-collaboration-services.org/ns}share-permissions',
-						'{DAV:}resourcetype',
-						'{DAV:}getetag',
-					]
-				);
-				$this->statCache->set($path, $response);
-			} catch (ClientHttpException $e) {
-				if ($e->getHttpStatus() === 404 || $e->getHttpStatus() === 405) {
-					$this->statCache->clear($path . '/');
-					$this->statCache->set($path, false);
-					return false;
-				}
-				$this->convertException($e, $path);
-			} catch (\Exception $e) {
-				$this->convertException($e, $path);
-			}
-		} else {
-			$response = $cachedResponse;
-		}
-		return $response;
-	}
-
-	/** {@inheritdoc} */
-	public function filetype($path) {
-		try {
-			$response = $this->propfind($path);
-			if ($response === false) {
-				return false;
-			}
-			$responseType = [];
-			if (isset($response["{DAV:}resourcetype"])) {
-				/** @var ResourceType[] $response */
-				$responseType = $response["{DAV:}resourcetype"]->getValue();
-			}
-			return (count($responseType) > 0 and $responseType[0] == "{DAV:}collection") ? 'dir' : 'file';
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-		}
-		return false;
-	}
-
-	/** {@inheritdoc} */
-	public function file_exists($path) {
-		try {
-			$path = $this->cleanPath($path);
-			$cachedState = $this->statCache->get($path);
-			if ($cachedState === false) {
-				// we know the file doesn't exist
-				return false;
-			} elseif (!is_null($cachedState)) {
-				return true;
-			}
-			// need to get from server
-			return ($this->propfind($path) !== false);
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-		}
-		return false;
-	}
-
-	/** {@inheritdoc} */
-	public function unlink($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		$result = $this->simpleResponse('DELETE', $path, null, 204);
-		$this->statCache->clear($path . '/');
-		$this->statCache->remove($path);
-		return $result;
-	}
-
-	/** {@inheritdoc} */
-	public function fopen($path, $mode) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		switch ($mode) {
-			case 'r':
-			case 'rb':
-				try {
-					$response = $this->httpClientService
-						->newClient()
-						->get($this->createBaseUri() . $this->encodePath($path), [
-							'auth' => [$this->user, $this->password],
-							'stream' => true
-						]);
-				} catch (\GuzzleHttp\Exception\ClientException $e) {
-					if ($e->getResponse() instanceof ResponseInterface
-						&& $e->getResponse()->getStatusCode() === 404) {
-						return false;
-					} else {
-						throw $e;
-					}
-				}
-
-				if ($response->getStatusCode() !== Http::STATUS_OK) {
-					if ($response->getStatusCode() === Http::STATUS_LOCKED) {
-						throw new \OCP\Lock\LockedException($path);
-					} else {
-						Util::writeLog("webdav client", 'Guzzle get returned status code ' . $response->getStatusCode(), ILogger::ERROR);
-					}
-				}
-
-				return $response->getBody();
-			case 'w':
-			case 'wb':
-			case 'a':
-			case 'ab':
-			case 'r+':
-			case 'w+':
-			case 'wb+':
-			case 'a+':
-			case 'x':
-			case 'x+':
-			case 'c':
-			case 'c+':
-				//emulate these
-				$tempManager = \OC::$server->getTempManager();
-				if (strrpos($path, '.') !== false) {
-					$ext = substr($path, strrpos($path, '.'));
-				} else {
-					$ext = '';
-				}
-				if ($this->file_exists($path)) {
-					if (!$this->isUpdatable($path)) {
-						return false;
-					}
-					if ($mode === 'w' or $mode === 'w+') {
-						$tmpFile = $tempManager->getTemporaryFile($ext);
-					} else {
-						$tmpFile = $this->getCachedFile($path);
-					}
-				} else {
-					if (!$this->isCreatable(dirname($path))) {
-						return false;
-					}
-					$tmpFile = $tempManager->getTemporaryFile($ext);
-				}
-				$handle = fopen($tmpFile, $mode);
-				return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
-					$this->writeBack($tmpFile, $path);
-				});
-		}
-	}
-
-	/**
-	 * @param string $tmpFile
-	 */
-	public function writeBack($tmpFile, $path) {
-		$this->uploadFile($tmpFile, $path);
-		unlink($tmpFile);
-	}
-
-	/** {@inheritdoc} */
-	public function free_space($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		try {
-			// TODO: cacheable ?
-			$response = $this->client->propfind($this->encodePath($path), ['{DAV:}quota-available-bytes']);
-			if ($response === false) {
-				return FileInfo::SPACE_UNKNOWN;
-			}
-			if (isset($response['{DAV:}quota-available-bytes'])) {
-				return (int)$response['{DAV:}quota-available-bytes'];
-			} else {
-				return FileInfo::SPACE_UNKNOWN;
-			}
-		} catch (\Exception $e) {
-			return FileInfo::SPACE_UNKNOWN;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function touch($path, $mtime = null) {
-		$this->init();
-		if (is_null($mtime)) {
-			$mtime = time();
-		}
-		$path = $this->cleanPath($path);
-
-		// if file exists, update the mtime, else create a new empty file
-		if ($this->file_exists($path)) {
-			try {
-				$this->statCache->remove($path);
-				$this->client->proppatch($this->encodePath($path), ['{DAV:}lastmodified' => $mtime]);
-				// non-owncloud clients might not have accepted the property, need to recheck it
-				$response = $this->client->propfind($this->encodePath($path), ['{DAV:}getlastmodified'], 0);
-				if ($response === false) {
-					return false;
-				}
-				if (isset($response['{DAV:}getlastmodified'])) {
-					$remoteMtime = strtotime($response['{DAV:}getlastmodified']);
-					if ($remoteMtime !== $mtime) {
-						// server has not accepted the mtime
-						return false;
-					}
-				}
-			} catch (ClientHttpException $e) {
-				if ($e->getHttpStatus() === 501) {
-					return false;
-				}
-				$this->convertException($e, $path);
-				return false;
-			} catch (\Exception $e) {
-				$this->convertException($e, $path);
-				return false;
-			}
-		} else {
-			$this->file_put_contents($path, '');
-		}
-		return true;
-	}
-
-	/**
-	 * @param string $path
-	 * @param mixed $data
-	 * @return int|false
-	 */
-	public function file_put_contents($path, $data) {
-		$path = $this->cleanPath($path);
-		$result = parent::file_put_contents($path, $data);
-		$this->statCache->remove($path);
-		return $result;
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $target
-	 */
-	protected function uploadFile($path, $target) {
-		$this->init();
-
-		// invalidate
-		$target = $this->cleanPath($target);
-		$this->statCache->remove($target);
-		$source = fopen($path, 'r');
-
-		$this->httpClientService
-			->newClient()
-			->put($this->createBaseUri() . $this->encodePath($target), [
-				'body' => $source,
-				'auth' => [$this->user, $this->password]
-			]);
-
-		$this->removeCachedFile($target);
-	}
-
-	/** {@inheritdoc} */
-	public function rename($path1, $path2) {
-		$this->init();
-		$path1 = $this->cleanPath($path1);
-		$path2 = $this->cleanPath($path2);
-		try {
-			// overwrite directory ?
-			if ($this->is_dir($path2)) {
-				// needs trailing slash in destination
-				$path2 = rtrim($path2, '/') . '/';
-			}
-			$this->client->request(
-				'MOVE',
-				$this->encodePath($path1),
-				null,
-				[
-					'Destination' => $this->createBaseUri() . $this->encodePath($path2),
-				]
-			);
-			$this->statCache->clear($path1 . '/');
-			$this->statCache->clear($path2 . '/');
-			$this->statCache->set($path1, false);
-			$this->statCache->set($path2, true);
-			$this->removeCachedFile($path1);
-			$this->removeCachedFile($path2);
-			return true;
-		} catch (\Exception $e) {
-			$this->convertException($e);
-		}
-		return false;
-	}
-
-	/** {@inheritdoc} */
-	public function copy($path1, $path2) {
-		$this->init();
-		$path1 = $this->cleanPath($path1);
-		$path2 = $this->cleanPath($path2);
-		try {
-			// overwrite directory ?
-			if ($this->is_dir($path2)) {
-				// needs trailing slash in destination
-				$path2 = rtrim($path2, '/') . '/';
-			}
-			$this->client->request(
-				'COPY',
-				$this->encodePath($path1),
-				null,
-				[
-					'Destination' => $this->createBaseUri() . $this->encodePath($path2),
-				]
-			);
-			$this->statCache->clear($path2 . '/');
-			$this->statCache->set($path2, true);
-			$this->removeCachedFile($path2);
-			return true;
-		} catch (\Exception $e) {
-			$this->convertException($e);
-		}
-		return false;
-	}
-
-	/** {@inheritdoc} */
-	public function stat($path) {
-		try {
-			$response = $this->propfind($path);
-			if (!$response) {
-				return false;
-			}
-			return [
-				'mtime' => strtotime($response['{DAV:}getlastmodified']),
-				'size' => (int)isset($response['{DAV:}getcontentlength']) ? $response['{DAV:}getcontentlength'] : 0,
-			];
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-		}
-		return [];
-	}
-
-	/** {@inheritdoc} */
-	public function getMimeType($path) {
-		$remoteMimetype = $this->getMimeTypeFromRemote($path);
-		if ($remoteMimetype === 'application/octet-stream') {
-			return \OC::$server->getMimeTypeDetector()->detectPath($path);
-		} else {
-			return $remoteMimetype;
-		}
-	}
-
-	public function getMimeTypeFromRemote($path) {
-		try {
-			$response = $this->propfind($path);
-			if ($response === false) {
-				return false;
-			}
-			$responseType = [];
-			if (isset($response["{DAV:}resourcetype"])) {
-				/** @var ResourceType[] $response */
-				$responseType = $response["{DAV:}resourcetype"]->getValue();
-			}
-			$type = (count($responseType) > 0 and $responseType[0] == "{DAV:}collection") ? 'dir' : 'file';
-			if ($type == 'dir') {
-				return 'httpd/unix-directory';
-			} elseif (isset($response['{DAV:}getcontenttype'])) {
-				return $response['{DAV:}getcontenttype'];
-			} else {
-				return 'application/octet-stream';
-			}
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	public function cleanPath($path) {
-		if ($path === '') {
-			return $path;
-		}
-		$path = Filesystem::normalizePath($path);
-		// remove leading slash
-		return substr($path, 1);
-	}
-
-	/**
-	 * URL encodes the given path but keeps the slashes
-	 *
-	 * @param string $path to encode
-	 * @return string encoded path
-	 */
-	protected function encodePath($path) {
-		// slashes need to stay
-		return str_replace('%2F', '/', rawurlencode($path));
-	}
-
-	/**
-	 * @param string $method
-	 * @param string $path
-	 * @param string|resource|null $body
-	 * @param int $expected
-	 * @return bool
-	 * @throws StorageInvalidException
-	 * @throws StorageNotAvailableException
-	 */
-	protected function simpleResponse($method, $path, $body, $expected) {
-		$path = $this->cleanPath($path);
-		try {
-			$response = $this->client->request($method, $this->encodePath($path), $body);
-			return $response['statusCode'] == $expected;
-		} catch (ClientHttpException $e) {
-			if ($e->getHttpStatus() === 404 && $method === 'DELETE') {
-				$this->statCache->clear($path . '/');
-				$this->statCache->set($path, false);
-				return false;
-			}
-
-			$this->convertException($e, $path);
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-		}
-		return false;
-	}
-
-	/**
-	 * check if curl is installed
-	 */
-	public static function checkDependencies() {
-		return true;
-	}
-
-	/** {@inheritdoc} */
-	public function isUpdatable($path) {
-		return (bool)($this->getPermissions($path) & Constants::PERMISSION_UPDATE);
-	}
-
-	/** {@inheritdoc} */
-	public function isCreatable($path) {
-		return (bool)($this->getPermissions($path) & Constants::PERMISSION_CREATE);
-	}
-
-	/** {@inheritdoc} */
-	public function isSharable($path) {
-		return (bool)($this->getPermissions($path) & Constants::PERMISSION_SHARE);
-	}
-
-	/** {@inheritdoc} */
-	public function isDeletable($path) {
-		return (bool)($this->getPermissions($path) & Constants::PERMISSION_DELETE);
-	}
-
-	/** {@inheritdoc} */
-	public function getPermissions($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		$response = $this->propfind($path);
-		if ($response === false) {
-			return 0;
-		}
-		if (isset($response['{http://owncloud.org/ns}permissions'])) {
-			return $this->parsePermissions($response['{http://owncloud.org/ns}permissions']);
-		} elseif ($this->is_dir($path)) {
-			return Constants::PERMISSION_ALL;
-		} elseif ($this->file_exists($path)) {
-			return Constants::PERMISSION_ALL - Constants::PERMISSION_CREATE;
-		} else {
-			return 0;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function getETag($path) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		$response = $this->propfind($path);
-		if ($response === false) {
-			return null;
-		}
-		if (isset($response['{DAV:}getetag'])) {
-			$etag = trim($response['{DAV:}getetag'], '"');
-			if (strlen($etag) > 40) {
-				$etag = md5($etag);
-			}
-			return $etag;
-		}
-		return parent::getEtag($path);
-	}
-
-	/**
-	 * @param string $permissionsString
-	 * @return int
-	 */
-	protected function parsePermissions($permissionsString) {
-		$permissions = Constants::PERMISSION_READ;
-		if (strpos($permissionsString, 'R') !== false) {
-			$permissions |= Constants::PERMISSION_SHARE;
-		}
-		if (strpos($permissionsString, 'D') !== false) {
-			$permissions |= Constants::PERMISSION_DELETE;
-		}
-		if (strpos($permissionsString, 'W') !== false) {
-			$permissions |= Constants::PERMISSION_UPDATE;
-		}
-		if (strpos($permissionsString, 'CK') !== false) {
-			$permissions |= Constants::PERMISSION_CREATE;
-			$permissions |= Constants::PERMISSION_UPDATE;
-		}
-		return $permissions;
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @throws \OCP\Files\StorageNotAvailableException
-	 * @return bool
-	 */
-	public function hasUpdated($path, $time) {
-		$this->init();
-		$path = $this->cleanPath($path);
-		try {
-			// force refresh for $path
-			$this->statCache->remove($path);
-			$response = $this->propfind($path);
-			if ($response === false) {
-				if ($path === '') {
-					// if root is gone it means the storage is not available
-					throw new StorageNotAvailableException('root is gone');
-				}
-				return false;
-			}
-			if (isset($response['{DAV:}getetag'])) {
-				$cachedData = $this->getCache()->get($path);
-				$etag = null;
-				if (isset($response['{DAV:}getetag'])) {
-					$etag = trim($response['{DAV:}getetag'], '"');
-				}
-				if (!empty($etag) && $cachedData['etag'] !== $etag) {
-					return true;
-				} elseif (isset($response['{http://open-collaboration-services.org/ns}share-permissions'])) {
-					$sharePermissions = (int)$response['{http://open-collaboration-services.org/ns}share-permissions'];
-					return $sharePermissions !== $cachedData['permissions'];
-				} elseif (isset($response['{http://owncloud.org/ns}permissions'])) {
-					$permissions = $this->parsePermissions($response['{http://owncloud.org/ns}permissions']);
-					return $permissions !== $cachedData['permissions'];
-				} else {
-					return false;
-				}
-			} else {
-				$remoteMtime = strtotime($response['{DAV:}getlastmodified']);
-				return $remoteMtime > $time;
-			}
-		} catch (ClientHttpException $e) {
-			if ($e->getHttpStatus() === 405) {
-				if ($path === '') {
-					// if root is gone it means the storage is not available
-					throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
-				}
-				return false;
-			}
-			$this->convertException($e, $path);
-			return false;
-		} catch (\Exception $e) {
-			$this->convertException($e, $path);
-			return false;
-		}
-	}
-
-	/**
-	 * Interpret the given exception and decide whether it is due to an
-	 * unavailable storage, invalid storage or other.
-	 * This will either throw StorageInvalidException, StorageNotAvailableException
-	 * or do nothing.
-	 *
-	 * @param Exception $e sabre exception
-	 * @param string $path optional path from the operation
-	 *
-	 * @throws StorageInvalidException if the storage is invalid, for example
-	 * when the authentication expired or is invalid
-	 * @throws StorageNotAvailableException if the storage is not available,
-	 * which might be temporary
-	 * @throws ForbiddenException if the action is not allowed
-	 */
-	protected function convertException(Exception $e, $path = '') {
-		\OC::$server->getLogger()->logException($e, ['app' => 'files_external', 'level' => ILogger::DEBUG]);
-		if ($e instanceof ClientHttpException) {
-			if ($e->getHttpStatus() === Http::STATUS_LOCKED) {
-				throw new \OCP\Lock\LockedException($path);
-			}
-			if ($e->getHttpStatus() === Http::STATUS_UNAUTHORIZED) {
-				// either password was changed or was invalid all along
-				throw new StorageInvalidException(get_class($e) . ': ' . $e->getMessage());
-			} elseif ($e->getHttpStatus() === Http::STATUS_METHOD_NOT_ALLOWED) {
-				// ignore exception for MethodNotAllowed, false will be returned
-				return;
-			} elseif ($e->getHttpStatus() === Http::STATUS_FORBIDDEN) {
-				// The operation is forbidden. Fail somewhat gracefully
-				throw new ForbiddenException(get_class($e) . ':' . $e->getMessage(), false);
-			}
-			throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
-		} elseif ($e instanceof ClientException) {
-			// connection timeout or refused, server could be temporarily down
-			throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
-		} elseif ($e instanceof \InvalidArgumentException) {
-			// parse error because the server returned HTML instead of XML,
-			// possibly temporarily down
-			throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
-		} elseif (($e instanceof StorageNotAvailableException) || ($e instanceof StorageInvalidException)) {
-			// rethrow
-			throw $e;
-		}
-
-		// TODO: only log for now, but in the future need to wrap/rethrow exception
-	}
+    /** @var string */
+    protected $password;
+    /** @var string */
+    protected $user;
+    /** @var string|null */
+    protected $authType;
+    /** @var string */
+    protected $host;
+    /** @var bool */
+    protected $secure;
+    /** @var string */
+    protected $root;
+    /** @var string */
+    protected $certPath;
+    /** @var bool */
+    protected $ready;
+    /** @var Client */
+    protected $client;
+    /** @var ArrayCache */
+    protected $statCache;
+    /** @var IClientService */
+    protected $httpClientService;
+    /** @var ICertificateManager */
+    protected $certManager;
+
+    /**
+     * @param array $params
+     * @throws \Exception
+     */
+    public function __construct($params) {
+        $this->statCache = new ArrayCache();
+        $this->httpClientService = \OC::$server->getHTTPClientService();
+        if (isset($params['host']) && isset($params['user']) && isset($params['password'])) {
+            $host = $params['host'];
+            //remove leading http[s], will be generated in createBaseUri()
+            if (substr($host, 0, 8) == "https://") {
+                $host = substr($host, 8);
+            } elseif (substr($host, 0, 7) == "http://") {
+                $host = substr($host, 7);
+            }
+            $this->host = $host;
+            $this->user = $params['user'];
+            $this->password = $params['password'];
+            if (isset($params['authType'])) {
+                $this->authType = $params['authType'];
+            }
+            if (isset($params['secure'])) {
+                if (is_string($params['secure'])) {
+                    $this->secure = ($params['secure'] === 'true');
+                } else {
+                    $this->secure = (bool)$params['secure'];
+                }
+            } else {
+                $this->secure = false;
+            }
+            if ($this->secure === true) {
+                // inject mock for testing
+                $this->certManager = \OC::$server->getCertificateManager();
+            }
+            $this->root = $params['root'] ?? '/';
+            $this->root = '/' . ltrim($this->root, '/');
+            $this->root = rtrim($this->root, '/') . '/';
+        } else {
+            throw new \Exception('Invalid webdav storage configuration');
+        }
+    }
+
+    protected function init() {
+        if ($this->ready) {
+            return;
+        }
+        $this->ready = true;
+
+        $settings = [
+            'baseUri' => $this->createBaseUri(),
+            'userName' => $this->user,
+            'password' => $this->password,
+        ];
+        if ($this->authType !== null) {
+            $settings['authType'] = $this->authType;
+        }
+
+        $proxy = \OC::$server->getConfig()->getSystemValue('proxy', '');
+        if ($proxy !== '') {
+            $settings['proxy'] = $proxy;
+        }
+
+        $this->client = new Client($settings);
+        $this->client->setThrowExceptions(true);
+
+        if ($this->secure === true) {
+            $certPath = $this->certManager->getAbsoluteBundlePath();
+            if (file_exists($certPath)) {
+                $this->certPath = $certPath;
+            }
+            if ($this->certPath) {
+                $this->client->addCurlSetting(CURLOPT_CAINFO, $this->certPath);
+            }
+        }
+    }
+
+    /**
+     * Clear the stat cache
+     */
+    public function clearStatCache() {
+        $this->statCache->clear();
+    }
+
+    /** {@inheritdoc} */
+    public function getId() {
+        return 'webdav::' . $this->user . '@' . $this->host . '/' . $this->root;
+    }
+
+    /** {@inheritdoc} */
+    public function createBaseUri() {
+        $baseUri = 'http';
+        if ($this->secure) {
+            $baseUri .= 's';
+        }
+        $baseUri .= '://' . $this->host . $this->root;
+        return $baseUri;
+    }
+
+    /** {@inheritdoc} */
+    public function mkdir($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        $result = $this->simpleResponse('MKCOL', $path, null, 201);
+        if ($result) {
+            $this->statCache->set($path, true);
+        }
+        return $result;
+    }
+
+    /** {@inheritdoc} */
+    public function rmdir($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        // FIXME: some WebDAV impl return 403 when trying to DELETE
+        // a non-empty folder
+        $result = $this->simpleResponse('DELETE', $path . '/', null, 204);
+        $this->statCache->clear($path . '/');
+        $this->statCache->remove($path);
+        return $result;
+    }
+
+    /** {@inheritdoc} */
+    public function opendir($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        try {
+            $response = $this->client->propFind(
+                $this->encodePath($path),
+                ['{DAV:}getetag'],
+                1
+            );
+            if ($response === false) {
+                return false;
+            }
+            $content = [];
+            $files = array_keys($response);
+            array_shift($files); //the first entry is the current directory
+
+            if (!$this->statCache->hasKey($path)) {
+                $this->statCache->set($path, true);
+            }
+            foreach ($files as $file) {
+                $file = urldecode($file);
+                // do not store the real entry, we might not have all properties
+                if (!$this->statCache->hasKey($path)) {
+                    $this->statCache->set($file, true);
+                }
+                $file = basename($file);
+                $content[] = $file;
+            }
+            return IteratorDirectory::wrap($content);
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+        }
+        return false;
+    }
+
+    /**
+     * Propfind call with cache handling.
+     *
+     * First checks if information is cached.
+     * If not, request it from the server then store to cache.
+     *
+     * @param string $path path to propfind
+     *
+     * @return array|boolean propfind response or false if the entry was not found
+     *
+     * @throws ClientHttpException
+     */
+    protected function propfind($path) {
+        $path = $this->cleanPath($path);
+        $cachedResponse = $this->statCache->get($path);
+        // we either don't know it, or we know it exists but need more details
+        if (is_null($cachedResponse) || $cachedResponse === true) {
+            $this->init();
+            try {
+                $response = $this->client->propFind(
+                    $this->encodePath($path),
+                    [
+                        '{DAV:}getlastmodified',
+                        '{DAV:}getcontentlength',
+                        '{DAV:}getcontenttype',
+                        '{http://owncloud.org/ns}permissions',
+                        '{http://open-collaboration-services.org/ns}share-permissions',
+                        '{DAV:}resourcetype',
+                        '{DAV:}getetag',
+                    ]
+                );
+                $this->statCache->set($path, $response);
+            } catch (ClientHttpException $e) {
+                if ($e->getHttpStatus() === 404 || $e->getHttpStatus() === 405) {
+                    $this->statCache->clear($path . '/');
+                    $this->statCache->set($path, false);
+                    return false;
+                }
+                $this->convertException($e, $path);
+            } catch (\Exception $e) {
+                $this->convertException($e, $path);
+            }
+        } else {
+            $response = $cachedResponse;
+        }
+        return $response;
+    }
+
+    /** {@inheritdoc} */
+    public function filetype($path) {
+        try {
+            $response = $this->propfind($path);
+            if ($response === false) {
+                return false;
+            }
+            $responseType = [];
+            if (isset($response["{DAV:}resourcetype"])) {
+                /** @var ResourceType[] $response */
+                $responseType = $response["{DAV:}resourcetype"]->getValue();
+            }
+            return (count($responseType) > 0 and $responseType[0] == "{DAV:}collection") ? 'dir' : 'file';
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+        }
+        return false;
+    }
+
+    /** {@inheritdoc} */
+    public function file_exists($path) {
+        try {
+            $path = $this->cleanPath($path);
+            $cachedState = $this->statCache->get($path);
+            if ($cachedState === false) {
+                // we know the file doesn't exist
+                return false;
+            } elseif (!is_null($cachedState)) {
+                return true;
+            }
+            // need to get from server
+            return ($this->propfind($path) !== false);
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+        }
+        return false;
+    }
+
+    /** {@inheritdoc} */
+    public function unlink($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        $result = $this->simpleResponse('DELETE', $path, null, 204);
+        $this->statCache->clear($path . '/');
+        $this->statCache->remove($path);
+        return $result;
+    }
+
+    /** {@inheritdoc} */
+    public function fopen($path, $mode) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        switch ($mode) {
+            case 'r':
+            case 'rb':
+                try {
+                    $response = $this->httpClientService
+                        ->newClient()
+                        ->get($this->createBaseUri() . $this->encodePath($path), [
+                            'auth' => [$this->user, $this->password],
+                            'stream' => true
+                        ]);
+                } catch (\GuzzleHttp\Exception\ClientException $e) {
+                    if ($e->getResponse() instanceof ResponseInterface
+                        && $e->getResponse()->getStatusCode() === 404) {
+                        return false;
+                    } else {
+                        throw $e;
+                    }
+                }
+
+                if ($response->getStatusCode() !== Http::STATUS_OK) {
+                    if ($response->getStatusCode() === Http::STATUS_LOCKED) {
+                        throw new \OCP\Lock\LockedException($path);
+                    } else {
+                        Util::writeLog("webdav client", 'Guzzle get returned status code ' . $response->getStatusCode(), ILogger::ERROR);
+                    }
+                }
+
+                return $response->getBody();
+            case 'w':
+            case 'wb':
+            case 'a':
+            case 'ab':
+            case 'r+':
+            case 'w+':
+            case 'wb+':
+            case 'a+':
+            case 'x':
+            case 'x+':
+            case 'c':
+            case 'c+':
+                //emulate these
+                $tempManager = \OC::$server->getTempManager();
+                if (strrpos($path, '.') !== false) {
+                    $ext = substr($path, strrpos($path, '.'));
+                } else {
+                    $ext = '';
+                }
+                if ($this->file_exists($path)) {
+                    if (!$this->isUpdatable($path)) {
+                        return false;
+                    }
+                    if ($mode === 'w' or $mode === 'w+') {
+                        $tmpFile = $tempManager->getTemporaryFile($ext);
+                    } else {
+                        $tmpFile = $this->getCachedFile($path);
+                    }
+                } else {
+                    if (!$this->isCreatable(dirname($path))) {
+                        return false;
+                    }
+                    $tmpFile = $tempManager->getTemporaryFile($ext);
+                }
+                $handle = fopen($tmpFile, $mode);
+                return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
+                    $this->writeBack($tmpFile, $path);
+                });
+        }
+    }
+
+    /**
+     * @param string $tmpFile
+     */
+    public function writeBack($tmpFile, $path) {
+        $this->uploadFile($tmpFile, $path);
+        unlink($tmpFile);
+    }
+
+    /** {@inheritdoc} */
+    public function free_space($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        try {
+            // TODO: cacheable ?
+            $response = $this->client->propfind($this->encodePath($path), ['{DAV:}quota-available-bytes']);
+            if ($response === false) {
+                return FileInfo::SPACE_UNKNOWN;
+            }
+            if (isset($response['{DAV:}quota-available-bytes'])) {
+                return (int)$response['{DAV:}quota-available-bytes'];
+            } else {
+                return FileInfo::SPACE_UNKNOWN;
+            }
+        } catch (\Exception $e) {
+            return FileInfo::SPACE_UNKNOWN;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function touch($path, $mtime = null) {
+        $this->init();
+        if (is_null($mtime)) {
+            $mtime = time();
+        }
+        $path = $this->cleanPath($path);
+
+        // if file exists, update the mtime, else create a new empty file
+        if ($this->file_exists($path)) {
+            try {
+                $this->statCache->remove($path);
+                $this->client->proppatch($this->encodePath($path), ['{DAV:}lastmodified' => $mtime]);
+                // non-owncloud clients might not have accepted the property, need to recheck it
+                $response = $this->client->propfind($this->encodePath($path), ['{DAV:}getlastmodified'], 0);
+                if ($response === false) {
+                    return false;
+                }
+                if (isset($response['{DAV:}getlastmodified'])) {
+                    $remoteMtime = strtotime($response['{DAV:}getlastmodified']);
+                    if ($remoteMtime !== $mtime) {
+                        // server has not accepted the mtime
+                        return false;
+                    }
+                }
+            } catch (ClientHttpException $e) {
+                if ($e->getHttpStatus() === 501) {
+                    return false;
+                }
+                $this->convertException($e, $path);
+                return false;
+            } catch (\Exception $e) {
+                $this->convertException($e, $path);
+                return false;
+            }
+        } else {
+            $this->file_put_contents($path, '');
+        }
+        return true;
+    }
+
+    /**
+     * @param string $path
+     * @param mixed $data
+     * @return int|false
+     */
+    public function file_put_contents($path, $data) {
+        $path = $this->cleanPath($path);
+        $result = parent::file_put_contents($path, $data);
+        $this->statCache->remove($path);
+        return $result;
+    }
+
+    /**
+     * @param string $path
+     * @param string $target
+     */
+    protected function uploadFile($path, $target) {
+        $this->init();
+
+        // invalidate
+        $target = $this->cleanPath($target);
+        $this->statCache->remove($target);
+        $source = fopen($path, 'r');
+
+        $this->httpClientService
+            ->newClient()
+            ->put($this->createBaseUri() . $this->encodePath($target), [
+                'body' => $source,
+                'auth' => [$this->user, $this->password]
+            ]);
+
+        $this->removeCachedFile($target);
+    }
+
+    /** {@inheritdoc} */
+    public function rename($path1, $path2) {
+        $this->init();
+        $path1 = $this->cleanPath($path1);
+        $path2 = $this->cleanPath($path2);
+        try {
+            // overwrite directory ?
+            if ($this->is_dir($path2)) {
+                // needs trailing slash in destination
+                $path2 = rtrim($path2, '/') . '/';
+            }
+            $this->client->request(
+                'MOVE',
+                $this->encodePath($path1),
+                null,
+                [
+                    'Destination' => $this->createBaseUri() . $this->encodePath($path2),
+                ]
+            );
+            $this->statCache->clear($path1 . '/');
+            $this->statCache->clear($path2 . '/');
+            $this->statCache->set($path1, false);
+            $this->statCache->set($path2, true);
+            $this->removeCachedFile($path1);
+            $this->removeCachedFile($path2);
+            return true;
+        } catch (\Exception $e) {
+            $this->convertException($e);
+        }
+        return false;
+    }
+
+    /** {@inheritdoc} */
+    public function copy($path1, $path2) {
+        $this->init();
+        $path1 = $this->cleanPath($path1);
+        $path2 = $this->cleanPath($path2);
+        try {
+            // overwrite directory ?
+            if ($this->is_dir($path2)) {
+                // needs trailing slash in destination
+                $path2 = rtrim($path2, '/') . '/';
+            }
+            $this->client->request(
+                'COPY',
+                $this->encodePath($path1),
+                null,
+                [
+                    'Destination' => $this->createBaseUri() . $this->encodePath($path2),
+                ]
+            );
+            $this->statCache->clear($path2 . '/');
+            $this->statCache->set($path2, true);
+            $this->removeCachedFile($path2);
+            return true;
+        } catch (\Exception $e) {
+            $this->convertException($e);
+        }
+        return false;
+    }
+
+    /** {@inheritdoc} */
+    public function stat($path) {
+        try {
+            $response = $this->propfind($path);
+            if (!$response) {
+                return false;
+            }
+            return [
+                'mtime' => strtotime($response['{DAV:}getlastmodified']),
+                'size' => (int)isset($response['{DAV:}getcontentlength']) ? $response['{DAV:}getcontentlength'] : 0,
+            ];
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+        }
+        return [];
+    }
+
+    /** {@inheritdoc} */
+    public function getMimeType($path) {
+        $remoteMimetype = $this->getMimeTypeFromRemote($path);
+        if ($remoteMimetype === 'application/octet-stream') {
+            return \OC::$server->getMimeTypeDetector()->detectPath($path);
+        } else {
+            return $remoteMimetype;
+        }
+    }
+
+    public function getMimeTypeFromRemote($path) {
+        try {
+            $response = $this->propfind($path);
+            if ($response === false) {
+                return false;
+            }
+            $responseType = [];
+            if (isset($response["{DAV:}resourcetype"])) {
+                /** @var ResourceType[] $response */
+                $responseType = $response["{DAV:}resourcetype"]->getValue();
+            }
+            $type = (count($responseType) > 0 and $responseType[0] == "{DAV:}collection") ? 'dir' : 'file';
+            if ($type == 'dir') {
+                return 'httpd/unix-directory';
+            } elseif (isset($response['{DAV:}getcontenttype'])) {
+                return $response['{DAV:}getcontenttype'];
+            } else {
+                return 'application/octet-stream';
+            }
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    public function cleanPath($path) {
+        if ($path === '') {
+            return $path;
+        }
+        $path = Filesystem::normalizePath($path);
+        // remove leading slash
+        return substr($path, 1);
+    }
+
+    /**
+     * URL encodes the given path but keeps the slashes
+     *
+     * @param string $path to encode
+     * @return string encoded path
+     */
+    protected function encodePath($path) {
+        // slashes need to stay
+        return str_replace('%2F', '/', rawurlencode($path));
+    }
+
+    /**
+     * @param string $method
+     * @param string $path
+     * @param string|resource|null $body
+     * @param int $expected
+     * @return bool
+     * @throws StorageInvalidException
+     * @throws StorageNotAvailableException
+     */
+    protected function simpleResponse($method, $path, $body, $expected) {
+        $path = $this->cleanPath($path);
+        try {
+            $response = $this->client->request($method, $this->encodePath($path), $body);
+            return $response['statusCode'] == $expected;
+        } catch (ClientHttpException $e) {
+            if ($e->getHttpStatus() === 404 && $method === 'DELETE') {
+                $this->statCache->clear($path . '/');
+                $this->statCache->set($path, false);
+                return false;
+            }
+
+            $this->convertException($e, $path);
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+        }
+        return false;
+    }
+
+    /**
+     * check if curl is installed
+     */
+    public static function checkDependencies() {
+        return true;
+    }
+
+    /** {@inheritdoc} */
+    public function isUpdatable($path) {
+        return (bool)($this->getPermissions($path) & Constants::PERMISSION_UPDATE);
+    }
+
+    /** {@inheritdoc} */
+    public function isCreatable($path) {
+        return (bool)($this->getPermissions($path) & Constants::PERMISSION_CREATE);
+    }
+
+    /** {@inheritdoc} */
+    public function isSharable($path) {
+        return (bool)($this->getPermissions($path) & Constants::PERMISSION_SHARE);
+    }
+
+    /** {@inheritdoc} */
+    public function isDeletable($path) {
+        return (bool)($this->getPermissions($path) & Constants::PERMISSION_DELETE);
+    }
+
+    /** {@inheritdoc} */
+    public function getPermissions($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        $response = $this->propfind($path);
+        if ($response === false) {
+            return 0;
+        }
+        if (isset($response['{http://owncloud.org/ns}permissions'])) {
+            return $this->parsePermissions($response['{http://owncloud.org/ns}permissions']);
+        } elseif ($this->is_dir($path)) {
+            return Constants::PERMISSION_ALL;
+        } elseif ($this->file_exists($path)) {
+            return Constants::PERMISSION_ALL - Constants::PERMISSION_CREATE;
+        } else {
+            return 0;
+        }
+    }
+
+    /** {@inheritdoc} */
+    public function getETag($path) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        $response = $this->propfind($path);
+        if ($response === false) {
+            return null;
+        }
+        if (isset($response['{DAV:}getetag'])) {
+            $etag = trim($response['{DAV:}getetag'], '"');
+            if (strlen($etag) > 40) {
+                $etag = md5($etag);
+            }
+            return $etag;
+        }
+        return parent::getEtag($path);
+    }
+
+    /**
+     * @param string $permissionsString
+     * @return int
+     */
+    protected function parsePermissions($permissionsString) {
+        $permissions = Constants::PERMISSION_READ;
+        if (strpos($permissionsString, 'R') !== false) {
+            $permissions |= Constants::PERMISSION_SHARE;
+        }
+        if (strpos($permissionsString, 'D') !== false) {
+            $permissions |= Constants::PERMISSION_DELETE;
+        }
+        if (strpos($permissionsString, 'W') !== false) {
+            $permissions |= Constants::PERMISSION_UPDATE;
+        }
+        if (strpos($permissionsString, 'CK') !== false) {
+            $permissions |= Constants::PERMISSION_CREATE;
+            $permissions |= Constants::PERMISSION_UPDATE;
+        }
+        return $permissions;
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @throws \OCP\Files\StorageNotAvailableException
+     * @return bool
+     */
+    public function hasUpdated($path, $time) {
+        $this->init();
+        $path = $this->cleanPath($path);
+        try {
+            // force refresh for $path
+            $this->statCache->remove($path);
+            $response = $this->propfind($path);
+            if ($response === false) {
+                if ($path === '') {
+                    // if root is gone it means the storage is not available
+                    throw new StorageNotAvailableException('root is gone');
+                }
+                return false;
+            }
+            if (isset($response['{DAV:}getetag'])) {
+                $cachedData = $this->getCache()->get($path);
+                $etag = null;
+                if (isset($response['{DAV:}getetag'])) {
+                    $etag = trim($response['{DAV:}getetag'], '"');
+                }
+                if (!empty($etag) && $cachedData['etag'] !== $etag) {
+                    return true;
+                } elseif (isset($response['{http://open-collaboration-services.org/ns}share-permissions'])) {
+                    $sharePermissions = (int)$response['{http://open-collaboration-services.org/ns}share-permissions'];
+                    return $sharePermissions !== $cachedData['permissions'];
+                } elseif (isset($response['{http://owncloud.org/ns}permissions'])) {
+                    $permissions = $this->parsePermissions($response['{http://owncloud.org/ns}permissions']);
+                    return $permissions !== $cachedData['permissions'];
+                } else {
+                    return false;
+                }
+            } else {
+                $remoteMtime = strtotime($response['{DAV:}getlastmodified']);
+                return $remoteMtime > $time;
+            }
+        } catch (ClientHttpException $e) {
+            if ($e->getHttpStatus() === 405) {
+                if ($path === '') {
+                    // if root is gone it means the storage is not available
+                    throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
+                }
+                return false;
+            }
+            $this->convertException($e, $path);
+            return false;
+        } catch (\Exception $e) {
+            $this->convertException($e, $path);
+            return false;
+        }
+    }
+
+    /**
+     * Interpret the given exception and decide whether it is due to an
+     * unavailable storage, invalid storage or other.
+     * This will either throw StorageInvalidException, StorageNotAvailableException
+     * or do nothing.
+     *
+     * @param Exception $e sabre exception
+     * @param string $path optional path from the operation
+     *
+     * @throws StorageInvalidException if the storage is invalid, for example
+     * when the authentication expired or is invalid
+     * @throws StorageNotAvailableException if the storage is not available,
+     * which might be temporary
+     * @throws ForbiddenException if the action is not allowed
+     */
+    protected function convertException(Exception $e, $path = '') {
+        \OC::$server->getLogger()->logException($e, ['app' => 'files_external', 'level' => ILogger::DEBUG]);
+        if ($e instanceof ClientHttpException) {
+            if ($e->getHttpStatus() === Http::STATUS_LOCKED) {
+                throw new \OCP\Lock\LockedException($path);
+            }
+            if ($e->getHttpStatus() === Http::STATUS_UNAUTHORIZED) {
+                // either password was changed or was invalid all along
+                throw new StorageInvalidException(get_class($e) . ': ' . $e->getMessage());
+            } elseif ($e->getHttpStatus() === Http::STATUS_METHOD_NOT_ALLOWED) {
+                // ignore exception for MethodNotAllowed, false will be returned
+                return;
+            } elseif ($e->getHttpStatus() === Http::STATUS_FORBIDDEN) {
+                // The operation is forbidden. Fail somewhat gracefully
+                throw new ForbiddenException(get_class($e) . ':' . $e->getMessage(), false);
+            }
+            throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
+        } elseif ($e instanceof ClientException) {
+            // connection timeout or refused, server could be temporarily down
+            throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
+        } elseif ($e instanceof \InvalidArgumentException) {
+            // parse error because the server returned HTML instead of XML,
+            // possibly temporarily down
+            throw new StorageNotAvailableException(get_class($e) . ': ' . $e->getMessage());
+        } elseif (($e instanceof StorageNotAvailableException) || ($e instanceof StorageInvalidException)) {
+            // rethrow
+            throw $e;
+        }
+
+        // TODO: only log for now, but in the future need to wrap/rethrow exception
+    }
 }

lib/private/Route/Router.php

Indentation +399 added lines, -399 removed lines

@@ -46,403 +46,403 @@
 use Symfony\Component\Routing\RouteCollection;
 
 class Router implements IRouter {
-	/** @var RouteCollection[] */
-	protected $collections = [];
-	/** @var null|RouteCollection */
-	protected $collection = null;
-	/** @var null|string */
-	protected $collectionName = null;
-	/** @var null|RouteCollection */
-	protected $root = null;
-	/** @var null|UrlGenerator */
-	protected $generator = null;
-	/** @var string[]|null */
-	protected $routingFiles;
-	/** @var bool */
-	protected $loaded = false;
-	/** @var array */
-	protected $loadedApps = [];
-	/** @var ILogger */
-	protected $logger;
-	/** @var RequestContext */
-	protected $context;
-
-	/**
-	 * @param ILogger $logger
-	 */
-	public function __construct(ILogger $logger) {
-		$this->logger = $logger;
-		$baseUrl = \OC::$WEBROOT;
-		if (!(\OC::$server->getConfig()->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true')) {
-			$baseUrl .= '/index.php';
-		}
-		if (!\OC::$CLI && isset($_SERVER['REQUEST_METHOD'])) {
-			$method = $_SERVER['REQUEST_METHOD'];
-		} else {
-			$method = 'GET';
-		}
-		$request = \OC::$server->getRequest();
-		$host = $request->getServerHost();
-		$schema = $request->getServerProtocol();
-		$this->context = new RequestContext($baseUrl, $method, $host, $schema);
-		// TODO cache
-		$this->root = $this->getCollection('root');
-	}
-
-	/**
-	 * Get the files to load the routes from
-	 *
-	 * @return string[]
-	 */
-	public function getRoutingFiles() {
-		if ($this->routingFiles === null) {
-			$this->routingFiles = [];
-			foreach (\OC_APP::getEnabledApps() as $app) {
-				$appPath = \OC_App::getAppPath($app);
-				if ($appPath !== false) {
-					$file = $appPath . '/appinfo/routes.php';
-					if (file_exists($file)) {
-						$this->routingFiles[$app] = $file;
-					}
-				}
-			}
-		}
-		return $this->routingFiles;
-	}
-
-	/**
-	 * Loads the routes
-	 *
-	 * @param null|string $app
-	 */
-	public function loadRoutes($app = null) {
-		if (is_string($app)) {
-			$app = \OC_App::cleanAppId($app);
-		}
-
-		$requestedApp = $app;
-		if ($this->loaded) {
-			return;
-		}
-		if (is_null($app)) {
-			$this->loaded = true;
-			$routingFiles = $this->getRoutingFiles();
-		} else {
-			if (isset($this->loadedApps[$app])) {
-				return;
-			}
-			$file = \OC_App::getAppPath($app) . '/appinfo/routes.php';
-			if ($file !== false && file_exists($file)) {
-				$routingFiles = [$app => $file];
-			} else {
-				$routingFiles = [];
-			}
-		}
-		\OC::$server->getEventLogger()->start('loadroutes' . $requestedApp, 'Loading Routes');
-		foreach ($routingFiles as $app => $file) {
-			if (!isset($this->loadedApps[$app])) {
-				if (!\OC_App::isAppLoaded($app)) {
-					// app MUST be loaded before app routes
-					// try again next time loadRoutes() is called
-					$this->loaded = false;
-					continue;
-				}
-				$this->loadedApps[$app] = true;
-				$this->useCollection($app);
-				$this->requireRouteFile($file, $app);
-				$collection = $this->getCollection($app);
-				$this->root->addCollection($collection);
-
-				// Also add the OCS collection
-				$collection = $this->getCollection($app.'.ocs');
-				$collection->addPrefix('/ocsapp');
-				$this->root->addCollection($collection);
-			}
-		}
-		if (!isset($this->loadedApps['core'])) {
-			$this->loadedApps['core'] = true;
-			$this->useCollection('root');
-			require_once __DIR__ . '/../../../core/routes.php';
-
-			// Also add the OCS collection
-			$collection = $this->getCollection('root.ocs');
-			$collection->addPrefix('/ocsapp');
-			$this->root->addCollection($collection);
-		}
-		if ($this->loaded) {
-			$collection = $this->getCollection('ocs');
-			$collection->addPrefix('/ocs');
-			$this->root->addCollection($collection);
-		}
-		\OC::$server->getEventLogger()->end('loadroutes' . $requestedApp);
-	}
-
-	/**
-	 * @param string $name
-	 * @return \Symfony\Component\Routing\RouteCollection
-	 */
-	protected function getCollection($name) {
-		if (!isset($this->collections[$name])) {
-			$this->collections[$name] = new RouteCollection();
-		}
-		return $this->collections[$name];
-	}
-
-	/**
-	 * Sets the collection to use for adding routes
-	 *
-	 * @param string $name Name of the collection to use.
-	 * @return void
-	 */
-	public function useCollection($name) {
-		$this->collection = $this->getCollection($name);
-		$this->collectionName = $name;
-	}
-
-	/**
-	 * returns the current collection name in use for adding routes
-	 *
-	 * @return string the collection name
-	 */
-	public function getCurrentCollection() {
-		return $this->collectionName;
-	}
-
-
-	/**
-	 * Create a \OC\Route\Route.
-	 *
-	 * @param string $name Name of the route to create.
-	 * @param string $pattern The pattern to match
-	 * @param array $defaults An array of default parameter values
-	 * @param array $requirements An array of requirements for parameters (regexes)
-	 * @return \OC\Route\Route
-	 */
-	public function create($name,
-						   $pattern,
-						   array $defaults = [],
-						   array $requirements = []) {
-		$route = new Route($pattern, $defaults, $requirements);
-		$this->collection->add($name, $route);
-		return $route;
-	}
-
-	/**
-	 * Find the route matching $url
-	 *
-	 * @param string $url The url to find
-	 * @throws \Exception
-	 * @return array
-	 */
-	public function findMatchingRoute(string $url): array {
-		if (substr($url, 0, 6) === '/apps/') {
-			// empty string / 'apps' / $app / rest of the route
-			[, , $app,] = explode('/', $url, 4);
-
-			$app = \OC_App::cleanAppId($app);
-			\OC::$REQUESTEDAPP = $app;
-			$this->loadRoutes($app);
-		} elseif (substr($url, 0, 13) === '/ocsapp/apps/') {
-			// empty string / 'ocsapp' / 'apps' / $app / rest of the route
-			[, , , $app,] = explode('/', $url, 5);
-
-			$app = \OC_App::cleanAppId($app);
-			\OC::$REQUESTEDAPP = $app;
-			$this->loadRoutes($app);
-		} elseif (substr($url, 0, 10) === '/settings/') {
-			$this->loadRoutes('settings');
-		} elseif (substr($url, 0, 6) === '/core/') {
-			\OC::$REQUESTEDAPP = $url;
-			if (!\OC::$server->getConfig()->getSystemValueBool('maintenance') && !Util::needUpgrade()) {
-				\OC_App::loadApps();
-			}
-			$this->loadRoutes('core');
-		} else {
-			$this->loadRoutes();
-		}
-
-		$matcher = new UrlMatcher($this->root, $this->context);
-		try {
-			$parameters = $matcher->match($url);
-		} catch (ResourceNotFoundException $e) {
-			if (substr($url, -1) !== '/') {
-				// We allow links to apps/files? for backwards compatibility reasons
-				// However, since Symfony does not allow empty route names, the route
-				// we need to match is '/', so we need to append the '/' here.
-				try {
-					$parameters = $matcher->match($url . '/');
-				} catch (ResourceNotFoundException $newException) {
-					// If we still didn't match a route, we throw the original exception
-					throw $e;
-				}
-			} else {
-				throw $e;
-			}
-		}
-
-		return $parameters;
-	}
-
-	/**
-	 * Find and execute the route matching $url
-	 *
-	 * @param string $url The url to find
-	 * @throws \Exception
-	 * @return void
-	 */
-	public function match($url) {
-		$parameters = $this->findMatchingRoute($url);
-
-		\OC::$server->getEventLogger()->start('run_route', 'Run route');
-		if (isset($parameters['caller'])) {
-			$caller = $parameters['caller'];
-			unset($parameters['caller']);
-			unset($parameters['action']);
-			$application = $this->getApplicationClass($caller[0]);
-			\OC\AppFramework\App::main($caller[1], $caller[2], $application->getContainer(), $parameters);
-		} elseif (isset($parameters['action'])) {
-			$action = $parameters['action'];
-			if (!is_callable($action)) {
-				throw new \Exception('not a callable action');
-			}
-			unset($parameters['action']);
-			unset($parameters['caller']);
-			call_user_func($action, $parameters);
-		} elseif (isset($parameters['file'])) {
-			include $parameters['file'];
-		} else {
-			throw new \Exception('no action available');
-		}
-		\OC::$server->getEventLogger()->end('run_route');
-	}
-
-	/**
-	 * Get the url generator
-	 *
-	 * @return \Symfony\Component\Routing\Generator\UrlGenerator
-	 *
-	 */
-	public function getGenerator() {
-		if (null !== $this->generator) {
-			return $this->generator;
-		}
-
-		return $this->generator = new UrlGenerator($this->root, $this->context);
-	}
-
-	/**
-	 * Generate url based on $name and $parameters
-	 *
-	 * @param string $name Name of the route to use.
-	 * @param array $parameters Parameters for the route
-	 * @param bool $absolute
-	 * @return string
-	 */
-	public function generate($name,
-							 $parameters = [],
-							 $absolute = false) {
-		$referenceType = UrlGenerator::ABSOLUTE_URL;
-		if ($absolute === false) {
-			$referenceType = UrlGenerator::ABSOLUTE_PATH;
-		}
-		$name = $this->fixLegacyRootName($name);
-		if (strpos($name, '.') !== false) {
-			[$appName, $other] = explode('.', $name, 3);
-			// OCS routes are prefixed with "ocs."
-			if ($appName === 'ocs') {
-				$appName = $other;
-			}
-			$this->loadRoutes($appName);
-			try {
-				return $this->getGenerator()->generate($name, $parameters, $referenceType);
-			} catch (RouteNotFoundException $e) {
-			}
-		}
-
-		// Fallback load all routes
-		$this->loadRoutes();
-		try {
-			return $this->getGenerator()->generate($name, $parameters, $referenceType);
-		} catch (RouteNotFoundException $e) {
-			$this->logger->logException($e, ['level' => ILogger::INFO]);
-			return '';
-		}
-	}
-
-	protected function fixLegacyRootName(string $routeName): string {
-		if ($routeName === 'files.viewcontroller.showFile') {
-			return 'files.View.showFile';
-		}
-		if ($routeName === 'files_sharing.sharecontroller.showShare') {
-			return 'files_sharing.Share.showShare';
-		}
-		if ($routeName === 'files_sharing.sharecontroller.showAuthenticate') {
-			return 'files_sharing.Share.showAuthenticate';
-		}
-		if ($routeName === 'files_sharing.sharecontroller.authenticate') {
-			return 'files_sharing.Share.authenticate';
-		}
-		if ($routeName === 'files_sharing.sharecontroller.downloadShare') {
-			return 'files_sharing.Share.downloadShare';
-		}
-		if ($routeName === 'files_sharing.publicpreview.directLink') {
-			return 'files_sharing.PublicPreview.directLink';
-		}
-		if ($routeName === 'cloud_federation_api.requesthandlercontroller.addShare') {
-			return 'cloud_federation_api.RequestHandler.addShare';
-		}
-		if ($routeName === 'cloud_federation_api.requesthandlercontroller.receiveNotification') {
-			return 'cloud_federation_api.RequestHandler.receiveNotification';
-		}
-		return $routeName;
-	}
-
-	/**
-	 * To isolate the variable scope used inside the $file it is required in it's own method
-	 *
-	 * @param string $file the route file location to include
-	 * @param string $appName
-	 */
-	private function requireRouteFile($file, $appName) {
-		$this->setupRoutes(include_once $file, $appName);
-	}
-
-
-	/**
-	 * If a routes.php file returns an array, try to set up the application and
-	 * register the routes for the app. The application class will be chosen by
-	 * camelcasing the appname, e.g.: my_app will be turned into
-	 * \OCA\MyApp\AppInfo\Application. If that class does not exist, a default
-	 * App will be intialized. This makes it optional to ship an
-	 * appinfo/application.php by using the built in query resolver
-	 *
-	 * @param array $routes the application routes
-	 * @param string $appName the name of the app.
-	 */
-	private function setupRoutes($routes, $appName) {
-		if (is_array($routes)) {
-			$routeParser = new RouteParser();
-
-			$defaultRoutes = $routeParser->parseDefaultRoutes($routes, $appName);
-			$ocsRoutes = $routeParser->parseOCSRoutes($routes, $appName);
-
-			$this->root->addCollection($defaultRoutes);
-			$ocsRoutes->addPrefix('/ocsapp');
-			$this->root->addCollection($ocsRoutes);
-		}
-	}
-
-	private function getApplicationClass(string $appName) {
-		$appNameSpace = App::buildAppNamespace($appName);
-
-		$applicationClassName = $appNameSpace . '\\AppInfo\\Application';
-
-		if (class_exists($applicationClassName)) {
-			$application = \OC::$server->query($applicationClassName);
-		} else {
-			$application = new App($appName);
-		}
-
-		return $application;
-	}
+    /** @var RouteCollection[] */
+    protected $collections = [];
+    /** @var null|RouteCollection */
+    protected $collection = null;
+    /** @var null|string */
+    protected $collectionName = null;
+    /** @var null|RouteCollection */
+    protected $root = null;
+    /** @var null|UrlGenerator */
+    protected $generator = null;
+    /** @var string[]|null */
+    protected $routingFiles;
+    /** @var bool */
+    protected $loaded = false;
+    /** @var array */
+    protected $loadedApps = [];
+    /** @var ILogger */
+    protected $logger;
+    /** @var RequestContext */
+    protected $context;
+
+    /**
+     * @param ILogger $logger
+     */
+    public function __construct(ILogger $logger) {
+        $this->logger = $logger;
+        $baseUrl = \OC::$WEBROOT;
+        if (!(\OC::$server->getConfig()->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true')) {
+            $baseUrl .= '/index.php';
+        }
+        if (!\OC::$CLI && isset($_SERVER['REQUEST_METHOD'])) {
+            $method = $_SERVER['REQUEST_METHOD'];
+        } else {
+            $method = 'GET';
+        }
+        $request = \OC::$server->getRequest();
+        $host = $request->getServerHost();
+        $schema = $request->getServerProtocol();
+        $this->context = new RequestContext($baseUrl, $method, $host, $schema);
+        // TODO cache
+        $this->root = $this->getCollection('root');
+    }
+
+    /**
+     * Get the files to load the routes from
+     *
+     * @return string[]
+     */
+    public function getRoutingFiles() {
+        if ($this->routingFiles === null) {
+            $this->routingFiles = [];
+            foreach (\OC_APP::getEnabledApps() as $app) {
+                $appPath = \OC_App::getAppPath($app);
+                if ($appPath !== false) {
+                    $file = $appPath . '/appinfo/routes.php';
+                    if (file_exists($file)) {
+                        $this->routingFiles[$app] = $file;
+                    }
+                }
+            }
+        }
+        return $this->routingFiles;
+    }
+
+    /**
+     * Loads the routes
+     *
+     * @param null|string $app
+     */
+    public function loadRoutes($app = null) {
+        if (is_string($app)) {
+            $app = \OC_App::cleanAppId($app);
+        }
+
+        $requestedApp = $app;
+        if ($this->loaded) {
+            return;
+        }
+        if (is_null($app)) {
+            $this->loaded = true;
+            $routingFiles = $this->getRoutingFiles();
+        } else {
+            if (isset($this->loadedApps[$app])) {
+                return;
+            }
+            $file = \OC_App::getAppPath($app) . '/appinfo/routes.php';
+            if ($file !== false && file_exists($file)) {
+                $routingFiles = [$app => $file];
+            } else {
+                $routingFiles = [];
+            }
+        }
+        \OC::$server->getEventLogger()->start('loadroutes' . $requestedApp, 'Loading Routes');
+        foreach ($routingFiles as $app => $file) {
+            if (!isset($this->loadedApps[$app])) {
+                if (!\OC_App::isAppLoaded($app)) {
+                    // app MUST be loaded before app routes
+                    // try again next time loadRoutes() is called
+                    $this->loaded = false;
+                    continue;
+                }
+                $this->loadedApps[$app] = true;
+                $this->useCollection($app);
+                $this->requireRouteFile($file, $app);
+                $collection = $this->getCollection($app);
+                $this->root->addCollection($collection);
+
+                // Also add the OCS collection
+                $collection = $this->getCollection($app.'.ocs');
+                $collection->addPrefix('/ocsapp');
+                $this->root->addCollection($collection);
+            }
+        }
+        if (!isset($this->loadedApps['core'])) {
+            $this->loadedApps['core'] = true;
+            $this->useCollection('root');
+            require_once __DIR__ . '/../../../core/routes.php';
+
+            // Also add the OCS collection
+            $collection = $this->getCollection('root.ocs');
+            $collection->addPrefix('/ocsapp');
+            $this->root->addCollection($collection);
+        }
+        if ($this->loaded) {
+            $collection = $this->getCollection('ocs');
+            $collection->addPrefix('/ocs');
+            $this->root->addCollection($collection);
+        }
+        \OC::$server->getEventLogger()->end('loadroutes' . $requestedApp);
+    }
+
+    /**
+     * @param string $name
+     * @return \Symfony\Component\Routing\RouteCollection
+     */
+    protected function getCollection($name) {
+        if (!isset($this->collections[$name])) {
+            $this->collections[$name] = new RouteCollection();
+        }
+        return $this->collections[$name];
+    }
+
+    /**
+     * Sets the collection to use for adding routes
+     *
+     * @param string $name Name of the collection to use.
+     * @return void
+     */
+    public function useCollection($name) {
+        $this->collection = $this->getCollection($name);
+        $this->collectionName = $name;
+    }
+
+    /**
+     * returns the current collection name in use for adding routes
+     *
+     * @return string the collection name
+     */
+    public function getCurrentCollection() {
+        return $this->collectionName;
+    }
+
+
+    /**
+     * Create a \OC\Route\Route.
+     *
+     * @param string $name Name of the route to create.
+     * @param string $pattern The pattern to match
+     * @param array $defaults An array of default parameter values
+     * @param array $requirements An array of requirements for parameters (regexes)
+     * @return \OC\Route\Route
+     */
+    public function create($name,
+                            $pattern,
+                            array $defaults = [],
+                            array $requirements = []) {
+        $route = new Route($pattern, $defaults, $requirements);
+        $this->collection->add($name, $route);
+        return $route;
+    }
+
+    /**
+     * Find the route matching $url
+     *
+     * @param string $url The url to find
+     * @throws \Exception
+     * @return array
+     */
+    public function findMatchingRoute(string $url): array {
+        if (substr($url, 0, 6) === '/apps/') {
+            // empty string / 'apps' / $app / rest of the route
+            [, , $app,] = explode('/', $url, 4);
+
+            $app = \OC_App::cleanAppId($app);
+            \OC::$REQUESTEDAPP = $app;
+            $this->loadRoutes($app);
+        } elseif (substr($url, 0, 13) === '/ocsapp/apps/') {
+            // empty string / 'ocsapp' / 'apps' / $app / rest of the route
+            [, , , $app,] = explode('/', $url, 5);
+
+            $app = \OC_App::cleanAppId($app);
+            \OC::$REQUESTEDAPP = $app;
+            $this->loadRoutes($app);
+        } elseif (substr($url, 0, 10) === '/settings/') {
+            $this->loadRoutes('settings');
+        } elseif (substr($url, 0, 6) === '/core/') {
+            \OC::$REQUESTEDAPP = $url;
+            if (!\OC::$server->getConfig()->getSystemValueBool('maintenance') && !Util::needUpgrade()) {
+                \OC_App::loadApps();
+            }
+            $this->loadRoutes('core');
+        } else {
+            $this->loadRoutes();
+        }
+
+        $matcher = new UrlMatcher($this->root, $this->context);
+        try {
+            $parameters = $matcher->match($url);
+        } catch (ResourceNotFoundException $e) {
+            if (substr($url, -1) !== '/') {
+                // We allow links to apps/files? for backwards compatibility reasons
+                // However, since Symfony does not allow empty route names, the route
+                // we need to match is '/', so we need to append the '/' here.
+                try {
+                    $parameters = $matcher->match($url . '/');
+                } catch (ResourceNotFoundException $newException) {
+                    // If we still didn't match a route, we throw the original exception
+                    throw $e;
+                }
+            } else {
+                throw $e;
+            }
+        }
+
+        return $parameters;
+    }
+
+    /**
+     * Find and execute the route matching $url
+     *
+     * @param string $url The url to find
+     * @throws \Exception
+     * @return void
+     */
+    public function match($url) {
+        $parameters = $this->findMatchingRoute($url);
+
+        \OC::$server->getEventLogger()->start('run_route', 'Run route');
+        if (isset($parameters['caller'])) {
+            $caller = $parameters['caller'];
+            unset($parameters['caller']);
+            unset($parameters['action']);
+            $application = $this->getApplicationClass($caller[0]);
+            \OC\AppFramework\App::main($caller[1], $caller[2], $application->getContainer(), $parameters);
+        } elseif (isset($parameters['action'])) {
+            $action = $parameters['action'];
+            if (!is_callable($action)) {
+                throw new \Exception('not a callable action');
+            }
+            unset($parameters['action']);
+            unset($parameters['caller']);
+            call_user_func($action, $parameters);
+        } elseif (isset($parameters['file'])) {
+            include $parameters['file'];
+        } else {
+            throw new \Exception('no action available');
+        }
+        \OC::$server->getEventLogger()->end('run_route');
+    }
+
+    /**
+     * Get the url generator
+     *
+     * @return \Symfony\Component\Routing\Generator\UrlGenerator
+     *
+     */
+    public function getGenerator() {
+        if (null !== $this->generator) {
+            return $this->generator;
+        }
+
+        return $this->generator = new UrlGenerator($this->root, $this->context);
+    }
+
+    /**
+     * Generate url based on $name and $parameters
+     *
+     * @param string $name Name of the route to use.
+     * @param array $parameters Parameters for the route
+     * @param bool $absolute
+     * @return string
+     */
+    public function generate($name,
+                                $parameters = [],
+                                $absolute = false) {
+        $referenceType = UrlGenerator::ABSOLUTE_URL;
+        if ($absolute === false) {
+            $referenceType = UrlGenerator::ABSOLUTE_PATH;
+        }
+        $name = $this->fixLegacyRootName($name);
+        if (strpos($name, '.') !== false) {
+            [$appName, $other] = explode('.', $name, 3);
+            // OCS routes are prefixed with "ocs."
+            if ($appName === 'ocs') {
+                $appName = $other;
+            }
+            $this->loadRoutes($appName);
+            try {
+                return $this->getGenerator()->generate($name, $parameters, $referenceType);
+            } catch (RouteNotFoundException $e) {
+            }
+        }
+
+        // Fallback load all routes
+        $this->loadRoutes();
+        try {
+            return $this->getGenerator()->generate($name, $parameters, $referenceType);
+        } catch (RouteNotFoundException $e) {
+            $this->logger->logException($e, ['level' => ILogger::INFO]);
+            return '';
+        }
+    }
+
+    protected function fixLegacyRootName(string $routeName): string {
+        if ($routeName === 'files.viewcontroller.showFile') {
+            return 'files.View.showFile';
+        }
+        if ($routeName === 'files_sharing.sharecontroller.showShare') {
+            return 'files_sharing.Share.showShare';
+        }
+        if ($routeName === 'files_sharing.sharecontroller.showAuthenticate') {
+            return 'files_sharing.Share.showAuthenticate';
+        }
+        if ($routeName === 'files_sharing.sharecontroller.authenticate') {
+            return 'files_sharing.Share.authenticate';
+        }
+        if ($routeName === 'files_sharing.sharecontroller.downloadShare') {
+            return 'files_sharing.Share.downloadShare';
+        }
+        if ($routeName === 'files_sharing.publicpreview.directLink') {
+            return 'files_sharing.PublicPreview.directLink';
+        }
+        if ($routeName === 'cloud_federation_api.requesthandlercontroller.addShare') {
+            return 'cloud_federation_api.RequestHandler.addShare';
+        }
+        if ($routeName === 'cloud_federation_api.requesthandlercontroller.receiveNotification') {
+            return 'cloud_federation_api.RequestHandler.receiveNotification';
+        }
+        return $routeName;
+    }
+
+    /**
+     * To isolate the variable scope used inside the $file it is required in it's own method
+     *
+     * @param string $file the route file location to include
+     * @param string $appName
+     */
+    private function requireRouteFile($file, $appName) {
+        $this->setupRoutes(include_once $file, $appName);
+    }
+
+
+    /**
+     * If a routes.php file returns an array, try to set up the application and
+     * register the routes for the app. The application class will be chosen by
+     * camelcasing the appname, e.g.: my_app will be turned into
+     * \OCA\MyApp\AppInfo\Application. If that class does not exist, a default
+     * App will be intialized. This makes it optional to ship an
+     * appinfo/application.php by using the built in query resolver
+     *
+     * @param array $routes the application routes
+     * @param string $appName the name of the app.
+     */
+    private function setupRoutes($routes, $appName) {
+        if (is_array($routes)) {
+            $routeParser = new RouteParser();
+
+            $defaultRoutes = $routeParser->parseDefaultRoutes($routes, $appName);
+            $ocsRoutes = $routeParser->parseOCSRoutes($routes, $appName);
+
+            $this->root->addCollection($defaultRoutes);
+            $ocsRoutes->addPrefix('/ocsapp');
+            $this->root->addCollection($ocsRoutes);
+        }
+    }
+
+    private function getApplicationClass(string $appName) {
+        $appNameSpace = App::buildAppNamespace($appName);
+
+        $applicationClassName = $appNameSpace . '\\AppInfo\\Application';
+
+        if (class_exists($applicationClassName)) {
+            $application = \OC::$server->query($applicationClassName);
+        } else {
+            $application = new App($appName);
+        }
+
+        return $application;
+    }
 }

lib/private/User/User.php

Indentation +450 added lines, -450 removed lines

@@ -58,454 +58,454 @@
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class User implements IUser {
-	/** @var string */
-	private $uid;
-
-	/** @var string|null */
-	private $displayName;
-
-	/** @var UserInterface|null */
-	private $backend;
-	/** @var EventDispatcherInterface */
-	private $legacyDispatcher;
-
-	/** @var IEventDispatcher */
-	private $dispatcher;
-
-	/** @var bool */
-	private $enabled;
-
-	/** @var Emitter|Manager */
-	private $emitter;
-
-	/** @var string */
-	private $home;
-
-	/** @var int */
-	private $lastLogin;
-
-	/** @var \OCP\IConfig */
-	private $config;
-
-	/** @var IAvatarManager */
-	private $avatarManager;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	public function __construct(string $uid, ?UserInterface $backend, EventDispatcherInterface $dispatcher, $emitter = null, IConfig $config = null, $urlGenerator = null) {
-		$this->uid = $uid;
-		$this->backend = $backend;
-		$this->legacyDispatcher = $dispatcher;
-		$this->emitter = $emitter;
-		if (is_null($config)) {
-			$config = \OC::$server->getConfig();
-		}
-		$this->config = $config;
-		$this->urlGenerator = $urlGenerator;
-		$enabled = $this->config->getUserValue($uid, 'core', 'enabled', 'true');
-		$this->enabled = ($enabled === 'true');
-		$this->lastLogin = $this->config->getUserValue($uid, 'login', 'lastLogin', 0);
-		if (is_null($this->urlGenerator)) {
-			$this->urlGenerator = \OC::$server->getURLGenerator();
-		}
-		// TODO: inject
-		$this->dispatcher = \OC::$server->query(IEventDispatcher::class);
-	}
-
-	/**
-	 * get the user id
-	 *
-	 * @return string
-	 */
-	public function getUID() {
-		return $this->uid;
-	}
-
-	/**
-	 * get the display name for the user, if no specific display name is set it will fallback to the user id
-	 *
-	 * @return string
-	 */
-	public function getDisplayName() {
-		if ($this->displayName === null) {
-			$displayName = '';
-			if ($this->backend && $this->backend->implementsActions(Backend::GET_DISPLAYNAME)) {
-				// get display name and strip whitespace from the beginning and end of it
-				$backendDisplayName = $this->backend->getDisplayName($this->uid);
-				if (is_string($backendDisplayName)) {
-					$displayName = trim($backendDisplayName);
-				}
-			}
-
-			if (!empty($displayName)) {
-				$this->displayName = $displayName;
-			} else {
-				$this->displayName = $this->uid;
-			}
-		}
-		return $this->displayName;
-	}
-
-	/**
-	 * set the displayname for the user
-	 *
-	 * @param string $displayName
-	 * @return bool
-	 */
-	public function setDisplayName($displayName) {
-		$displayName = trim($displayName);
-		$oldDisplayName = $this->getDisplayName();
-		if ($this->backend->implementsActions(Backend::SET_DISPLAYNAME) && !empty($displayName) && $displayName !== $oldDisplayName) {
-			$result = $this->backend->setDisplayName($this->uid, $displayName);
-			if ($result) {
-				$this->displayName = $displayName;
-				$this->triggerChange('displayName', $displayName, $oldDisplayName);
-			}
-			return $result !== false;
-		}
-		return false;
-	}
-
-	/**
-	 * set the email address of the user
-	 *
-	 * @param string|null $mailAddress
-	 * @return void
-	 * @since 9.0.0
-	 */
-	public function setEMailAddress($mailAddress) {
-		$oldMailAddress = $this->getEMailAddress();
-		if ($oldMailAddress !== $mailAddress) {
-			if ($mailAddress === '') {
-				$this->config->deleteUserValue($this->uid, 'settings', 'email');
-			} else {
-				$this->config->setUserValue($this->uid, 'settings', 'email', $mailAddress);
-			}
-			$this->triggerChange('eMailAddress', $mailAddress, $oldMailAddress);
-		}
-	}
-
-	/**
-	 * returns the timestamp of the user's last login or 0 if the user did never
-	 * login
-	 *
-	 * @return int
-	 */
-	public function getLastLogin() {
-		return $this->lastLogin;
-	}
-
-	/**
-	 * updates the timestamp of the most recent login of this user
-	 */
-	public function updateLastLoginTimestamp() {
-		$firstTimeLogin = ($this->lastLogin === 0);
-		$this->lastLogin = time();
-		$this->config->setUserValue(
-			$this->uid, 'login', 'lastLogin', $this->lastLogin);
-
-		return $firstTimeLogin;
-	}
-
-	/**
-	 * Delete the user
-	 *
-	 * @return bool
-	 */
-	public function delete() {
-		/** @deprecated 21.0.0 use BeforeUserDeletedEvent event with the IEventDispatcher instead */
-		$this->legacyDispatcher->dispatch(IUser::class . '::preDelete', new GenericEvent($this));
-		if ($this->emitter) {
-			/** @deprecated 21.0.0 use BeforeUserDeletedEvent event with the IEventDispatcher instead */
-			$this->emitter->emit('\OC\User', 'preDelete', [$this]);
-		}
-		$this->dispatcher->dispatchTyped(new BeforeUserDeletedEvent($this));
-		// get the home now because it won't return it after user deletion
-		$homePath = $this->getHome();
-		$result = $this->backend->deleteUser($this->uid);
-		if ($result) {
-
-			// FIXME: Feels like an hack - suggestions?
-
-			$groupManager = \OC::$server->getGroupManager();
-			// We have to delete the user from all groups
-			foreach ($groupManager->getUserGroupIds($this) as $groupId) {
-				$group = $groupManager->get($groupId);
-				if ($group) {
-					$this->dispatcher->dispatchTyped(new BeforeUserRemovedEvent($group, $this));
-					$group->removeUser($this);
-					$this->dispatcher->dispatchTyped(new UserRemovedEvent($group, $this));
-				}
-			}
-			// Delete the user's keys in preferences
-			\OC::$server->getConfig()->deleteAllUserValues($this->uid);
-
-			// Delete user files in /data/
-			if ($homePath !== false) {
-				// FIXME: this operates directly on FS, should use View instead...
-				// also this is not testable/mockable...
-				\OC_Helper::rmdirr($homePath);
-			}
-
-			// Delete the users entry in the storage table
-			Storage::remove('home::' . $this->uid);
-
-			\OC::$server->getCommentsManager()->deleteReferencesOfActor('users', $this->uid);
-			\OC::$server->getCommentsManager()->deleteReadMarksFromUser($this);
-
-			/** @var IAvatarManager $avatarManager */
-			$avatarManager = \OC::$server->query(AvatarManager::class);
-			$avatarManager->deleteUserAvatar($this->uid);
-
-			$notification = \OC::$server->getNotificationManager()->createNotification();
-			$notification->setUser($this->uid);
-			\OC::$server->getNotificationManager()->markProcessed($notification);
-
-			/** @var AccountManager $accountManager */
-			$accountManager = \OC::$server->query(AccountManager::class);
-			$accountManager->deleteUser($this);
-
-			/** @deprecated 21.0.0 use UserDeletedEvent event with the IEventDispatcher instead */
-			$this->legacyDispatcher->dispatch(IUser::class . '::postDelete', new GenericEvent($this));
-			if ($this->emitter) {
-				/** @deprecated 21.0.0 use UserDeletedEvent event with the IEventDispatcher instead */
-				$this->emitter->emit('\OC\User', 'postDelete', [$this]);
-			}
-			$this->dispatcher->dispatchTyped(new UserDeletedEvent($this));
-		}
-		return !($result === false);
-	}
-
-	/**
-	 * Set the password of the user
-	 *
-	 * @param string $password
-	 * @param string $recoveryPassword for the encryption app to reset encryption keys
-	 * @return bool
-	 */
-	public function setPassword($password, $recoveryPassword = null) {
-		$this->legacyDispatcher->dispatch(IUser::class . '::preSetPassword', new GenericEvent($this, [
-			'password' => $password,
-			'recoveryPassword' => $recoveryPassword,
-		]));
-		if ($this->emitter) {
-			$this->emitter->emit('\OC\User', 'preSetPassword', [$this, $password, $recoveryPassword]);
-		}
-		if ($this->backend->implementsActions(Backend::SET_PASSWORD)) {
-			$result = $this->backend->setPassword($this->uid, $password);
-			$this->legacyDispatcher->dispatch(IUser::class . '::postSetPassword', new GenericEvent($this, [
-				'password' => $password,
-				'recoveryPassword' => $recoveryPassword,
-			]));
-			if ($this->emitter) {
-				$this->emitter->emit('\OC\User', 'postSetPassword', [$this, $password, $recoveryPassword]);
-			}
-			return !($result === false);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * get the users home folder to mount
-	 *
-	 * @return string
-	 */
-	public function getHome() {
-		if (!$this->home) {
-			if ($this->backend->implementsActions(Backend::GET_HOME) and $home = $this->backend->getHome($this->uid)) {
-				$this->home = $home;
-			} elseif ($this->config) {
-				$this->home = $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $this->uid;
-			} else {
-				$this->home = \OC::$SERVERROOT . '/data/' . $this->uid;
-			}
-		}
-		return $this->home;
-	}
-
-	/**
-	 * Get the name of the backend class the user is connected with
-	 *
-	 * @return string
-	 */
-	public function getBackendClassName() {
-		if ($this->backend instanceof IUserBackend) {
-			return $this->backend->getBackendName();
-		}
-		return get_class($this->backend);
-	}
-
-	public function getBackend() {
-		return $this->backend;
-	}
-
-	/**
-	 * check if the backend allows the user to change his avatar on Personal page
-	 *
-	 * @return bool
-	 */
-	public function canChangeAvatar() {
-		if ($this->backend->implementsActions(Backend::PROVIDE_AVATAR)) {
-			return $this->backend->canChangeAvatar($this->uid);
-		}
-		return true;
-	}
-
-	/**
-	 * check if the backend supports changing passwords
-	 *
-	 * @return bool
-	 */
-	public function canChangePassword() {
-		return $this->backend->implementsActions(Backend::SET_PASSWORD);
-	}
-
-	/**
-	 * check if the backend supports changing display names
-	 *
-	 * @return bool
-	 */
-	public function canChangeDisplayName() {
-		if ($this->config->getSystemValue('allow_user_to_change_display_name') === false) {
-			return false;
-		}
-		return $this->backend->implementsActions(Backend::SET_DISPLAYNAME);
-	}
-
-	/**
-	 * check if the user is enabled
-	 *
-	 * @return bool
-	 */
-	public function isEnabled() {
-		return $this->enabled;
-	}
-
-	/**
-	 * set the enabled status for the user
-	 *
-	 * @param bool $enabled
-	 */
-	public function setEnabled(bool $enabled = true) {
-		$oldStatus = $this->isEnabled();
-		$this->enabled = $enabled;
-		if ($oldStatus !== $this->enabled) {
-			// TODO: First change the value, then trigger the event as done for all other properties.
-			$this->triggerChange('enabled', $enabled, $oldStatus);
-			$this->config->setUserValue($this->uid, 'core', 'enabled', $enabled ? 'true' : 'false');
-		}
-	}
-
-	/**
-	 * get the users email address
-	 *
-	 * @return string|null
-	 * @since 9.0.0
-	 */
-	public function getEMailAddress() {
-		return $this->config->getUserValue($this->uid, 'settings', 'email', null);
-	}
-
-	/**
-	 * get the users' quota
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getQuota() {
-		// allow apps to modify the user quota by hooking into the event
-		$event = new GetQuotaEvent($this);
-		$this->dispatcher->dispatchTyped($event);
-		$overwriteQuota = $event->getQuota();
-		if ($overwriteQuota) {
-			$quota = $overwriteQuota;
-		} else {
-			$quota = $this->config->getUserValue($this->uid, 'files', 'quota', 'default');
-		}
-		if ($quota === 'default') {
-			$quota = $this->config->getAppValue('files', 'default_quota', 'none');
-		}
-		return $quota;
-	}
-
-	/**
-	 * set the users' quota
-	 *
-	 * @param string $quota
-	 * @return void
-	 * @since 9.0.0
-	 */
-	public function setQuota($quota) {
-		$oldQuota = $this->config->getUserValue($this->uid, 'files', 'quota', '');
-		if ($quota !== 'none' and $quota !== 'default') {
-			$quota = OC_Helper::computerFileSize($quota);
-			$quota = OC_Helper::humanFileSize($quota);
-		}
-		if ($quota !== $oldQuota) {
-			$this->config->setUserValue($this->uid, 'files', 'quota', $quota);
-			$this->triggerChange('quota', $quota, $oldQuota);
-		}
-	}
-
-	/**
-	 * get the avatar image if it exists
-	 *
-	 * @param int $size
-	 * @return IImage|null
-	 * @since 9.0.0
-	 */
-	public function getAvatarImage($size) {
-		// delay the initialization
-		if (is_null($this->avatarManager)) {
-			$this->avatarManager = \OC::$server->getAvatarManager();
-		}
-
-		$avatar = $this->avatarManager->getAvatar($this->uid);
-		$image = $avatar->get(-1);
-		if ($image) {
-			return $image;
-		}
-
-		return null;
-	}
-
-	/**
-	 * get the federation cloud id
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getCloudId() {
-		$uid = $this->getUID();
-		$server = $this->urlGenerator->getAbsoluteURL('/');
-		$server = rtrim($this->removeProtocolFromUrl($server), '/');
-		return \OC::$server->getCloudIdManager()->getCloudId($uid, $server)->getId();
-	}
-
-	/**
-	 * @param string $url
-	 * @return string
-	 */
-	private function removeProtocolFromUrl($url) {
-		if (strpos($url, 'https://') === 0) {
-			return substr($url, strlen('https://'));
-		} elseif (strpos($url, 'http://') === 0) {
-			return substr($url, strlen('http://'));
-		}
-
-		return $url;
-	}
-
-	public function triggerChange($feature, $value = null, $oldValue = null) {
-		$this->legacyDispatcher->dispatch(IUser::class . '::changeUser', new GenericEvent($this, [
-			'feature' => $feature,
-			'value' => $value,
-			'oldValue' => $oldValue,
-		]));
-		if ($this->emitter) {
-			$this->emitter->emit('\OC\User', 'changeUser', [$this, $feature, $value, $oldValue]);
-		}
-	}
+    /** @var string */
+    private $uid;
+
+    /** @var string|null */
+    private $displayName;
+
+    /** @var UserInterface|null */
+    private $backend;
+    /** @var EventDispatcherInterface */
+    private $legacyDispatcher;
+
+    /** @var IEventDispatcher */
+    private $dispatcher;
+
+    /** @var bool */
+    private $enabled;
+
+    /** @var Emitter|Manager */
+    private $emitter;
+
+    /** @var string */
+    private $home;
+
+    /** @var int */
+    private $lastLogin;
+
+    /** @var \OCP\IConfig */
+    private $config;
+
+    /** @var IAvatarManager */
+    private $avatarManager;
+
+    /** @var IURLGenerator */
+    private $urlGenerator;
+
+    public function __construct(string $uid, ?UserInterface $backend, EventDispatcherInterface $dispatcher, $emitter = null, IConfig $config = null, $urlGenerator = null) {
+        $this->uid = $uid;
+        $this->backend = $backend;
+        $this->legacyDispatcher = $dispatcher;
+        $this->emitter = $emitter;
+        if (is_null($config)) {
+            $config = \OC::$server->getConfig();
+        }
+        $this->config = $config;
+        $this->urlGenerator = $urlGenerator;
+        $enabled = $this->config->getUserValue($uid, 'core', 'enabled', 'true');
+        $this->enabled = ($enabled === 'true');
+        $this->lastLogin = $this->config->getUserValue($uid, 'login', 'lastLogin', 0);
+        if (is_null($this->urlGenerator)) {
+            $this->urlGenerator = \OC::$server->getURLGenerator();
+        }
+        // TODO: inject
+        $this->dispatcher = \OC::$server->query(IEventDispatcher::class);
+    }
+
+    /**
+     * get the user id
+     *
+     * @return string
+     */
+    public function getUID() {
+        return $this->uid;
+    }
+
+    /**
+     * get the display name for the user, if no specific display name is set it will fallback to the user id
+     *
+     * @return string
+     */
+    public function getDisplayName() {
+        if ($this->displayName === null) {
+            $displayName = '';
+            if ($this->backend && $this->backend->implementsActions(Backend::GET_DISPLAYNAME)) {
+                // get display name and strip whitespace from the beginning and end of it
+                $backendDisplayName = $this->backend->getDisplayName($this->uid);
+                if (is_string($backendDisplayName)) {
+                    $displayName = trim($backendDisplayName);
+                }
+            }
+
+            if (!empty($displayName)) {
+                $this->displayName = $displayName;
+            } else {
+                $this->displayName = $this->uid;
+            }
+        }
+        return $this->displayName;
+    }
+
+    /**
+     * set the displayname for the user
+     *
+     * @param string $displayName
+     * @return bool
+     */
+    public function setDisplayName($displayName) {
+        $displayName = trim($displayName);
+        $oldDisplayName = $this->getDisplayName();
+        if ($this->backend->implementsActions(Backend::SET_DISPLAYNAME) && !empty($displayName) && $displayName !== $oldDisplayName) {
+            $result = $this->backend->setDisplayName($this->uid, $displayName);
+            if ($result) {
+                $this->displayName = $displayName;
+                $this->triggerChange('displayName', $displayName, $oldDisplayName);
+            }
+            return $result !== false;
+        }
+        return false;
+    }
+
+    /**
+     * set the email address of the user
+     *
+     * @param string|null $mailAddress
+     * @return void
+     * @since 9.0.0
+     */
+    public function setEMailAddress($mailAddress) {
+        $oldMailAddress = $this->getEMailAddress();
+        if ($oldMailAddress !== $mailAddress) {
+            if ($mailAddress === '') {
+                $this->config->deleteUserValue($this->uid, 'settings', 'email');
+            } else {
+                $this->config->setUserValue($this->uid, 'settings', 'email', $mailAddress);
+            }
+            $this->triggerChange('eMailAddress', $mailAddress, $oldMailAddress);
+        }
+    }
+
+    /**
+     * returns the timestamp of the user's last login or 0 if the user did never
+     * login
+     *
+     * @return int
+     */
+    public function getLastLogin() {
+        return $this->lastLogin;
+    }
+
+    /**
+     * updates the timestamp of the most recent login of this user
+     */
+    public function updateLastLoginTimestamp() {
+        $firstTimeLogin = ($this->lastLogin === 0);
+        $this->lastLogin = time();
+        $this->config->setUserValue(
+            $this->uid, 'login', 'lastLogin', $this->lastLogin);
+
+        return $firstTimeLogin;
+    }
+
+    /**
+     * Delete the user
+     *
+     * @return bool
+     */
+    public function delete() {
+        /** @deprecated 21.0.0 use BeforeUserDeletedEvent event with the IEventDispatcher instead */
+        $this->legacyDispatcher->dispatch(IUser::class . '::preDelete', new GenericEvent($this));
+        if ($this->emitter) {
+            /** @deprecated 21.0.0 use BeforeUserDeletedEvent event with the IEventDispatcher instead */
+            $this->emitter->emit('\OC\User', 'preDelete', [$this]);
+        }
+        $this->dispatcher->dispatchTyped(new BeforeUserDeletedEvent($this));
+        // get the home now because it won't return it after user deletion
+        $homePath = $this->getHome();
+        $result = $this->backend->deleteUser($this->uid);
+        if ($result) {
+
+            // FIXME: Feels like an hack - suggestions?
+
+            $groupManager = \OC::$server->getGroupManager();
+            // We have to delete the user from all groups
+            foreach ($groupManager->getUserGroupIds($this) as $groupId) {
+                $group = $groupManager->get($groupId);
+                if ($group) {
+                    $this->dispatcher->dispatchTyped(new BeforeUserRemovedEvent($group, $this));
+                    $group->removeUser($this);
+                    $this->dispatcher->dispatchTyped(new UserRemovedEvent($group, $this));
+                }
+            }
+            // Delete the user's keys in preferences
+            \OC::$server->getConfig()->deleteAllUserValues($this->uid);
+
+            // Delete user files in /data/
+            if ($homePath !== false) {
+                // FIXME: this operates directly on FS, should use View instead...
+                // also this is not testable/mockable...
+                \OC_Helper::rmdirr($homePath);
+            }
+
+            // Delete the users entry in the storage table
+            Storage::remove('home::' . $this->uid);
+
+            \OC::$server->getCommentsManager()->deleteReferencesOfActor('users', $this->uid);
+            \OC::$server->getCommentsManager()->deleteReadMarksFromUser($this);
+
+            /** @var IAvatarManager $avatarManager */
+            $avatarManager = \OC::$server->query(AvatarManager::class);
+            $avatarManager->deleteUserAvatar($this->uid);
+
+            $notification = \OC::$server->getNotificationManager()->createNotification();
+            $notification->setUser($this->uid);
+            \OC::$server->getNotificationManager()->markProcessed($notification);
+
+            /** @var AccountManager $accountManager */
+            $accountManager = \OC::$server->query(AccountManager::class);
+            $accountManager->deleteUser($this);
+
+            /** @deprecated 21.0.0 use UserDeletedEvent event with the IEventDispatcher instead */
+            $this->legacyDispatcher->dispatch(IUser::class . '::postDelete', new GenericEvent($this));
+            if ($this->emitter) {
+                /** @deprecated 21.0.0 use UserDeletedEvent event with the IEventDispatcher instead */
+                $this->emitter->emit('\OC\User', 'postDelete', [$this]);
+            }
+            $this->dispatcher->dispatchTyped(new UserDeletedEvent($this));
+        }
+        return !($result === false);
+    }
+
+    /**
+     * Set the password of the user
+     *
+     * @param string $password
+     * @param string $recoveryPassword for the encryption app to reset encryption keys
+     * @return bool
+     */
+    public function setPassword($password, $recoveryPassword = null) {
+        $this->legacyDispatcher->dispatch(IUser::class . '::preSetPassword', new GenericEvent($this, [
+            'password' => $password,
+            'recoveryPassword' => $recoveryPassword,
+        ]));
+        if ($this->emitter) {
+            $this->emitter->emit('\OC\User', 'preSetPassword', [$this, $password, $recoveryPassword]);
+        }
+        if ($this->backend->implementsActions(Backend::SET_PASSWORD)) {
+            $result = $this->backend->setPassword($this->uid, $password);
+            $this->legacyDispatcher->dispatch(IUser::class . '::postSetPassword', new GenericEvent($this, [
+                'password' => $password,
+                'recoveryPassword' => $recoveryPassword,
+            ]));
+            if ($this->emitter) {
+                $this->emitter->emit('\OC\User', 'postSetPassword', [$this, $password, $recoveryPassword]);
+            }
+            return !($result === false);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * get the users home folder to mount
+     *
+     * @return string
+     */
+    public function getHome() {
+        if (!$this->home) {
+            if ($this->backend->implementsActions(Backend::GET_HOME) and $home = $this->backend->getHome($this->uid)) {
+                $this->home = $home;
+            } elseif ($this->config) {
+                $this->home = $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $this->uid;
+            } else {
+                $this->home = \OC::$SERVERROOT . '/data/' . $this->uid;
+            }
+        }
+        return $this->home;
+    }
+
+    /**
+     * Get the name of the backend class the user is connected with
+     *
+     * @return string
+     */
+    public function getBackendClassName() {
+        if ($this->backend instanceof IUserBackend) {
+            return $this->backend->getBackendName();
+        }
+        return get_class($this->backend);
+    }
+
+    public function getBackend() {
+        return $this->backend;
+    }
+
+    /**
+     * check if the backend allows the user to change his avatar on Personal page
+     *
+     * @return bool
+     */
+    public function canChangeAvatar() {
+        if ($this->backend->implementsActions(Backend::PROVIDE_AVATAR)) {
+            return $this->backend->canChangeAvatar($this->uid);
+        }
+        return true;
+    }
+
+    /**
+     * check if the backend supports changing passwords
+     *
+     * @return bool
+     */
+    public function canChangePassword() {
+        return $this->backend->implementsActions(Backend::SET_PASSWORD);
+    }
+
+    /**
+     * check if the backend supports changing display names
+     *
+     * @return bool
+     */
+    public function canChangeDisplayName() {
+        if ($this->config->getSystemValue('allow_user_to_change_display_name') === false) {
+            return false;
+        }
+        return $this->backend->implementsActions(Backend::SET_DISPLAYNAME);
+    }
+
+    /**
+     * check if the user is enabled
+     *
+     * @return bool
+     */
+    public function isEnabled() {
+        return $this->enabled;
+    }
+
+    /**
+     * set the enabled status for the user
+     *
+     * @param bool $enabled
+     */
+    public function setEnabled(bool $enabled = true) {
+        $oldStatus = $this->isEnabled();
+        $this->enabled = $enabled;
+        if ($oldStatus !== $this->enabled) {
+            // TODO: First change the value, then trigger the event as done for all other properties.
+            $this->triggerChange('enabled', $enabled, $oldStatus);
+            $this->config->setUserValue($this->uid, 'core', 'enabled', $enabled ? 'true' : 'false');
+        }
+    }
+
+    /**
+     * get the users email address
+     *
+     * @return string|null
+     * @since 9.0.0
+     */
+    public function getEMailAddress() {
+        return $this->config->getUserValue($this->uid, 'settings', 'email', null);
+    }
+
+    /**
+     * get the users' quota
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getQuota() {
+        // allow apps to modify the user quota by hooking into the event
+        $event = new GetQuotaEvent($this);
+        $this->dispatcher->dispatchTyped($event);
+        $overwriteQuota = $event->getQuota();
+        if ($overwriteQuota) {
+            $quota = $overwriteQuota;
+        } else {
+            $quota = $this->config->getUserValue($this->uid, 'files', 'quota', 'default');
+        }
+        if ($quota === 'default') {
+            $quota = $this->config->getAppValue('files', 'default_quota', 'none');
+        }
+        return $quota;
+    }
+
+    /**
+     * set the users' quota
+     *
+     * @param string $quota
+     * @return void
+     * @since 9.0.0
+     */
+    public function setQuota($quota) {
+        $oldQuota = $this->config->getUserValue($this->uid, 'files', 'quota', '');
+        if ($quota !== 'none' and $quota !== 'default') {
+            $quota = OC_Helper::computerFileSize($quota);
+            $quota = OC_Helper::humanFileSize($quota);
+        }
+        if ($quota !== $oldQuota) {
+            $this->config->setUserValue($this->uid, 'files', 'quota', $quota);
+            $this->triggerChange('quota', $quota, $oldQuota);
+        }
+    }
+
+    /**
+     * get the avatar image if it exists
+     *
+     * @param int $size
+     * @return IImage|null
+     * @since 9.0.0
+     */
+    public function getAvatarImage($size) {
+        // delay the initialization
+        if (is_null($this->avatarManager)) {
+            $this->avatarManager = \OC::$server->getAvatarManager();
+        }
+
+        $avatar = $this->avatarManager->getAvatar($this->uid);
+        $image = $avatar->get(-1);
+        if ($image) {
+            return $image;
+        }
+
+        return null;
+    }
+
+    /**
+     * get the federation cloud id
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getCloudId() {
+        $uid = $this->getUID();
+        $server = $this->urlGenerator->getAbsoluteURL('/');
+        $server = rtrim($this->removeProtocolFromUrl($server), '/');
+        return \OC::$server->getCloudIdManager()->getCloudId($uid, $server)->getId();
+    }
+
+    /**
+     * @param string $url
+     * @return string
+     */
+    private function removeProtocolFromUrl($url) {
+        if (strpos($url, 'https://') === 0) {
+            return substr($url, strlen('https://'));
+        } elseif (strpos($url, 'http://') === 0) {
+            return substr($url, strlen('http://'));
+        }
+
+        return $url;
+    }
+
+    public function triggerChange($feature, $value = null, $oldValue = null) {
+        $this->legacyDispatcher->dispatch(IUser::class . '::changeUser', new GenericEvent($this, [
+            'feature' => $feature,
+            'value' => $value,
+            'oldValue' => $oldValue,
+        ]));
+        if ($this->emitter) {
+            $this->emitter->emit('\OC\User', 'changeUser', [$this, $feature, $value, $oldValue]);
+        }
+    }
 }