nextcloud / server

apps/dav/lib/Connector/Sabre/File.php

Indentation +601 added lines, -601 removed lines

@@ -71,605 +71,605 @@
 
 class File extends Node implements IFile {
 
-	protected $request;
-
-	/**
-	 * Sets up the node, expects a full path name
-	 *
-	 * @param \OC\Files\View $view
-	 * @param \OCP\Files\FileInfo $info
-	 * @param \OCP\Share\IManager $shareManager
-	 * @param \OC\AppFramework\Http\Request $request
-	 */
-	public function __construct(View $view, FileInfo $info, IManager $shareManager = null, Request $request = null) {
-		parent::__construct($view, $info, $shareManager);
-
-		if (isset($request)) {
-			$this->request = $request;
-		} else {
-			$this->request = \OC::$server->getRequest();
-		}
-	}
-
-	/**
-	 * Updates the data
-	 *
-	 * The data argument is a readable stream resource.
-	 *
-	 * After a successful put operation, you may choose to return an ETag. The
-	 * etag must always be surrounded by double-quotes. These quotes must
-	 * appear in the actual string you're returning.
-	 *
-	 * Clients may use the ETag from a PUT request to later on make sure that
-	 * when they update the file, the contents haven't changed in the mean
-	 * time.
-	 *
-	 * If you don't plan to store the file byte-by-byte, and you return a
-	 * different object on a subsequent GET you are strongly recommended to not
-	 * return an ETag, and just return null.
-	 *
-	 * @param resource $data
-	 *
-	 * @throws Forbidden
-	 * @throws UnsupportedMediaType
-	 * @throws BadRequest
-	 * @throws Exception
-	 * @throws EntityTooLarge
-	 * @throws ServiceUnavailable
-	 * @throws FileLocked
-	 * @return string|null
-	 */
-	public function put($data) {
-		try {
-			$exists = $this->fileView->file_exists($this->path);
-			if ($this->info && $exists && !$this->info->isUpdateable()) {
-				throw new Forbidden();
-			}
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("File is not updatable: " . $e->getMessage());
-		}
-
-		// verify path of the target
-		$this->verifyPath();
-
-		// chunked handling
-		if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
-			try {
-				return $this->createFileChunked($data);
-			} catch (\Exception $e) {
-				$this->convertToSabreException($e);
-			}
-		}
-
-		/** @var Storage $partStorage */
-		list($partStorage) = $this->fileView->resolvePath($this->path);
-		$needsPartFile = $partStorage->needsPartFile() && (strlen($this->path) > 1);
-
-		$view = \OC\Files\Filesystem::getView();
-
-		if ($needsPartFile) {
-			// mark file as partial while uploading (ignored by the scanner)
-			$partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part';
-
-			if (!$view->isCreatable($partFilePath) && $view->isUpdatable($this->path)) {
-				$needsPartFile = false;
-			}
-		}
-		if (!$needsPartFile) {
-			// upload file directly as the final path
-			$partFilePath = $this->path;
-
-			if ($view && !$this->emitPreHooks($exists)) {
-				throw new Exception('Could not write to final file, canceled by hook');
-			}
-		}
-
-		// the part file and target file might be on a different storage in case of a single file storage (e.g. single file share)
-		/** @var \OC\Files\Storage\Storage $partStorage */
-		list($partStorage, $internalPartPath) = $this->fileView->resolvePath($partFilePath);
-		/** @var \OC\Files\Storage\Storage $storage */
-		list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
-		try {
-			if (!$needsPartFile) {
-				$this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
-			}
-
-			if ($partStorage->instanceOfStorage(Storage\IWriteStreamStorage::class)) {
-
-				if (!is_resource($data)) {
-					$tmpData = fopen('php://temp', 'r+');
-					if ($data !== null) {
-						fwrite($tmpData, $data);
-						rewind($tmpData);
-					}
-					$data = $tmpData;
-				}
-
-				$isEOF = false;
-				$wrappedData = CallbackWrapper::wrap($data, null, null, null, null, function ($stream) use (&$isEOF) {
-					$isEOF = feof($stream);
-				});
-
-				$count = $partStorage->writeStream($internalPartPath, $wrappedData);
-				$result = $count > 0;
-
-				if ($result === false) {
-					$result = $isEOF;
-					if (is_resource($wrappedData)) {
-						$result = feof($wrappedData);
-					}
-				}
-
-			} else {
-				$target = $partStorage->fopen($internalPartPath, 'wb');
-				if ($target === false) {
-					\OC::$server->getLogger()->error('\OC\Files\Filesystem::fopen() failed', ['app' => 'webdav']);
-					// because we have no clue about the cause we can only throw back a 500/Internal Server Error
-					throw new Exception('Could not write file contents');
-				}
-				list($count, $result) = \OC_Helper::streamCopy($data, $target);
-				fclose($target);
-			}
-
-			if ($result === false) {
-				$expected = -1;
-				if (isset($_SERVER['CONTENT_LENGTH'])) {
-					$expected = $_SERVER['CONTENT_LENGTH'];
-				}
-				if ($expected !== "0") {
-					throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )');
-				}
-			}
-
-			// if content length is sent by client:
-			// double check if the file was fully received
-			// compare expected and actual size
-			if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
-				$expected = (int)$_SERVER['CONTENT_LENGTH'];
-				if ($count !== $expected) {
-					throw new BadRequest('Expected filesize of ' . $expected . ' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) ' . $count . ' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
-				}
-			}
-
-		} catch (\Exception $e) {
-			$context = [];
-
-			if ($e instanceof LockedException) {
-				$context['level'] = ILogger::DEBUG;
-			}
-
-			\OC::$server->getLogger()->logException($e, $context);
-			if ($needsPartFile) {
-				$partStorage->unlink($internalPartPath);
-			}
-			$this->convertToSabreException($e);
-		}
-
-		try {
-			if ($needsPartFile) {
-				if ($view && !$this->emitPreHooks($exists)) {
-					$partStorage->unlink($internalPartPath);
-					throw new Exception('Could not rename part file to final file, canceled by hook');
-				}
-				try {
-					$this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
-				} catch (LockedException $e) {
-					// during very large uploads, the shared lock we got at the start might have been expired
-					// meaning that the above lock can fail not just only because somebody else got a shared lock
-					// or because there is no existing shared lock to make exclusive
-					//
-					// Thus we try to get a new exclusive lock, if the original lock failed because of a different shared
-					// lock this will still fail, if our original shared lock expired the new lock will be successful and
-					// the entire operation will be safe
-
-					try {
-						$this->acquireLock(ILockingProvider::LOCK_EXCLUSIVE);
-					} catch (LockedException $ex) {
-						if ($needsPartFile) {
-							$partStorage->unlink($internalPartPath);
-						}
-						throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-					}
-				}
-
-				// rename to correct path
-				try {
-					$renameOkay = $storage->moveFromStorage($partStorage, $internalPartPath, $internalPath);
-					$fileExists = $storage->file_exists($internalPath);
-					if ($renameOkay === false || $fileExists === false) {
-						\OC::$server->getLogger()->error('renaming part file to final file failed $renameOkay: ' . ($renameOkay ? 'true' : 'false') . ', $fileExists: ' . ($fileExists ? 'true' : 'false') . ')', ['app' => 'webdav']);
-						throw new Exception('Could not rename part file to final file');
-					}
-				} catch (ForbiddenException $ex) {
-					throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
-				} catch (\Exception $e) {
-					$partStorage->unlink($internalPartPath);
-					$this->convertToSabreException($e);
-				}
-			}
-
-			// since we skipped the view we need to scan and emit the hooks ourselves
-			$storage->getUpdater()->update($internalPath);
-
-			try {
-				$this->changeLock(ILockingProvider::LOCK_SHARED);
-			} catch (LockedException $e) {
-				throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-			}
-
-			// allow sync clients to send the mtime along in a header
-			if (isset($this->request->server['HTTP_X_OC_MTIME'])) {
-				$mtime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_MTIME']);
-				if ($this->fileView->touch($this->path, $mtime)) {
-					$this->header('X-OC-MTime: accepted');
-				}
-			}
-
-			$fileInfoUpdate = [
-				'upload_time' => time()
-			];
-
-			// allow sync clients to send the creation time along in a header
-			if (isset($this->request->server['HTTP_X_OC_CTIME'])) {
-				$ctime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_CTIME']);
-				$fileInfoUpdate['creation_time'] = $ctime;
-				$this->header('X-OC-CTime: accepted');
-			}
-
-			$this->fileView->putFileInfo($this->path, $fileInfoUpdate);
-
-			if ($view) {
-				$this->emitPostHooks($exists);
-			}
-
-			$this->refreshInfo();
-
-			if (isset($this->request->server['HTTP_OC_CHECKSUM'])) {
-				$checksum = trim($this->request->server['HTTP_OC_CHECKSUM']);
-				$this->fileView->putFileInfo($this->path, ['checksum' => $checksum]);
-				$this->refreshInfo();
-			} else if ($this->getChecksum() !== null && $this->getChecksum() !== '') {
-				$this->fileView->putFileInfo($this->path, ['checksum' => '']);
-				$this->refreshInfo();
-			}
-
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage(), 0, $e);
-		}
-
-		return '"' . $this->info->getEtag() . '"';
-	}
-
-	private function getPartFileBasePath($path) {
-		$partFileInStorage = \OC::$server->getConfig()->getSystemValue('part_file_in_storage', true);
-		if ($partFileInStorage) {
-			return $path;
-		} else {
-			return md5($path); // will place it in the root of the view with a unique name
-		}
-	}
-
-	/**
-	 * @param string $path
-	 */
-	private function emitPreHooks($exists, $path = null) {
-		if (is_null($path)) {
-			$path = $this->path;
-		}
-		$hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
-		$run = true;
-
-		if (!$exists) {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_create, [
-				\OC\Files\Filesystem::signal_param_path => $hookPath,
-				\OC\Files\Filesystem::signal_param_run => &$run,
-			]);
-		} else {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_update, [
-				\OC\Files\Filesystem::signal_param_path => $hookPath,
-				\OC\Files\Filesystem::signal_param_run => &$run,
-			]);
-		}
-		\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_write, [
-			\OC\Files\Filesystem::signal_param_path => $hookPath,
-			\OC\Files\Filesystem::signal_param_run => &$run,
-		]);
-		return $run;
-	}
-
-	/**
-	 * @param string $path
-	 */
-	private function emitPostHooks($exists, $path = null) {
-		if (is_null($path)) {
-			$path = $this->path;
-		}
-		$hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
-		if (!$exists) {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_create, [
-				\OC\Files\Filesystem::signal_param_path => $hookPath
-			]);
-		} else {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_update, [
-				\OC\Files\Filesystem::signal_param_path => $hookPath
-			]);
-		}
-		\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_write, [
-			\OC\Files\Filesystem::signal_param_path => $hookPath
-		]);
-	}
-
-	/**
-	 * Returns the data
-	 *
-	 * @return resource
-	 * @throws Forbidden
-	 * @throws ServiceUnavailable
-	 */
-	public function get() {
-		//throw exception if encryption is disabled but files are still encrypted
-		try {
-			if (!$this->info->isReadable()) {
-				// do a if the file did not exist
-				throw new NotFound();
-			}
-			try {
-				$res = $this->fileView->fopen(ltrim($this->path, '/'), 'rb');
-			} catch (\Exception $e) {
-				$this->convertToSabreException($e);
-			}
-			if ($res === false) {
-				throw new ServiceUnavailable("Could not open file");
-			}
-			return $res;
-		} catch (GenericEncryptionException $e) {
-			// returning 503 will allow retry of the operation at a later point in time
-			throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage());
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to open file: " . $e->getMessage());
-		} catch (ForbiddenException $ex) {
-			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
-		} catch (LockedException $e) {
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * Delete the current file
-	 *
-	 * @throws Forbidden
-	 * @throws ServiceUnavailable
-	 */
-	public function delete() {
-		if (!$this->info->isDeletable()) {
-			throw new Forbidden();
-		}
-
-		try {
-			if (!$this->fileView->unlink($this->path)) {
-				// assume it wasn't possible to delete due to permissions
-				throw new Forbidden();
-			}
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage());
-		} catch (ForbiddenException $ex) {
-			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
-		} catch (LockedException $e) {
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * Returns the mime-type for a file
-	 *
-	 * If null is returned, we'll assume application/octet-stream
-	 *
-	 * @return string
-	 */
-	public function getContentType() {
-		$mimeType = $this->info->getMimetype();
-
-		// PROPFIND needs to return the correct mime type, for consistency with the web UI
-		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PROPFIND') {
-			return $mimeType;
-		}
-		return \OC::$server->getMimeTypeDetector()->getSecureMimeType($mimeType);
-	}
-
-	/**
-	 * @return array|false
-	 */
-	public function getDirectDownload() {
-		if (\OCP\App::isEnabled('encryption')) {
-			return [];
-		}
-		/** @var \OCP\Files\Storage $storage */
-		list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
-		if (is_null($storage)) {
-			return [];
-		}
-
-		return $storage->getDirectDownload($internalPath);
-	}
-
-	/**
-	 * @param resource $data
-	 * @return null|string
-	 * @throws Exception
-	 * @throws BadRequest
-	 * @throws NotImplemented
-	 * @throws ServiceUnavailable
-	 */
-	private function createFileChunked($data) {
-		list($path, $name) = \Sabre\Uri\split($this->path);
-
-		$info = \OC_FileChunking::decodeName($name);
-		if (empty($info)) {
-			throw new NotImplemented('Invalid chunk name');
-		}
-
-		$chunk_handler = new \OC_FileChunking($info);
-		$bytesWritten = $chunk_handler->store($info['index'], $data);
-
-		//detect aborted upload
-		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
-			if (isset($_SERVER['CONTENT_LENGTH'])) {
-				$expected = (int)$_SERVER['CONTENT_LENGTH'];
-				if ($bytesWritten !== $expected) {
-					$chunk_handler->remove($info['index']);
-					throw new BadRequest('Expected filesize of ' . $expected . ' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) ' . $bytesWritten . ' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
-				}
-			}
-		}
-
-		if ($chunk_handler->isComplete()) {
-			/** @var Storage $storage */
-			list($storage,) = $this->fileView->resolvePath($path);
-			$needsPartFile = $storage->needsPartFile();
-			$partFile = null;
-
-			$targetPath = $path . '/' . $info['name'];
-			/** @var \OC\Files\Storage\Storage $targetStorage */
-			list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
-
-			$exists = $this->fileView->file_exists($targetPath);
-
-			try {
-				$this->fileView->lockFile($targetPath, ILockingProvider::LOCK_SHARED);
-
-				$this->emitPreHooks($exists, $targetPath);
-				$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_EXCLUSIVE);
-				/** @var \OC\Files\Storage\Storage $targetStorage */
-				list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
-
-				if ($needsPartFile) {
-					// we first assembly the target file as a part file
-					$partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part';
-					/** @var \OC\Files\Storage\Storage $targetStorage */
-					list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile);
-
-
-					$chunk_handler->file_assemble($partStorage, $partInternalPath);
-
-					// here is the final atomic rename
-					$renameOkay = $targetStorage->moveFromStorage($partStorage, $partInternalPath, $targetInternalPath);
-					$fileExists = $targetStorage->file_exists($targetInternalPath);
-					if ($renameOkay === false || $fileExists === false) {
-						\OC::$server->getLogger()->error('\OC\Files\Filesystem::rename() failed', ['app' => 'webdav']);
-						// only delete if an error occurred and the target file was already created
-						if ($fileExists) {
-							// set to null to avoid double-deletion when handling exception
-							// stray part file
-							$partFile = null;
-							$targetStorage->unlink($targetInternalPath);
-						}
-						$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
-						throw new Exception('Could not rename part file assembled from chunks');
-					}
-				} else {
-					// assemble directly into the final file
-					$chunk_handler->file_assemble($targetStorage, $targetInternalPath);
-				}
-
-				// allow sync clients to send the mtime along in a header
-				if (isset($this->request->server['HTTP_X_OC_MTIME'])) {
-					$mtime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_MTIME']);
-					if ($targetStorage->touch($targetInternalPath, $mtime)) {
-						$this->header('X-OC-MTime: accepted');
-					}
-				}
-
-				// since we skipped the view we need to scan and emit the hooks ourselves
-				$targetStorage->getUpdater()->update($targetInternalPath);
-
-				$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
-
-				$this->emitPostHooks($exists, $targetPath);
-
-				// FIXME: should call refreshInfo but can't because $this->path is not the of the final file
-				$info = $this->fileView->getFileInfo($targetPath);
-
-				if (isset($this->request->server['HTTP_OC_CHECKSUM'])) {
-					$checksum = trim($this->request->server['HTTP_OC_CHECKSUM']);
-					$this->fileView->putFileInfo($targetPath, ['checksum' => $checksum]);
-				} else if ($info->getChecksum() !== null && $info->getChecksum() !== '') {
-					$this->fileView->putFileInfo($this->path, ['checksum' => '']);
-				}
-
-				$this->fileView->unlockFile($targetPath, ILockingProvider::LOCK_SHARED);
-
-				return $info->getEtag();
-			} catch (\Exception $e) {
-				if ($partFile !== null) {
-					$targetStorage->unlink($targetInternalPath);
-				}
-				$this->convertToSabreException($e);
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * Convert the given exception to a SabreException instance
-	 *
-	 * @param \Exception $e
-	 *
-	 * @throws \Sabre\DAV\Exception
-	 */
-	private function convertToSabreException(\Exception $e) {
-		if ($e instanceof \Sabre\DAV\Exception) {
-			throw $e;
-		}
-		if ($e instanceof NotPermittedException) {
-			// a more general case - due to whatever reason the content could not be written
-			throw new Forbidden($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof ForbiddenException) {
-			// the path for the file was forbidden
-			throw new DAVForbiddenException($e->getMessage(), $e->getRetry(), $e);
-		}
-		if ($e instanceof EntityTooLargeException) {
-			// the file is too big to be stored
-			throw new EntityTooLarge($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof InvalidContentException) {
-			// the file content is not permitted
-			throw new UnsupportedMediaType($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof InvalidPathException) {
-			// the path for the file was not valid
-			// TODO: find proper http status code for this case
-			throw new Forbidden($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof LockedException || $e instanceof LockNotAcquiredException) {
-			// the file is currently being written to by another process
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-		if ($e instanceof GenericEncryptionException) {
-			// returning 503 will allow retry of the operation at a later point in time
-			throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e);
-		}
-		if ($e instanceof StorageNotAvailableException) {
-			throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e);
-		}
-		if ($e instanceof NotFoundException) {
-			throw new NotFound('File not found: ' . $e->getMessage(), 0, $e);
-		}
-
-		throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e);
-	}
-
-	/**
-	 * Get the checksum for this file
-	 *
-	 * @return string
-	 */
-	public function getChecksum() {
-		return $this->info->getChecksum();
-	}
-
-	protected function header($string) {
-		\header($string);
-	}
+    protected $request;
+
+    /**
+     * Sets up the node, expects a full path name
+     *
+     * @param \OC\Files\View $view
+     * @param \OCP\Files\FileInfo $info
+     * @param \OCP\Share\IManager $shareManager
+     * @param \OC\AppFramework\Http\Request $request
+     */
+    public function __construct(View $view, FileInfo $info, IManager $shareManager = null, Request $request = null) {
+        parent::__construct($view, $info, $shareManager);
+
+        if (isset($request)) {
+            $this->request = $request;
+        } else {
+            $this->request = \OC::$server->getRequest();
+        }
+    }
+
+    /**
+     * Updates the data
+     *
+     * The data argument is a readable stream resource.
+     *
+     * After a successful put operation, you may choose to return an ETag. The
+     * etag must always be surrounded by double-quotes. These quotes must
+     * appear in the actual string you're returning.
+     *
+     * Clients may use the ETag from a PUT request to later on make sure that
+     * when they update the file, the contents haven't changed in the mean
+     * time.
+     *
+     * If you don't plan to store the file byte-by-byte, and you return a
+     * different object on a subsequent GET you are strongly recommended to not
+     * return an ETag, and just return null.
+     *
+     * @param resource $data
+     *
+     * @throws Forbidden
+     * @throws UnsupportedMediaType
+     * @throws BadRequest
+     * @throws Exception
+     * @throws EntityTooLarge
+     * @throws ServiceUnavailable
+     * @throws FileLocked
+     * @return string|null
+     */
+    public function put($data) {
+        try {
+            $exists = $this->fileView->file_exists($this->path);
+            if ($this->info && $exists && !$this->info->isUpdateable()) {
+                throw new Forbidden();
+            }
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("File is not updatable: " . $e->getMessage());
+        }
+
+        // verify path of the target
+        $this->verifyPath();
+
+        // chunked handling
+        if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
+            try {
+                return $this->createFileChunked($data);
+            } catch (\Exception $e) {
+                $this->convertToSabreException($e);
+            }
+        }
+
+        /** @var Storage $partStorage */
+        list($partStorage) = $this->fileView->resolvePath($this->path);
+        $needsPartFile = $partStorage->needsPartFile() && (strlen($this->path) > 1);
+
+        $view = \OC\Files\Filesystem::getView();
+
+        if ($needsPartFile) {
+            // mark file as partial while uploading (ignored by the scanner)
+            $partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part';
+
+            if (!$view->isCreatable($partFilePath) && $view->isUpdatable($this->path)) {
+                $needsPartFile = false;
+            }
+        }
+        if (!$needsPartFile) {
+            // upload file directly as the final path
+            $partFilePath = $this->path;
+
+            if ($view && !$this->emitPreHooks($exists)) {
+                throw new Exception('Could not write to final file, canceled by hook');
+            }
+        }
+
+        // the part file and target file might be on a different storage in case of a single file storage (e.g. single file share)
+        /** @var \OC\Files\Storage\Storage $partStorage */
+        list($partStorage, $internalPartPath) = $this->fileView->resolvePath($partFilePath);
+        /** @var \OC\Files\Storage\Storage $storage */
+        list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
+        try {
+            if (!$needsPartFile) {
+                $this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
+            }
+
+            if ($partStorage->instanceOfStorage(Storage\IWriteStreamStorage::class)) {
+
+                if (!is_resource($data)) {
+                    $tmpData = fopen('php://temp', 'r+');
+                    if ($data !== null) {
+                        fwrite($tmpData, $data);
+                        rewind($tmpData);
+                    }
+                    $data = $tmpData;
+                }
+
+                $isEOF = false;
+                $wrappedData = CallbackWrapper::wrap($data, null, null, null, null, function ($stream) use (&$isEOF) {
+                    $isEOF = feof($stream);
+                });
+
+                $count = $partStorage->writeStream($internalPartPath, $wrappedData);
+                $result = $count > 0;
+
+                if ($result === false) {
+                    $result = $isEOF;
+                    if (is_resource($wrappedData)) {
+                        $result = feof($wrappedData);
+                    }
+                }
+
+            } else {
+                $target = $partStorage->fopen($internalPartPath, 'wb');
+                if ($target === false) {
+                    \OC::$server->getLogger()->error('\OC\Files\Filesystem::fopen() failed', ['app' => 'webdav']);
+                    // because we have no clue about the cause we can only throw back a 500/Internal Server Error
+                    throw new Exception('Could not write file contents');
+                }
+                list($count, $result) = \OC_Helper::streamCopy($data, $target);
+                fclose($target);
+            }
+
+            if ($result === false) {
+                $expected = -1;
+                if (isset($_SERVER['CONTENT_LENGTH'])) {
+                    $expected = $_SERVER['CONTENT_LENGTH'];
+                }
+                if ($expected !== "0") {
+                    throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )');
+                }
+            }
+
+            // if content length is sent by client:
+            // double check if the file was fully received
+            // compare expected and actual size
+            if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
+                $expected = (int)$_SERVER['CONTENT_LENGTH'];
+                if ($count !== $expected) {
+                    throw new BadRequest('Expected filesize of ' . $expected . ' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) ' . $count . ' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
+                }
+            }
+
+        } catch (\Exception $e) {
+            $context = [];
+
+            if ($e instanceof LockedException) {
+                $context['level'] = ILogger::DEBUG;
+            }
+
+            \OC::$server->getLogger()->logException($e, $context);
+            if ($needsPartFile) {
+                $partStorage->unlink($internalPartPath);
+            }
+            $this->convertToSabreException($e);
+        }
+
+        try {
+            if ($needsPartFile) {
+                if ($view && !$this->emitPreHooks($exists)) {
+                    $partStorage->unlink($internalPartPath);
+                    throw new Exception('Could not rename part file to final file, canceled by hook');
+                }
+                try {
+                    $this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
+                } catch (LockedException $e) {
+                    // during very large uploads, the shared lock we got at the start might have been expired
+                    // meaning that the above lock can fail not just only because somebody else got a shared lock
+                    // or because there is no existing shared lock to make exclusive
+                    //
+                    // Thus we try to get a new exclusive lock, if the original lock failed because of a different shared
+                    // lock this will still fail, if our original shared lock expired the new lock will be successful and
+                    // the entire operation will be safe
+
+                    try {
+                        $this->acquireLock(ILockingProvider::LOCK_EXCLUSIVE);
+                    } catch (LockedException $ex) {
+                        if ($needsPartFile) {
+                            $partStorage->unlink($internalPartPath);
+                        }
+                        throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+                    }
+                }
+
+                // rename to correct path
+                try {
+                    $renameOkay = $storage->moveFromStorage($partStorage, $internalPartPath, $internalPath);
+                    $fileExists = $storage->file_exists($internalPath);
+                    if ($renameOkay === false || $fileExists === false) {
+                        \OC::$server->getLogger()->error('renaming part file to final file failed $renameOkay: ' . ($renameOkay ? 'true' : 'false') . ', $fileExists: ' . ($fileExists ? 'true' : 'false') . ')', ['app' => 'webdav']);
+                        throw new Exception('Could not rename part file to final file');
+                    }
+                } catch (ForbiddenException $ex) {
+                    throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
+                } catch (\Exception $e) {
+                    $partStorage->unlink($internalPartPath);
+                    $this->convertToSabreException($e);
+                }
+            }
+
+            // since we skipped the view we need to scan and emit the hooks ourselves
+            $storage->getUpdater()->update($internalPath);
+
+            try {
+                $this->changeLock(ILockingProvider::LOCK_SHARED);
+            } catch (LockedException $e) {
+                throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+            }
+
+            // allow sync clients to send the mtime along in a header
+            if (isset($this->request->server['HTTP_X_OC_MTIME'])) {
+                $mtime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_MTIME']);
+                if ($this->fileView->touch($this->path, $mtime)) {
+                    $this->header('X-OC-MTime: accepted');
+                }
+            }
+
+            $fileInfoUpdate = [
+                'upload_time' => time()
+            ];
+
+            // allow sync clients to send the creation time along in a header
+            if (isset($this->request->server['HTTP_X_OC_CTIME'])) {
+                $ctime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_CTIME']);
+                $fileInfoUpdate['creation_time'] = $ctime;
+                $this->header('X-OC-CTime: accepted');
+            }
+
+            $this->fileView->putFileInfo($this->path, $fileInfoUpdate);
+
+            if ($view) {
+                $this->emitPostHooks($exists);
+            }
+
+            $this->refreshInfo();
+
+            if (isset($this->request->server['HTTP_OC_CHECKSUM'])) {
+                $checksum = trim($this->request->server['HTTP_OC_CHECKSUM']);
+                $this->fileView->putFileInfo($this->path, ['checksum' => $checksum]);
+                $this->refreshInfo();
+            } else if ($this->getChecksum() !== null && $this->getChecksum() !== '') {
+                $this->fileView->putFileInfo($this->path, ['checksum' => '']);
+                $this->refreshInfo();
+            }
+
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage(), 0, $e);
+        }
+
+        return '"' . $this->info->getEtag() . '"';
+    }
+
+    private function getPartFileBasePath($path) {
+        $partFileInStorage = \OC::$server->getConfig()->getSystemValue('part_file_in_storage', true);
+        if ($partFileInStorage) {
+            return $path;
+        } else {
+            return md5($path); // will place it in the root of the view with a unique name
+        }
+    }
+
+    /**
+     * @param string $path
+     */
+    private function emitPreHooks($exists, $path = null) {
+        if (is_null($path)) {
+            $path = $this->path;
+        }
+        $hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
+        $run = true;
+
+        if (!$exists) {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_create, [
+                \OC\Files\Filesystem::signal_param_path => $hookPath,
+                \OC\Files\Filesystem::signal_param_run => &$run,
+            ]);
+        } else {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_update, [
+                \OC\Files\Filesystem::signal_param_path => $hookPath,
+                \OC\Files\Filesystem::signal_param_run => &$run,
+            ]);
+        }
+        \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_write, [
+            \OC\Files\Filesystem::signal_param_path => $hookPath,
+            \OC\Files\Filesystem::signal_param_run => &$run,
+        ]);
+        return $run;
+    }
+
+    /**
+     * @param string $path
+     */
+    private function emitPostHooks($exists, $path = null) {
+        if (is_null($path)) {
+            $path = $this->path;
+        }
+        $hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
+        if (!$exists) {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_create, [
+                \OC\Files\Filesystem::signal_param_path => $hookPath
+            ]);
+        } else {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_update, [
+                \OC\Files\Filesystem::signal_param_path => $hookPath
+            ]);
+        }
+        \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_write, [
+            \OC\Files\Filesystem::signal_param_path => $hookPath
+        ]);
+    }
+
+    /**
+     * Returns the data
+     *
+     * @return resource
+     * @throws Forbidden
+     * @throws ServiceUnavailable
+     */
+    public function get() {
+        //throw exception if encryption is disabled but files are still encrypted
+        try {
+            if (!$this->info->isReadable()) {
+                // do a if the file did not exist
+                throw new NotFound();
+            }
+            try {
+                $res = $this->fileView->fopen(ltrim($this->path, '/'), 'rb');
+            } catch (\Exception $e) {
+                $this->convertToSabreException($e);
+            }
+            if ($res === false) {
+                throw new ServiceUnavailable("Could not open file");
+            }
+            return $res;
+        } catch (GenericEncryptionException $e) {
+            // returning 503 will allow retry of the operation at a later point in time
+            throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage());
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("Failed to open file: " . $e->getMessage());
+        } catch (ForbiddenException $ex) {
+            throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
+        } catch (LockedException $e) {
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * Delete the current file
+     *
+     * @throws Forbidden
+     * @throws ServiceUnavailable
+     */
+    public function delete() {
+        if (!$this->info->isDeletable()) {
+            throw new Forbidden();
+        }
+
+        try {
+            if (!$this->fileView->unlink($this->path)) {
+                // assume it wasn't possible to delete due to permissions
+                throw new Forbidden();
+            }
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage());
+        } catch (ForbiddenException $ex) {
+            throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
+        } catch (LockedException $e) {
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * Returns the mime-type for a file
+     *
+     * If null is returned, we'll assume application/octet-stream
+     *
+     * @return string
+     */
+    public function getContentType() {
+        $mimeType = $this->info->getMimetype();
+
+        // PROPFIND needs to return the correct mime type, for consistency with the web UI
+        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PROPFIND') {
+            return $mimeType;
+        }
+        return \OC::$server->getMimeTypeDetector()->getSecureMimeType($mimeType);
+    }
+
+    /**
+     * @return array|false
+     */
+    public function getDirectDownload() {
+        if (\OCP\App::isEnabled('encryption')) {
+            return [];
+        }
+        /** @var \OCP\Files\Storage $storage */
+        list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
+        if (is_null($storage)) {
+            return [];
+        }
+
+        return $storage->getDirectDownload($internalPath);
+    }
+
+    /**
+     * @param resource $data
+     * @return null|string
+     * @throws Exception
+     * @throws BadRequest
+     * @throws NotImplemented
+     * @throws ServiceUnavailable
+     */
+    private function createFileChunked($data) {
+        list($path, $name) = \Sabre\Uri\split($this->path);
+
+        $info = \OC_FileChunking::decodeName($name);
+        if (empty($info)) {
+            throw new NotImplemented('Invalid chunk name');
+        }
+
+        $chunk_handler = new \OC_FileChunking($info);
+        $bytesWritten = $chunk_handler->store($info['index'], $data);
+
+        //detect aborted upload
+        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
+            if (isset($_SERVER['CONTENT_LENGTH'])) {
+                $expected = (int)$_SERVER['CONTENT_LENGTH'];
+                if ($bytesWritten !== $expected) {
+                    $chunk_handler->remove($info['index']);
+                    throw new BadRequest('Expected filesize of ' . $expected . ' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) ' . $bytesWritten . ' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
+                }
+            }
+        }
+
+        if ($chunk_handler->isComplete()) {
+            /** @var Storage $storage */
+            list($storage,) = $this->fileView->resolvePath($path);
+            $needsPartFile = $storage->needsPartFile();
+            $partFile = null;
+
+            $targetPath = $path . '/' . $info['name'];
+            /** @var \OC\Files\Storage\Storage $targetStorage */
+            list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
+
+            $exists = $this->fileView->file_exists($targetPath);
+
+            try {
+                $this->fileView->lockFile($targetPath, ILockingProvider::LOCK_SHARED);
+
+                $this->emitPreHooks($exists, $targetPath);
+                $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_EXCLUSIVE);
+                /** @var \OC\Files\Storage\Storage $targetStorage */
+                list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
+
+                if ($needsPartFile) {
+                    // we first assembly the target file as a part file
+                    $partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part';
+                    /** @var \OC\Files\Storage\Storage $targetStorage */
+                    list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile);
+
+
+                    $chunk_handler->file_assemble($partStorage, $partInternalPath);
+
+                    // here is the final atomic rename
+                    $renameOkay = $targetStorage->moveFromStorage($partStorage, $partInternalPath, $targetInternalPath);
+                    $fileExists = $targetStorage->file_exists($targetInternalPath);
+                    if ($renameOkay === false || $fileExists === false) {
+                        \OC::$server->getLogger()->error('\OC\Files\Filesystem::rename() failed', ['app' => 'webdav']);
+                        // only delete if an error occurred and the target file was already created
+                        if ($fileExists) {
+                            // set to null to avoid double-deletion when handling exception
+                            // stray part file
+                            $partFile = null;
+                            $targetStorage->unlink($targetInternalPath);
+                        }
+                        $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
+                        throw new Exception('Could not rename part file assembled from chunks');
+                    }
+                } else {
+                    // assemble directly into the final file
+                    $chunk_handler->file_assemble($targetStorage, $targetInternalPath);
+                }
+
+                // allow sync clients to send the mtime along in a header
+                if (isset($this->request->server['HTTP_X_OC_MTIME'])) {
+                    $mtime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_MTIME']);
+                    if ($targetStorage->touch($targetInternalPath, $mtime)) {
+                        $this->header('X-OC-MTime: accepted');
+                    }
+                }
+
+                // since we skipped the view we need to scan and emit the hooks ourselves
+                $targetStorage->getUpdater()->update($targetInternalPath);
+
+                $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
+
+                $this->emitPostHooks($exists, $targetPath);
+
+                // FIXME: should call refreshInfo but can't because $this->path is not the of the final file
+                $info = $this->fileView->getFileInfo($targetPath);
+
+                if (isset($this->request->server['HTTP_OC_CHECKSUM'])) {
+                    $checksum = trim($this->request->server['HTTP_OC_CHECKSUM']);
+                    $this->fileView->putFileInfo($targetPath, ['checksum' => $checksum]);
+                } else if ($info->getChecksum() !== null && $info->getChecksum() !== '') {
+                    $this->fileView->putFileInfo($this->path, ['checksum' => '']);
+                }
+
+                $this->fileView->unlockFile($targetPath, ILockingProvider::LOCK_SHARED);
+
+                return $info->getEtag();
+            } catch (\Exception $e) {
+                if ($partFile !== null) {
+                    $targetStorage->unlink($targetInternalPath);
+                }
+                $this->convertToSabreException($e);
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Convert the given exception to a SabreException instance
+     *
+     * @param \Exception $e
+     *
+     * @throws \Sabre\DAV\Exception
+     */
+    private function convertToSabreException(\Exception $e) {
+        if ($e instanceof \Sabre\DAV\Exception) {
+            throw $e;
+        }
+        if ($e instanceof NotPermittedException) {
+            // a more general case - due to whatever reason the content could not be written
+            throw new Forbidden($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof ForbiddenException) {
+            // the path for the file was forbidden
+            throw new DAVForbiddenException($e->getMessage(), $e->getRetry(), $e);
+        }
+        if ($e instanceof EntityTooLargeException) {
+            // the file is too big to be stored
+            throw new EntityTooLarge($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof InvalidContentException) {
+            // the file content is not permitted
+            throw new UnsupportedMediaType($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof InvalidPathException) {
+            // the path for the file was not valid
+            // TODO: find proper http status code for this case
+            throw new Forbidden($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof LockedException || $e instanceof LockNotAcquiredException) {
+            // the file is currently being written to by another process
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+        if ($e instanceof GenericEncryptionException) {
+            // returning 503 will allow retry of the operation at a later point in time
+            throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e);
+        }
+        if ($e instanceof StorageNotAvailableException) {
+            throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e);
+        }
+        if ($e instanceof NotFoundException) {
+            throw new NotFound('File not found: ' . $e->getMessage(), 0, $e);
+        }
+
+        throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e);
+    }
+
+    /**
+     * Get the checksum for this file
+     *
+     * @return string
+     */
+    public function getChecksum() {
+        return $this->info->getChecksum();
+    }
+
+    protected function header($string) {
+        \header($string);
+    }
 }

Spacing +19 added lines, -19 removed lines

@@ -126,7 +126,7 @@ 
 				throw new Forbidden();
 			}
 		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("File is not updatable: " . $e->getMessage());
+			throw new ServiceUnavailable("File is not updatable: ".$e->getMessage());
 		}
 
 		// verify path of the target
@@ -149,7 +149,7 @@ 
 
 		if ($needsPartFile) {
 			// mark file as partial while uploading (ignored by the scanner)
-			$partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part';
+			$partFilePath = $this->getPartFileBasePath($this->path).'.ocTransferId'.rand().'.part';
 
 			if (!$view->isCreatable($partFilePath) && $view->isUpdatable($this->path)) {
 				$needsPartFile = false;
@@ -186,7 +186,7 @@ 
 				}
 
 				$isEOF = false;
-				$wrappedData = CallbackWrapper::wrap($data, null, null, null, null, function ($stream) use (&$isEOF) {
+				$wrappedData = CallbackWrapper::wrap($data, null, null, null, null, function($stream) use (&$isEOF) {
 					$isEOF = feof($stream);
 				});
 
@@ -217,7 +217,7 @@ 
 					$expected = $_SERVER['CONTENT_LENGTH'];
 				}
 				if ($expected !== "0") {
-					throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )');
+					throw new Exception('Error while copying file to target location (copied bytes: '.$count.', expected filesize: '.$expected.' )');
 				}
 			}
 
@@ -225,9 +225,9 @@ 
 			// double check if the file was fully received
 			// compare expected and actual size
 			if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
-				$expected = (int)$_SERVER['CONTENT_LENGTH'];
+				$expected = (int) $_SERVER['CONTENT_LENGTH'];
 				if ($count !== $expected) {
-					throw new BadRequest('Expected filesize of ' . $expected . ' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) ' . $count . ' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
+					throw new BadRequest('Expected filesize of '.$expected.' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) '.$count.' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
 				}
 			}
 
@@ -277,7 +277,7 @@ 
 					$renameOkay = $storage->moveFromStorage($partStorage, $internalPartPath, $internalPath);
 					$fileExists = $storage->file_exists($internalPath);
 					if ($renameOkay === false || $fileExists === false) {
-						\OC::$server->getLogger()->error('renaming part file to final file failed $renameOkay: ' . ($renameOkay ? 'true' : 'false') . ', $fileExists: ' . ($fileExists ? 'true' : 'false') . ')', ['app' => 'webdav']);
+						\OC::$server->getLogger()->error('renaming part file to final file failed $renameOkay: '.($renameOkay ? 'true' : 'false').', $fileExists: '.($fileExists ? 'true' : 'false').')', ['app' => 'webdav']);
 						throw new Exception('Could not rename part file to final file');
 					}
 				} catch (ForbiddenException $ex) {
@@ -334,10 +334,10 @@ 
 			}
 
 		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage(), 0, $e);
+			throw new ServiceUnavailable("Failed to check file size: ".$e->getMessage(), 0, $e);
 		}
 
-		return '"' . $this->info->getEtag() . '"';
+		return '"'.$this->info->getEtag().'"';
 	}
 
 	private function getPartFileBasePath($path) {
@@ -424,9 +424,9 @@ 
 			return $res;
 		} catch (GenericEncryptionException $e) {
 			// returning 503 will allow retry of the operation at a later point in time
-			throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage());
+			throw new ServiceUnavailable("Encryption not ready: ".$e->getMessage());
 		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to open file: " . $e->getMessage());
+			throw new ServiceUnavailable("Failed to open file: ".$e->getMessage());
 		} catch (ForbiddenException $ex) {
 			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
 		} catch (LockedException $e) {
@@ -451,7 +451,7 @@ 
 				throw new Forbidden();
 			}
 		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage());
+			throw new ServiceUnavailable("Failed to unlink: ".$e->getMessage());
 		} catch (ForbiddenException $ex) {
 			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
 		} catch (LockedException $e) {
@@ -514,10 +514,10 @@ 
 		//detect aborted upload
 		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
 			if (isset($_SERVER['CONTENT_LENGTH'])) {
-				$expected = (int)$_SERVER['CONTENT_LENGTH'];
+				$expected = (int) $_SERVER['CONTENT_LENGTH'];
 				if ($bytesWritten !== $expected) {
 					$chunk_handler->remove($info['index']);
-					throw new BadRequest('Expected filesize of ' . $expected . ' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) ' . $bytesWritten . ' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
+					throw new BadRequest('Expected filesize of '.$expected.' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) '.$bytesWritten.' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
 				}
 			}
 		}
@@ -528,7 +528,7 @@ 
 			$needsPartFile = $storage->needsPartFile();
 			$partFile = null;
 
-			$targetPath = $path . '/' . $info['name'];
+			$targetPath = $path.'/'.$info['name'];
 			/** @var \OC\Files\Storage\Storage $targetStorage */
 			list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
 
@@ -544,7 +544,7 @@ 
 
 				if ($needsPartFile) {
 					// we first assembly the target file as a part file
-					$partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part';
+					$partFile = $this->getPartFileBasePath($path.'/'.$info['name']).'.ocTransferId'.$info['transferid'].'.part';
 					/** @var \OC\Files\Storage\Storage $targetStorage */
 					list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile);
 
@@ -648,13 +648,13 @@ 
 		}
 		if ($e instanceof GenericEncryptionException) {
 			// returning 503 will allow retry of the operation at a later point in time
-			throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e);
+			throw new ServiceUnavailable('Encryption not ready: '.$e->getMessage(), 0, $e);
 		}
 		if ($e instanceof StorageNotAvailableException) {
-			throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e);
+			throw new ServiceUnavailable('Failed to write file contents: '.$e->getMessage(), 0, $e);
 		}
 		if ($e instanceof NotFoundException) {
-			throw new NotFound('File not found: ' . $e->getMessage(), 0, $e);
+			throw new NotFound('File not found: '.$e->getMessage(), 0, $e);
 		}
 
 		throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e);

apps/dav/lib/CardDAV/CardDavBackend.php

Indentation +1118 added lines, -1118 removed lines

@@ -56,1122 +56,1122 @@
 
 class CardDavBackend implements BackendInterface, SyncSupport {
 
-	const PERSONAL_ADDRESSBOOK_URI = 'contacts';
-	const PERSONAL_ADDRESSBOOK_NAME = 'Contacts';
-
-	/** @var Principal */
-	private $principalBackend;
-
-	/** @var string */
-	private $dbCardsTable = 'cards';
-
-	/** @var string */
-	private $dbCardsPropertiesTable = 'cards_properties';
-
-	/** @var IDBConnection */
-	private $db;
-
-	/** @var Backend */
-	private $sharingBackend;
-
-	/** @var array properties to index */
-	public static $indexProperties = [
-		'BDAY', 'UID', 'N', 'FN', 'TITLE', 'ROLE', 'NOTE', 'NICKNAME',
-		'ORG', 'CATEGORIES', 'EMAIL', 'TEL', 'IMPP', 'ADR', 'URL', 'GEO', 'CLOUD'];
-
-	/**
-	 * @var string[] Map of uid => display name
-	 */
-	protected $userDisplayNames;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var EventDispatcherInterface */
-	private $dispatcher;
-
-	/**
-	 * CardDavBackend constructor.
-	 *
-	 * @param IDBConnection $db
-	 * @param Principal $principalBackend
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(IDBConnection $db,
-								Principal $principalBackend,
-								IUserManager $userManager,
-								IGroupManager $groupManager,
-								EventDispatcherInterface $dispatcher) {
-		$this->db = $db;
-		$this->principalBackend = $principalBackend;
-		$this->userManager = $userManager;
-		$this->dispatcher = $dispatcher;
-		$this->sharingBackend = new Backend($this->db, $this->userManager, $groupManager, $principalBackend, 'addressbook');
-	}
-
-	/**
-	 * Return the number of address books for a principal
-	 *
-	 * @param $principalUri
-	 * @return int
-	 */
-	public function getAddressBooksForUserCount($principalUri) {
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select($query->func()->count('*'))
-			->from('addressbooks')
-			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		return (int)$query->execute()->fetchColumn();
-	}
-
-	/**
-	 * Returns the list of address books for a specific user.
-	 *
-	 * Every addressbook should have the following properties:
-	 *   id - an arbitrary unique id
-	 *   uri - the 'basename' part of the url
-	 *   principaluri - Same as the passed parameter
-	 *
-	 * Any additional clark-notation property may be passed besides this. Some
-	 * common ones are :
-	 *   {DAV:}displayname
-	 *   {urn:ietf:params:xml:ns:carddav}addressbook-description
-	 *   {http://calendarserver.org/ns/}getctag
-	 *
-	 * @param string $principalUri
-	 * @return array
-	 */
-	function getAddressBooksForUser($principalUri) {
-		$principalUriOriginal = $principalUri;
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		$addressBooks = [];
-
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $row['uri'],
-				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
-				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-			];
-
-			$this->addOwnerPrincipal($addressBooks[$row['id']]);
-		}
-		$result->closeCursor();
-
-		// query for shared addressbooks
-		$principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
-		$principals = array_merge($principals, $this->principalBackend->getCircleMembership($principalUriOriginal));
-
-		$principals = array_map(function ($principal) {
-			return urldecode($principal);
-		}, $principals);
-		$principals[]= $principalUri;
-
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
-			->from('dav_shares', 's')
-			->join('s', 'addressbooks', 'a', $query->expr()->eq('s.resourceid', 'a.id'))
-			->where($query->expr()->in('s.principaluri', $query->createParameter('principaluri')))
-			->andWhere($query->expr()->eq('s.type', $query->createParameter('type')))
-			->setParameter('type', 'addressbook')
-			->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
-			->execute();
-
-		$readOnlyPropertyName = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only';
-		while($row = $result->fetch()) {
-			if ($row['principaluri'] === $principalUri) {
-				continue;
-			}
-
-			$readOnly = (int) $row['access'] === Backend::ACCESS_READ;
-			if (isset($addressBooks[$row['id']])) {
-				if ($readOnly) {
-					// New share can not have more permissions then the old one.
-					continue;
-				}
-				if (isset($addressBooks[$row['id']][$readOnlyPropertyName]) &&
-					$addressBooks[$row['id']][$readOnlyPropertyName] === 0) {
-					// Old share is already read-write, no more permissions can be gained
-					continue;
-				}
-			}
-
-			list(, $name) = \Sabre\Uri\split($row['principaluri']);
-			$uri = $row['uri'] . '_shared_by_' . $name;
-			$displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
-
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $uri,
-				'principaluri' => $principalUriOriginal,
-				'{DAV:}displayname' => $displayName,
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-				'{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
-				$readOnlyPropertyName => $readOnly,
-			];
-
-			$this->addOwnerPrincipal($addressBooks[$row['id']]);
-		}
-		$result->closeCursor();
-
-		return array_values($addressBooks);
-	}
-
-	public function getUsersOwnAddressBooks($principalUri) {
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			  ->from('addressbooks')
-			  ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		$addressBooks = [];
-
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $row['uri'],
-				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
-				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-			];
-
-			$this->addOwnerPrincipal($addressBooks[$row['id']]);
-		}
-		$result->closeCursor();
-
-		return array_values($addressBooks);
-	}
-
-	private function getUserDisplayName($uid) {
-		if (!isset($this->userDisplayNames[$uid])) {
-			$user = $this->userManager->get($uid);
-
-			if ($user instanceof IUser) {
-				$this->userDisplayNames[$uid] = $user->getDisplayName();
-			} else {
-				$this->userDisplayNames[$uid] = $uid;
-			}
-		}
-
-		return $this->userDisplayNames[$uid];
-	}
-
-	/**
-	 * @param int $addressBookId
-	 */
-	public function getAddressBookById($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-		$row = $result->fetch();
-		$result->closeCursor();
-		if ($row === false) {
-			return null;
-		}
-
-		$addressBook = [
-			'id'  => $row['id'],
-			'uri' => $row['uri'],
-			'principaluri' => $row['principaluri'],
-			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-		];
-
-		$this->addOwnerPrincipal($addressBook);
-
-		return $addressBook;
-	}
-
-	/**
-	 * @param $addressBookUri
-	 * @return array|null
-	 */
-	public function getAddressBooksByUri($principal, $addressBookUri) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('uri', $query->createNamedParameter($addressBookUri)))
-			->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($principal)))
-			->setMaxResults(1)
-			->execute();
-
-		$row = $result->fetch();
-		$result->closeCursor();
-		if ($row === false) {
-			return null;
-		}
-
-		$addressBook = [
-			'id'  => $row['id'],
-			'uri' => $row['uri'],
-			'principaluri' => $row['principaluri'],
-			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-		];
-
-		$this->addOwnerPrincipal($addressBook);
-
-		return $addressBook;
-	}
-
-	/**
-	 * Updates properties for an address book.
-	 *
-	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
-	 * To do the actual updates, you must tell this object which properties
-	 * you're going to process with the handle() method.
-	 *
-	 * Calling the handle method is like telling the PropPatch object "I
-	 * promise I can handle updating this property".
-	 *
-	 * Read the PropPatch documentation for more info and examples.
-	 *
-	 * @param string $addressBookId
-	 * @param \Sabre\DAV\PropPatch $propPatch
-	 * @return void
-	 */
-	function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
-		$supportedProperties = [
-			'{DAV:}displayname',
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description',
-		];
-
-		/**
-		 * @suppress SqlInjectionChecker
-		 */
-		$propPatch->handle($supportedProperties, function ($mutations) use ($addressBookId) {
-
-			$updates = [];
-			foreach($mutations as $property=>$newValue) {
-
-				switch($property) {
-					case '{DAV:}displayname':
-						$updates['displayname'] = $newValue;
-						break;
-					case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
-						$updates['description'] = $newValue;
-						break;
-				}
-			}
-			$query = $this->db->getQueryBuilder();
-			$query->update('addressbooks');
-
-			foreach($updates as $key=>$value) {
-				$query->set($key, $query->createNamedParameter($value));
-			}
-			$query->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-			$this->addChange($addressBookId, "", 2);
-
-			return true;
-
-		});
-	}
-
-	/**
-	 * Creates a new address book
-	 *
-	 * @param string $principalUri
-	 * @param string $url Just the 'basename' of the url.
-	 * @param array $properties
-	 * @return int
-	 * @throws BadRequest
-	 */
-	function createAddressBook($principalUri, $url, array $properties) {
-		$values = [
-			'displayname' => null,
-			'description' => null,
-			'principaluri' => $principalUri,
-			'uri' => $url,
-			'synctoken' => 1
-		];
-
-		foreach($properties as $property=>$newValue) {
-
-			switch($property) {
-				case '{DAV:}displayname':
-					$values['displayname'] = $newValue;
-					break;
-				case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
-					$values['description'] = $newValue;
-					break;
-				default:
-					throw new BadRequest('Unknown property: ' . $property);
-			}
-
-		}
-
-		// Fallback to make sure the displayname is set. Some clients may refuse
-		// to work with addressbooks not having a displayname.
-		if(is_null($values['displayname'])) {
-			$values['displayname'] = $url;
-		}
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert('addressbooks')
-			->values([
-				'uri' => $query->createParameter('uri'),
-				'displayname' => $query->createParameter('displayname'),
-				'description' => $query->createParameter('description'),
-				'principaluri' => $query->createParameter('principaluri'),
-				'synctoken' => $query->createParameter('synctoken'),
-			])
-			->setParameters($values)
-			->execute();
-
-		return $query->getLastInsertId();
-	}
-
-	/**
-	 * Deletes an entire addressbook and all its contents
-	 *
-	 * @param mixed $addressBookId
-	 * @return void
-	 */
-	function deleteAddressBook($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$query->delete('cards')
-			->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
-			->setParameter('addressbookid', $addressBookId)
-			->execute();
-
-		$query->delete('addressbookchanges')
-			->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
-			->setParameter('addressbookid', $addressBookId)
-			->execute();
-
-		$query->delete('addressbooks')
-			->where($query->expr()->eq('id', $query->createParameter('id')))
-			->setParameter('id', $addressBookId)
-			->execute();
-
-		$this->sharingBackend->deleteAllShares($addressBookId);
-
-		$query->delete($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-	}
-
-	/**
-	 * Returns all cards for a specific addressbook id.
-	 *
-	 * This method should return the following properties for each card:
-	 *   * carddata - raw vcard data
-	 *   * uri - Some unique url
-	 *   * lastmodified - A unix timestamp
-	 *
-	 * It's recommended to also return the following properties:
-	 *   * etag - A unique etag. This must change every time the card changes.
-	 *   * size - The size of the card in bytes.
-	 *
-	 * If these last two properties are provided, less time will be spent
-	 * calculating them. If they are specified, you can also ommit carddata.
-	 * This may speed up certain requests, especially with large cards.
-	 *
-	 * @param mixed $addressBookId
-	 * @return array
-	 */
-	function getCards($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-
-		$cards = [];
-
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$row['etag'] = '"' . $row['etag'] . '"';
-			$row['carddata'] = $this->readBlob($row['carddata']);
-			$cards[] = $row;
-		}
-		$result->closeCursor();
-
-		return $cards;
-	}
-
-	/**
-	 * Returns a specific card.
-	 *
-	 * The same set of properties must be returned as with getCards. The only
-	 * exception is that 'carddata' is absolutely required.
-	 *
-	 * If the card does not exist, you must return false.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @return array
-	 */
-	function getCard($addressBookId, $cardUri) {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->setMaxResults(1);
-
-		$result = $query->execute();
-		$row = $result->fetch();
-		if (!$row) {
-			return false;
-		}
-		$row['etag'] = '"' . $row['etag'] . '"';
-		$row['carddata'] = $this->readBlob($row['carddata']);
-
-		return $row;
-	}
-
-	/**
-	 * Returns a list of cards.
-	 *
-	 * This method should work identical to getCard, but instead return all the
-	 * cards in the list as an array.
-	 *
-	 * If the backend supports this, it may allow for some speed-ups.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string[] $uris
-	 * @return array
-	 */
-	function getMultipleCards($addressBookId, array $uris) {
-		if (empty($uris)) {
-			return [];
-		}
-
-		$chunks = array_chunk($uris, 100);
-		$cards = [];
-
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->in('uri', $query->createParameter('uri')));
-
-		foreach ($chunks as $uris) {
-			$query->setParameter('uri', $uris, IQueryBuilder::PARAM_STR_ARRAY);
-			$result = $query->execute();
-
-			while ($row = $result->fetch()) {
-				$row['etag'] = '"' . $row['etag'] . '"';
-				$row['carddata'] = $this->readBlob($row['carddata']);
-				$cards[] = $row;
-			}
-			$result->closeCursor();
-		}
-		return $cards;
-	}
-
-	/**
-	 * Creates a new card.
-	 *
-	 * The addressbook id will be passed as the first argument. This is the
-	 * same id as it is returned from the getAddressBooksForUser method.
-	 *
-	 * The cardUri is a base uri, and doesn't include the full path. The
-	 * cardData argument is the vcard body, and is passed as a string.
-	 *
-	 * It is possible to return an ETag from this method. This ETag is for the
-	 * newly created resource, and must be enclosed with double quotes (that
-	 * is, the string itself must contain the double quotes).
-	 *
-	 * You should only return the ETag if you store the carddata as-is. If a
-	 * subsequent GET request on the same card does not have the same body,
-	 * byte-by-byte and you did return an ETag here, clients tend to get
-	 * confused.
-	 *
-	 * If you don't return an ETag, you can just return null.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @param string $cardData
-	 * @return string
-	 */
-	function createCard($addressBookId, $cardUri, $cardData) {
-		$etag = md5($cardData);
-		$uid = $this->getUID($cardData);
-
-		$q = $this->db->getQueryBuilder();
-		$q->select('uid')
-			->from('cards')
-			->where($q->expr()->eq('addressbookid', $q->createNamedParameter($addressBookId)))
-			->andWhere($q->expr()->eq('uid', $q->createNamedParameter($uid)))
-			->setMaxResults(1);
-		$result = $q->execute();
-		$count = (bool) $result->fetchColumn();
-		$result->closeCursor();
-		if ($count) {
-			throw new \Sabre\DAV\Exception\BadRequest('VCard object with uid already exists in this addressbook collection.');
-		}
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert('cards')
-			->values([
-				'carddata' => $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB),
-				'uri' => $query->createNamedParameter($cardUri),
-				'lastmodified' => $query->createNamedParameter(time()),
-				'addressbookid' => $query->createNamedParameter($addressBookId),
-				'size' => $query->createNamedParameter(strlen($cardData)),
-				'etag' => $query->createNamedParameter($etag),
-				'uid' => $query->createNamedParameter($uid),
-			])
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 1);
-		$this->updateProperties($addressBookId, $cardUri, $cardData);
-
-		$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::createCard',
-			new GenericEvent(null, [
-				'addressBookId' => $addressBookId,
-				'cardUri' => $cardUri,
-				'cardData' => $cardData]));
-
-		return '"' . $etag . '"';
-	}
-
-	/**
-	 * Updates a card.
-	 *
-	 * The addressbook id will be passed as the first argument. This is the
-	 * same id as it is returned from the getAddressBooksForUser method.
-	 *
-	 * The cardUri is a base uri, and doesn't include the full path. The
-	 * cardData argument is the vcard body, and is passed as a string.
-	 *
-	 * It is possible to return an ETag from this method. This ETag should
-	 * match that of the updated resource, and must be enclosed with double
-	 * quotes (that is: the string itself must contain the actual quotes).
-	 *
-	 * You should only return the ETag if you store the carddata as-is. If a
-	 * subsequent GET request on the same card does not have the same body,
-	 * byte-by-byte and you did return an ETag here, clients tend to get
-	 * confused.
-	 *
-	 * If you don't return an ETag, you can just return null.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @param string $cardData
-	 * @return string
-	 */
-	function updateCard($addressBookId, $cardUri, $cardData) {
-
-		$uid = $this->getUID($cardData);
-		$etag = md5($cardData);
-		$query = $this->db->getQueryBuilder();
-		$query->update('cards')
-			->set('carddata', $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB))
-			->set('lastmodified', $query->createNamedParameter(time()))
-			->set('size', $query->createNamedParameter(strlen($cardData)))
-			->set('etag', $query->createNamedParameter($etag))
-			->set('uid', $query->createNamedParameter($uid))
-			->where($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 2);
-		$this->updateProperties($addressBookId, $cardUri, $cardData);
-
-		$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::updateCard',
-			new GenericEvent(null, [
-				'addressBookId' => $addressBookId,
-				'cardUri' => $cardUri,
-				'cardData' => $cardData]));
-
-		return '"' . $etag . '"';
-	}
-
-	/**
-	 * Deletes a card
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @return bool
-	 */
-	function deleteCard($addressBookId, $cardUri) {
-		try {
-			$cardId = $this->getCardId($addressBookId, $cardUri);
-		} catch (\InvalidArgumentException $e) {
-			$cardId = null;
-		}
-		$query = $this->db->getQueryBuilder();
-		$ret = $query->delete('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 3);
-
-		$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::deleteCard',
-			new GenericEvent(null, [
-				'addressBookId' => $addressBookId,
-				'cardUri' => $cardUri]));
-
-		if ($ret === 1) {
-			if ($cardId !== null) {
-				$this->purgeProperties($addressBookId, $cardId);
-			}
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * The getChanges method returns all the changes that have happened, since
-	 * the specified syncToken in the specified address book.
-	 *
-	 * This function should return an array, such as the following:
-	 *
-	 * [
-	 *   'syncToken' => 'The current synctoken',
-	 *   'added'   => [
-	 *      'new.txt',
-	 *   ],
-	 *   'modified'   => [
-	 *      'modified.txt',
-	 *   ],
-	 *   'deleted' => [
-	 *      'foo.php.bak',
-	 *      'old.txt'
-	 *   ]
-	 * ];
-	 *
-	 * The returned syncToken property should reflect the *current* syncToken
-	 * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
-	 * property. This is needed here too, to ensure the operation is atomic.
-	 *
-	 * If the $syncToken argument is specified as null, this is an initial
-	 * sync, and all members should be reported.
-	 *
-	 * The modified property is an array of nodenames that have changed since
-	 * the last token.
-	 *
-	 * The deleted property is an array with nodenames, that have been deleted
-	 * from collection.
-	 *
-	 * The $syncLevel argument is basically the 'depth' of the report. If it's
-	 * 1, you only have to report changes that happened only directly in
-	 * immediate descendants. If it's 2, it should also include changes from
-	 * the nodes below the child collections. (grandchildren)
-	 *
-	 * The $limit argument allows a client to specify how many results should
-	 * be returned at most. If the limit is not specified, it should be treated
-	 * as infinite.
-	 *
-	 * If the limit (infinite or not) is higher than you're willing to return,
-	 * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
-	 *
-	 * If the syncToken is expired (due to data cleanup) or unknown, you must
-	 * return null.
-	 *
-	 * The limit is 'suggestive'. You are free to ignore it.
-	 *
-	 * @param string $addressBookId
-	 * @param string $syncToken
-	 * @param int $syncLevel
-	 * @param int $limit
-	 * @return array
-	 */
-	function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
-		// Current synctoken
-		$stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
-		$stmt->execute([ $addressBookId ]);
-		$currentToken = $stmt->fetchColumn(0);
-
-		if (is_null($currentToken)) return null;
-
-		$result = [
-			'syncToken' => $currentToken,
-			'added'     => [],
-			'modified'  => [],
-			'deleted'   => [],
-		];
-
-		if ($syncToken) {
-
-			$query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
-			if ($limit>0) {
-				$query .= " LIMIT " . (int)$limit;
-			}
-
-			// Fetching all changes
-			$stmt = $this->db->prepare($query);
-			$stmt->execute([$syncToken, $currentToken, $addressBookId]);
-
-			$changes = [];
-
-			// This loop ensures that any duplicates are overwritten, only the
-			// last change on a node is relevant.
-			while($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-
-				$changes[$row['uri']] = $row['operation'];
-
-			}
-
-			foreach($changes as $uri => $operation) {
-
-				switch($operation) {
-					case 1:
-						$result['added'][] = $uri;
-						break;
-					case 2:
-						$result['modified'][] = $uri;
-						break;
-					case 3:
-						$result['deleted'][] = $uri;
-						break;
-				}
-
-			}
-		} else {
-			// No synctoken supplied, this is the initial sync.
-			$query = "SELECT `uri` FROM `*PREFIX*cards` WHERE `addressbookid` = ?";
-			$stmt = $this->db->prepare($query);
-			$stmt->execute([$addressBookId]);
-
-			$result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
-		}
-		return $result;
-	}
-
-	/**
-	 * Adds a change record to the addressbookchanges table.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $objectUri
-	 * @param int $operation 1 = add, 2 = modify, 3 = delete
-	 * @return void
-	 */
-	protected function addChange($addressBookId, $objectUri, $operation) {
-		$sql = 'INSERT INTO `*PREFIX*addressbookchanges`(`uri`, `synctoken`, `addressbookid`, `operation`) SELECT ?, `synctoken`, ?, ? FROM `*PREFIX*addressbooks` WHERE `id` = ?';
-		$stmt = $this->db->prepare($sql);
-		$stmt->execute([
-			$objectUri,
-			$addressBookId,
-			$operation,
-			$addressBookId
-		]);
-		$stmt = $this->db->prepare('UPDATE `*PREFIX*addressbooks` SET `synctoken` = `synctoken` + 1 WHERE `id` = ?');
-		$stmt->execute([
-			$addressBookId
-		]);
-	}
-
-	private function readBlob($cardData) {
-		if (is_resource($cardData)) {
-			return stream_get_contents($cardData);
-		}
-
-		return $cardData;
-	}
-
-	/**
-	 * @param IShareable $shareable
-	 * @param string[] $add
-	 * @param string[] $remove
-	 */
-	public function updateShares(IShareable $shareable, $add, $remove) {
-		$this->sharingBackend->updateShares($shareable, $add, $remove);
-	}
-
-	/**
-	 * search contact
-	 *
-	 * @param int $addressBookId
-	 * @param string $pattern which should match within the $searchProperties
-	 * @param array $searchProperties defines the properties within the query pattern should match
-	 * @param array $options = array() to define the search behavior
-	 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped, otherwise they are
-	 * @return array an array of contacts which are arrays of key-value-pairs
-	 */
-	public function search($addressBookId, $pattern, $searchProperties, $options = []) {
-		$query = $this->db->getQueryBuilder();
-		$query2 = $this->db->getQueryBuilder();
-
-		$query2->selectDistinct('cp.cardid')->from($this->dbCardsPropertiesTable, 'cp');
-		$query2->andWhere($query2->expr()->eq('cp.addressbookid', $query->createNamedParameter($addressBookId)));
-		$or = $query2->expr()->orX();
-		foreach ($searchProperties as $property) {
-			$or->add($query2->expr()->eq('cp.name', $query->createNamedParameter($property)));
-		}
-		$query2->andWhere($or);
-
-		// No need for like when the pattern is empty
-		if ('' !== $pattern) {
-			if(\array_key_exists('escape_like_param', $options) && $options['escape_like_param'] === false) {
-				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter($pattern)));
-			} else {
-				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%')));
-			}
-		}
-
-		$query->select('c.carddata', 'c.uri')->from($this->dbCardsTable, 'c')
-			->where($query->expr()->in('c.id', $query->createFunction($query2->getSQL())));
-
-		$result = $query->execute();
-		$cards = $result->fetchAll();
-
-		$result->closeCursor();
-
-		return array_map(function ($array) {
-			$array['carddata'] = $this->readBlob($array['carddata']);
-			return $array;
-		}, $cards);
-	}
-
-	/**
-	 * @param int $bookId
-	 * @param string $name
-	 * @return array
-	 */
-	public function collectCardProperties($bookId, $name) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->selectDistinct('value')
-			->from($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('name', $query->createNamedParameter($name)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($bookId)))
-			->execute();
-
-		$all = $result->fetchAll(PDO::FETCH_COLUMN);
-		$result->closeCursor();
-
-		return $all;
-	}
-
-	/**
-	 * get URI from a given contact
-	 *
-	 * @param int $id
-	 * @return string
-	 */
-	public function getCardUri($id) {
-		$query = $this->db->getQueryBuilder();
-		$query->select('uri')->from($this->dbCardsTable)
-				->where($query->expr()->eq('id', $query->createParameter('id')))
-				->setParameter('id', $id);
-
-		$result = $query->execute();
-		$uri = $result->fetch();
-		$result->closeCursor();
-
-		if (!isset($uri['uri'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $id);
-		}
-
-		return $uri['uri'];
-	}
-
-	/**
-	 * return contact with the given URI
-	 *
-	 * @param int $addressBookId
-	 * @param string $uri
-	 * @returns array
-	 */
-	public function getContact($addressBookId, $uri) {
-		$result = [];
-		$query = $this->db->getQueryBuilder();
-		$query->select('*')->from($this->dbCardsTable)
-				->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
-				->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-		$queryResult = $query->execute();
-		$contact = $queryResult->fetch();
-		$queryResult->closeCursor();
-
-		if (is_array($contact)) {
-			$result = $contact;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Returns the list of people whom this address book is shared with.
-	 *
-	 * Every element in this array should have the following properties:
-	 *   * href - Often a mailto: address
-	 *   * commonName - Optional, for example a first + last name
-	 *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
-	 *   * readOnly - boolean
-	 *   * summary - Optional, a description for the share
-	 *
-	 * @return array
-	 */
-	public function getShares($addressBookId) {
-		return $this->sharingBackend->getShares($addressBookId);
-	}
-
-	/**
-	 * update properties table
-	 *
-	 * @param int $addressBookId
-	 * @param string $cardUri
-	 * @param string $vCardSerialized
-	 */
-	protected function updateProperties($addressBookId, $cardUri, $vCardSerialized) {
-		$cardId = $this->getCardId($addressBookId, $cardUri);
-		$vCard = $this->readCard($vCardSerialized);
-
-		$this->purgeProperties($addressBookId, $cardId);
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert($this->dbCardsPropertiesTable)
-			->values(
-				[
-					'addressbookid' => $query->createNamedParameter($addressBookId),
-					'cardid' => $query->createNamedParameter($cardId),
-					'name' => $query->createParameter('name'),
-					'value' => $query->createParameter('value'),
-					'preferred' => $query->createParameter('preferred')
-				]
-			);
-
-		foreach ($vCard->children() as $property) {
-			if(!in_array($property->name, self::$indexProperties)) {
-				continue;
-			}
-			$preferred = 0;
-			foreach($property->parameters as $parameter) {
-				if ($parameter->name === 'TYPE' && strtoupper($parameter->getValue()) === 'PREF') {
-					$preferred = 1;
-					break;
-				}
-			}
-			$query->setParameter('name', $property->name);
-			$query->setParameter('value', mb_substr($property->getValue(), 0, 254));
-			$query->setParameter('preferred', $preferred);
-			$query->execute();
-		}
-	}
-
-	/**
-	 * read vCard data into a vCard object
-	 *
-	 * @param string $cardData
-	 * @return VCard
-	 */
-	protected function readCard($cardData) {
-		return  Reader::read($cardData);
-	}
-
-	/**
-	 * delete all properties from a given card
-	 *
-	 * @param int $addressBookId
-	 * @param int $cardId
-	 */
-	protected function purgeProperties($addressBookId, $cardId) {
-		$query = $this->db->getQueryBuilder();
-		$query->delete($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('cardid', $query->createNamedParameter($cardId)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-		$query->execute();
-	}
-
-	/**
-	 * get ID from a given contact
-	 *
-	 * @param int $addressBookId
-	 * @param string $uri
-	 * @return int
-	 */
-	protected function getCardId($addressBookId, $uri) {
-		$query = $this->db->getQueryBuilder();
-		$query->select('id')->from($this->dbCardsTable)
-			->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-
-		$result = $query->execute();
-		$cardIds = $result->fetch();
-		$result->closeCursor();
-
-		if (!isset($cardIds['id'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $uri);
-		}
-
-		return (int)$cardIds['id'];
-	}
-
-	/**
-	 * For shared address books the sharee is set in the ACL of the address book
-	 * @param $addressBookId
-	 * @param $acl
-	 * @return array
-	 */
-	public function applyShareAcl($addressBookId, $acl) {
-		return $this->sharingBackend->applyShareAcl($addressBookId, $acl);
-	}
-
-	private function convertPrincipal($principalUri, $toV2) {
-		if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
-			list(, $name) = \Sabre\Uri\split($principalUri);
-			if ($toV2 === true) {
-				return "principals/users/$name";
-			}
-			return "principals/$name";
-		}
-		return $principalUri;
-	}
-
-	private function addOwnerPrincipal(&$addressbookInfo) {
-		$ownerPrincipalKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal';
-		$displaynameKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}owner-displayname';
-		if (isset($addressbookInfo[$ownerPrincipalKey])) {
-			$uri = $addressbookInfo[$ownerPrincipalKey];
-		} else {
-			$uri = $addressbookInfo['principaluri'];
-		}
-
-		$principalInformation = $this->principalBackend->getPrincipalByPath($uri);
-		if (isset($principalInformation['{DAV:}displayname'])) {
-			$addressbookInfo[$displaynameKey] = $principalInformation['{DAV:}displayname'];
-		}
-	}
-
-	/**
-	 * Extract UID from vcard
-	 *
-	 * @param string $cardData the vcard raw data
-	 * @return string the uid
-	 * @throws BadRequest if no UID is available
-	 */
-	private function getUID($cardData) {
-		if ($cardData != '') {
-			$vCard = Reader::read($cardData);
-			if ($vCard->UID) {
-				$uid = $vCard->UID->getValue();
-				return $uid;
-			}
-			// should already be handled, but just in case
-			throw new BadRequest('vCards on CardDAV servers MUST have a UID property');
-		}
-		// should already be handled, but just in case
-		throw new BadRequest('vCard can not be empty');
-	}
+    const PERSONAL_ADDRESSBOOK_URI = 'contacts';
+    const PERSONAL_ADDRESSBOOK_NAME = 'Contacts';
+
+    /** @var Principal */
+    private $principalBackend;
+
+    /** @var string */
+    private $dbCardsTable = 'cards';
+
+    /** @var string */
+    private $dbCardsPropertiesTable = 'cards_properties';
+
+    /** @var IDBConnection */
+    private $db;
+
+    /** @var Backend */
+    private $sharingBackend;
+
+    /** @var array properties to index */
+    public static $indexProperties = [
+        'BDAY', 'UID', 'N', 'FN', 'TITLE', 'ROLE', 'NOTE', 'NICKNAME',
+        'ORG', 'CATEGORIES', 'EMAIL', 'TEL', 'IMPP', 'ADR', 'URL', 'GEO', 'CLOUD'];
+
+    /**
+     * @var string[] Map of uid => display name
+     */
+    protected $userDisplayNames;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var EventDispatcherInterface */
+    private $dispatcher;
+
+    /**
+     * CardDavBackend constructor.
+     *
+     * @param IDBConnection $db
+     * @param Principal $principalBackend
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(IDBConnection $db,
+                                Principal $principalBackend,
+                                IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                EventDispatcherInterface $dispatcher) {
+        $this->db = $db;
+        $this->principalBackend = $principalBackend;
+        $this->userManager = $userManager;
+        $this->dispatcher = $dispatcher;
+        $this->sharingBackend = new Backend($this->db, $this->userManager, $groupManager, $principalBackend, 'addressbook');
+    }
+
+    /**
+     * Return the number of address books for a principal
+     *
+     * @param $principalUri
+     * @return int
+     */
+    public function getAddressBooksForUserCount($principalUri) {
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select($query->func()->count('*'))
+            ->from('addressbooks')
+            ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        return (int)$query->execute()->fetchColumn();
+    }
+
+    /**
+     * Returns the list of address books for a specific user.
+     *
+     * Every addressbook should have the following properties:
+     *   id - an arbitrary unique id
+     *   uri - the 'basename' part of the url
+     *   principaluri - Same as the passed parameter
+     *
+     * Any additional clark-notation property may be passed besides this. Some
+     * common ones are :
+     *   {DAV:}displayname
+     *   {urn:ietf:params:xml:ns:carddav}addressbook-description
+     *   {http://calendarserver.org/ns/}getctag
+     *
+     * @param string $principalUri
+     * @return array
+     */
+    function getAddressBooksForUser($principalUri) {
+        $principalUriOriginal = $principalUri;
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        $addressBooks = [];
+
+        $result = $query->execute();
+        while($row = $result->fetch()) {
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $row['uri'],
+                'principaluri' => $this->convertPrincipal($row['principaluri'], false),
+                '{DAV:}displayname' => $row['displayname'],
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+            ];
+
+            $this->addOwnerPrincipal($addressBooks[$row['id']]);
+        }
+        $result->closeCursor();
+
+        // query for shared addressbooks
+        $principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
+        $principals = array_merge($principals, $this->principalBackend->getCircleMembership($principalUriOriginal));
+
+        $principals = array_map(function ($principal) {
+            return urldecode($principal);
+        }, $principals);
+        $principals[]= $principalUri;
+
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
+            ->from('dav_shares', 's')
+            ->join('s', 'addressbooks', 'a', $query->expr()->eq('s.resourceid', 'a.id'))
+            ->where($query->expr()->in('s.principaluri', $query->createParameter('principaluri')))
+            ->andWhere($query->expr()->eq('s.type', $query->createParameter('type')))
+            ->setParameter('type', 'addressbook')
+            ->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
+            ->execute();
+
+        $readOnlyPropertyName = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only';
+        while($row = $result->fetch()) {
+            if ($row['principaluri'] === $principalUri) {
+                continue;
+            }
+
+            $readOnly = (int) $row['access'] === Backend::ACCESS_READ;
+            if (isset($addressBooks[$row['id']])) {
+                if ($readOnly) {
+                    // New share can not have more permissions then the old one.
+                    continue;
+                }
+                if (isset($addressBooks[$row['id']][$readOnlyPropertyName]) &&
+                    $addressBooks[$row['id']][$readOnlyPropertyName] === 0) {
+                    // Old share is already read-write, no more permissions can be gained
+                    continue;
+                }
+            }
+
+            list(, $name) = \Sabre\Uri\split($row['principaluri']);
+            $uri = $row['uri'] . '_shared_by_' . $name;
+            $displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
+
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $uri,
+                'principaluri' => $principalUriOriginal,
+                '{DAV:}displayname' => $displayName,
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+                '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
+                $readOnlyPropertyName => $readOnly,
+            ];
+
+            $this->addOwnerPrincipal($addressBooks[$row['id']]);
+        }
+        $result->closeCursor();
+
+        return array_values($addressBooks);
+    }
+
+    public function getUsersOwnAddressBooks($principalUri) {
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+                ->from('addressbooks')
+                ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        $addressBooks = [];
+
+        $result = $query->execute();
+        while($row = $result->fetch()) {
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $row['uri'],
+                'principaluri' => $this->convertPrincipal($row['principaluri'], false),
+                '{DAV:}displayname' => $row['displayname'],
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+            ];
+
+            $this->addOwnerPrincipal($addressBooks[$row['id']]);
+        }
+        $result->closeCursor();
+
+        return array_values($addressBooks);
+    }
+
+    private function getUserDisplayName($uid) {
+        if (!isset($this->userDisplayNames[$uid])) {
+            $user = $this->userManager->get($uid);
+
+            if ($user instanceof IUser) {
+                $this->userDisplayNames[$uid] = $user->getDisplayName();
+            } else {
+                $this->userDisplayNames[$uid] = $uid;
+            }
+        }
+
+        return $this->userDisplayNames[$uid];
+    }
+
+    /**
+     * @param int $addressBookId
+     */
+    public function getAddressBookById($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+        $row = $result->fetch();
+        $result->closeCursor();
+        if ($row === false) {
+            return null;
+        }
+
+        $addressBook = [
+            'id'  => $row['id'],
+            'uri' => $row['uri'],
+            'principaluri' => $row['principaluri'],
+            '{DAV:}displayname' => $row['displayname'],
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+            '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+            '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+        ];
+
+        $this->addOwnerPrincipal($addressBook);
+
+        return $addressBook;
+    }
+
+    /**
+     * @param $addressBookUri
+     * @return array|null
+     */
+    public function getAddressBooksByUri($principal, $addressBookUri) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($addressBookUri)))
+            ->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($principal)))
+            ->setMaxResults(1)
+            ->execute();
+
+        $row = $result->fetch();
+        $result->closeCursor();
+        if ($row === false) {
+            return null;
+        }
+
+        $addressBook = [
+            'id'  => $row['id'],
+            'uri' => $row['uri'],
+            'principaluri' => $row['principaluri'],
+            '{DAV:}displayname' => $row['displayname'],
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+            '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+            '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+        ];
+
+        $this->addOwnerPrincipal($addressBook);
+
+        return $addressBook;
+    }
+
+    /**
+     * Updates properties for an address book.
+     *
+     * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+     * To do the actual updates, you must tell this object which properties
+     * you're going to process with the handle() method.
+     *
+     * Calling the handle method is like telling the PropPatch object "I
+     * promise I can handle updating this property".
+     *
+     * Read the PropPatch documentation for more info and examples.
+     *
+     * @param string $addressBookId
+     * @param \Sabre\DAV\PropPatch $propPatch
+     * @return void
+     */
+    function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
+        $supportedProperties = [
+            '{DAV:}displayname',
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description',
+        ];
+
+        /**
+         * @suppress SqlInjectionChecker
+         */
+        $propPatch->handle($supportedProperties, function ($mutations) use ($addressBookId) {
+
+            $updates = [];
+            foreach($mutations as $property=>$newValue) {
+
+                switch($property) {
+                    case '{DAV:}displayname':
+                        $updates['displayname'] = $newValue;
+                        break;
+                    case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
+                        $updates['description'] = $newValue;
+                        break;
+                }
+            }
+            $query = $this->db->getQueryBuilder();
+            $query->update('addressbooks');
+
+            foreach($updates as $key=>$value) {
+                $query->set($key, $query->createNamedParameter($value));
+            }
+            $query->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+            $this->addChange($addressBookId, "", 2);
+
+            return true;
+
+        });
+    }
+
+    /**
+     * Creates a new address book
+     *
+     * @param string $principalUri
+     * @param string $url Just the 'basename' of the url.
+     * @param array $properties
+     * @return int
+     * @throws BadRequest
+     */
+    function createAddressBook($principalUri, $url, array $properties) {
+        $values = [
+            'displayname' => null,
+            'description' => null,
+            'principaluri' => $principalUri,
+            'uri' => $url,
+            'synctoken' => 1
+        ];
+
+        foreach($properties as $property=>$newValue) {
+
+            switch($property) {
+                case '{DAV:}displayname':
+                    $values['displayname'] = $newValue;
+                    break;
+                case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
+                    $values['description'] = $newValue;
+                    break;
+                default:
+                    throw new BadRequest('Unknown property: ' . $property);
+            }
+
+        }
+
+        // Fallback to make sure the displayname is set. Some clients may refuse
+        // to work with addressbooks not having a displayname.
+        if(is_null($values['displayname'])) {
+            $values['displayname'] = $url;
+        }
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert('addressbooks')
+            ->values([
+                'uri' => $query->createParameter('uri'),
+                'displayname' => $query->createParameter('displayname'),
+                'description' => $query->createParameter('description'),
+                'principaluri' => $query->createParameter('principaluri'),
+                'synctoken' => $query->createParameter('synctoken'),
+            ])
+            ->setParameters($values)
+            ->execute();
+
+        return $query->getLastInsertId();
+    }
+
+    /**
+     * Deletes an entire addressbook and all its contents
+     *
+     * @param mixed $addressBookId
+     * @return void
+     */
+    function deleteAddressBook($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $query->delete('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
+            ->setParameter('addressbookid', $addressBookId)
+            ->execute();
+
+        $query->delete('addressbookchanges')
+            ->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
+            ->setParameter('addressbookid', $addressBookId)
+            ->execute();
+
+        $query->delete('addressbooks')
+            ->where($query->expr()->eq('id', $query->createParameter('id')))
+            ->setParameter('id', $addressBookId)
+            ->execute();
+
+        $this->sharingBackend->deleteAllShares($addressBookId);
+
+        $query->delete($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+    }
+
+    /**
+     * Returns all cards for a specific addressbook id.
+     *
+     * This method should return the following properties for each card:
+     *   * carddata - raw vcard data
+     *   * uri - Some unique url
+     *   * lastmodified - A unix timestamp
+     *
+     * It's recommended to also return the following properties:
+     *   * etag - A unique etag. This must change every time the card changes.
+     *   * size - The size of the card in bytes.
+     *
+     * If these last two properties are provided, less time will be spent
+     * calculating them. If they are specified, you can also ommit carddata.
+     * This may speed up certain requests, especially with large cards.
+     *
+     * @param mixed $addressBookId
+     * @return array
+     */
+    function getCards($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+
+        $cards = [];
+
+        $result = $query->execute();
+        while($row = $result->fetch()) {
+            $row['etag'] = '"' . $row['etag'] . '"';
+            $row['carddata'] = $this->readBlob($row['carddata']);
+            $cards[] = $row;
+        }
+        $result->closeCursor();
+
+        return $cards;
+    }
+
+    /**
+     * Returns a specific card.
+     *
+     * The same set of properties must be returned as with getCards. The only
+     * exception is that 'carddata' is absolutely required.
+     *
+     * If the card does not exist, you must return false.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @return array
+     */
+    function getCard($addressBookId, $cardUri) {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->setMaxResults(1);
+
+        $result = $query->execute();
+        $row = $result->fetch();
+        if (!$row) {
+            return false;
+        }
+        $row['etag'] = '"' . $row['etag'] . '"';
+        $row['carddata'] = $this->readBlob($row['carddata']);
+
+        return $row;
+    }
+
+    /**
+     * Returns a list of cards.
+     *
+     * This method should work identical to getCard, but instead return all the
+     * cards in the list as an array.
+     *
+     * If the backend supports this, it may allow for some speed-ups.
+     *
+     * @param mixed $addressBookId
+     * @param string[] $uris
+     * @return array
+     */
+    function getMultipleCards($addressBookId, array $uris) {
+        if (empty($uris)) {
+            return [];
+        }
+
+        $chunks = array_chunk($uris, 100);
+        $cards = [];
+
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->in('uri', $query->createParameter('uri')));
+
+        foreach ($chunks as $uris) {
+            $query->setParameter('uri', $uris, IQueryBuilder::PARAM_STR_ARRAY);
+            $result = $query->execute();
+
+            while ($row = $result->fetch()) {
+                $row['etag'] = '"' . $row['etag'] . '"';
+                $row['carddata'] = $this->readBlob($row['carddata']);
+                $cards[] = $row;
+            }
+            $result->closeCursor();
+        }
+        return $cards;
+    }
+
+    /**
+     * Creates a new card.
+     *
+     * The addressbook id will be passed as the first argument. This is the
+     * same id as it is returned from the getAddressBooksForUser method.
+     *
+     * The cardUri is a base uri, and doesn't include the full path. The
+     * cardData argument is the vcard body, and is passed as a string.
+     *
+     * It is possible to return an ETag from this method. This ETag is for the
+     * newly created resource, and must be enclosed with double quotes (that
+     * is, the string itself must contain the double quotes).
+     *
+     * You should only return the ETag if you store the carddata as-is. If a
+     * subsequent GET request on the same card does not have the same body,
+     * byte-by-byte and you did return an ETag here, clients tend to get
+     * confused.
+     *
+     * If you don't return an ETag, you can just return null.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @param string $cardData
+     * @return string
+     */
+    function createCard($addressBookId, $cardUri, $cardData) {
+        $etag = md5($cardData);
+        $uid = $this->getUID($cardData);
+
+        $q = $this->db->getQueryBuilder();
+        $q->select('uid')
+            ->from('cards')
+            ->where($q->expr()->eq('addressbookid', $q->createNamedParameter($addressBookId)))
+            ->andWhere($q->expr()->eq('uid', $q->createNamedParameter($uid)))
+            ->setMaxResults(1);
+        $result = $q->execute();
+        $count = (bool) $result->fetchColumn();
+        $result->closeCursor();
+        if ($count) {
+            throw new \Sabre\DAV\Exception\BadRequest('VCard object with uid already exists in this addressbook collection.');
+        }
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert('cards')
+            ->values([
+                'carddata' => $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB),
+                'uri' => $query->createNamedParameter($cardUri),
+                'lastmodified' => $query->createNamedParameter(time()),
+                'addressbookid' => $query->createNamedParameter($addressBookId),
+                'size' => $query->createNamedParameter(strlen($cardData)),
+                'etag' => $query->createNamedParameter($etag),
+                'uid' => $query->createNamedParameter($uid),
+            ])
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 1);
+        $this->updateProperties($addressBookId, $cardUri, $cardData);
+
+        $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::createCard',
+            new GenericEvent(null, [
+                'addressBookId' => $addressBookId,
+                'cardUri' => $cardUri,
+                'cardData' => $cardData]));
+
+        return '"' . $etag . '"';
+    }
+
+    /**
+     * Updates a card.
+     *
+     * The addressbook id will be passed as the first argument. This is the
+     * same id as it is returned from the getAddressBooksForUser method.
+     *
+     * The cardUri is a base uri, and doesn't include the full path. The
+     * cardData argument is the vcard body, and is passed as a string.
+     *
+     * It is possible to return an ETag from this method. This ETag should
+     * match that of the updated resource, and must be enclosed with double
+     * quotes (that is: the string itself must contain the actual quotes).
+     *
+     * You should only return the ETag if you store the carddata as-is. If a
+     * subsequent GET request on the same card does not have the same body,
+     * byte-by-byte and you did return an ETag here, clients tend to get
+     * confused.
+     *
+     * If you don't return an ETag, you can just return null.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @param string $cardData
+     * @return string
+     */
+    function updateCard($addressBookId, $cardUri, $cardData) {
+
+        $uid = $this->getUID($cardData);
+        $etag = md5($cardData);
+        $query = $this->db->getQueryBuilder();
+        $query->update('cards')
+            ->set('carddata', $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB))
+            ->set('lastmodified', $query->createNamedParameter(time()))
+            ->set('size', $query->createNamedParameter(strlen($cardData)))
+            ->set('etag', $query->createNamedParameter($etag))
+            ->set('uid', $query->createNamedParameter($uid))
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 2);
+        $this->updateProperties($addressBookId, $cardUri, $cardData);
+
+        $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::updateCard',
+            new GenericEvent(null, [
+                'addressBookId' => $addressBookId,
+                'cardUri' => $cardUri,
+                'cardData' => $cardData]));
+
+        return '"' . $etag . '"';
+    }
+
+    /**
+     * Deletes a card
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @return bool
+     */
+    function deleteCard($addressBookId, $cardUri) {
+        try {
+            $cardId = $this->getCardId($addressBookId, $cardUri);
+        } catch (\InvalidArgumentException $e) {
+            $cardId = null;
+        }
+        $query = $this->db->getQueryBuilder();
+        $ret = $query->delete('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 3);
+
+        $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::deleteCard',
+            new GenericEvent(null, [
+                'addressBookId' => $addressBookId,
+                'cardUri' => $cardUri]));
+
+        if ($ret === 1) {
+            if ($cardId !== null) {
+                $this->purgeProperties($addressBookId, $cardId);
+            }
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * The getChanges method returns all the changes that have happened, since
+     * the specified syncToken in the specified address book.
+     *
+     * This function should return an array, such as the following:
+     *
+     * [
+     *   'syncToken' => 'The current synctoken',
+     *   'added'   => [
+     *      'new.txt',
+     *   ],
+     *   'modified'   => [
+     *      'modified.txt',
+     *   ],
+     *   'deleted' => [
+     *      'foo.php.bak',
+     *      'old.txt'
+     *   ]
+     * ];
+     *
+     * The returned syncToken property should reflect the *current* syncToken
+     * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
+     * property. This is needed here too, to ensure the operation is atomic.
+     *
+     * If the $syncToken argument is specified as null, this is an initial
+     * sync, and all members should be reported.
+     *
+     * The modified property is an array of nodenames that have changed since
+     * the last token.
+     *
+     * The deleted property is an array with nodenames, that have been deleted
+     * from collection.
+     *
+     * The $syncLevel argument is basically the 'depth' of the report. If it's
+     * 1, you only have to report changes that happened only directly in
+     * immediate descendants. If it's 2, it should also include changes from
+     * the nodes below the child collections. (grandchildren)
+     *
+     * The $limit argument allows a client to specify how many results should
+     * be returned at most. If the limit is not specified, it should be treated
+     * as infinite.
+     *
+     * If the limit (infinite or not) is higher than you're willing to return,
+     * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
+     *
+     * If the syncToken is expired (due to data cleanup) or unknown, you must
+     * return null.
+     *
+     * The limit is 'suggestive'. You are free to ignore it.
+     *
+     * @param string $addressBookId
+     * @param string $syncToken
+     * @param int $syncLevel
+     * @param int $limit
+     * @return array
+     */
+    function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
+        // Current synctoken
+        $stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
+        $stmt->execute([ $addressBookId ]);
+        $currentToken = $stmt->fetchColumn(0);
+
+        if (is_null($currentToken)) return null;
+
+        $result = [
+            'syncToken' => $currentToken,
+            'added'     => [],
+            'modified'  => [],
+            'deleted'   => [],
+        ];
+
+        if ($syncToken) {
+
+            $query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
+            if ($limit>0) {
+                $query .= " LIMIT " . (int)$limit;
+            }
+
+            // Fetching all changes
+            $stmt = $this->db->prepare($query);
+            $stmt->execute([$syncToken, $currentToken, $addressBookId]);
+
+            $changes = [];
+
+            // This loop ensures that any duplicates are overwritten, only the
+            // last change on a node is relevant.
+            while($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+
+                $changes[$row['uri']] = $row['operation'];
+
+            }
+
+            foreach($changes as $uri => $operation) {
+
+                switch($operation) {
+                    case 1:
+                        $result['added'][] = $uri;
+                        break;
+                    case 2:
+                        $result['modified'][] = $uri;
+                        break;
+                    case 3:
+                        $result['deleted'][] = $uri;
+                        break;
+                }
+
+            }
+        } else {
+            // No synctoken supplied, this is the initial sync.
+            $query = "SELECT `uri` FROM `*PREFIX*cards` WHERE `addressbookid` = ?";
+            $stmt = $this->db->prepare($query);
+            $stmt->execute([$addressBookId]);
+
+            $result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
+        }
+        return $result;
+    }
+
+    /**
+     * Adds a change record to the addressbookchanges table.
+     *
+     * @param mixed $addressBookId
+     * @param string $objectUri
+     * @param int $operation 1 = add, 2 = modify, 3 = delete
+     * @return void
+     */
+    protected function addChange($addressBookId, $objectUri, $operation) {
+        $sql = 'INSERT INTO `*PREFIX*addressbookchanges`(`uri`, `synctoken`, `addressbookid`, `operation`) SELECT ?, `synctoken`, ?, ? FROM `*PREFIX*addressbooks` WHERE `id` = ?';
+        $stmt = $this->db->prepare($sql);
+        $stmt->execute([
+            $objectUri,
+            $addressBookId,
+            $operation,
+            $addressBookId
+        ]);
+        $stmt = $this->db->prepare('UPDATE `*PREFIX*addressbooks` SET `synctoken` = `synctoken` + 1 WHERE `id` = ?');
+        $stmt->execute([
+            $addressBookId
+        ]);
+    }
+
+    private function readBlob($cardData) {
+        if (is_resource($cardData)) {
+            return stream_get_contents($cardData);
+        }
+
+        return $cardData;
+    }
+
+    /**
+     * @param IShareable $shareable
+     * @param string[] $add
+     * @param string[] $remove
+     */
+    public function updateShares(IShareable $shareable, $add, $remove) {
+        $this->sharingBackend->updateShares($shareable, $add, $remove);
+    }
+
+    /**
+     * search contact
+     *
+     * @param int $addressBookId
+     * @param string $pattern which should match within the $searchProperties
+     * @param array $searchProperties defines the properties within the query pattern should match
+     * @param array $options = array() to define the search behavior
+     * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped, otherwise they are
+     * @return array an array of contacts which are arrays of key-value-pairs
+     */
+    public function search($addressBookId, $pattern, $searchProperties, $options = []) {
+        $query = $this->db->getQueryBuilder();
+        $query2 = $this->db->getQueryBuilder();
+
+        $query2->selectDistinct('cp.cardid')->from($this->dbCardsPropertiesTable, 'cp');
+        $query2->andWhere($query2->expr()->eq('cp.addressbookid', $query->createNamedParameter($addressBookId)));
+        $or = $query2->expr()->orX();
+        foreach ($searchProperties as $property) {
+            $or->add($query2->expr()->eq('cp.name', $query->createNamedParameter($property)));
+        }
+        $query2->andWhere($or);
+
+        // No need for like when the pattern is empty
+        if ('' !== $pattern) {
+            if(\array_key_exists('escape_like_param', $options) && $options['escape_like_param'] === false) {
+                $query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter($pattern)));
+            } else {
+                $query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%')));
+            }
+        }
+
+        $query->select('c.carddata', 'c.uri')->from($this->dbCardsTable, 'c')
+            ->where($query->expr()->in('c.id', $query->createFunction($query2->getSQL())));
+
+        $result = $query->execute();
+        $cards = $result->fetchAll();
+
+        $result->closeCursor();
+
+        return array_map(function ($array) {
+            $array['carddata'] = $this->readBlob($array['carddata']);
+            return $array;
+        }, $cards);
+    }
+
+    /**
+     * @param int $bookId
+     * @param string $name
+     * @return array
+     */
+    public function collectCardProperties($bookId, $name) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->selectDistinct('value')
+            ->from($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('name', $query->createNamedParameter($name)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($bookId)))
+            ->execute();
+
+        $all = $result->fetchAll(PDO::FETCH_COLUMN);
+        $result->closeCursor();
+
+        return $all;
+    }
+
+    /**
+     * get URI from a given contact
+     *
+     * @param int $id
+     * @return string
+     */
+    public function getCardUri($id) {
+        $query = $this->db->getQueryBuilder();
+        $query->select('uri')->from($this->dbCardsTable)
+                ->where($query->expr()->eq('id', $query->createParameter('id')))
+                ->setParameter('id', $id);
+
+        $result = $query->execute();
+        $uri = $result->fetch();
+        $result->closeCursor();
+
+        if (!isset($uri['uri'])) {
+            throw new \InvalidArgumentException('Card does not exists: ' . $id);
+        }
+
+        return $uri['uri'];
+    }
+
+    /**
+     * return contact with the given URI
+     *
+     * @param int $addressBookId
+     * @param string $uri
+     * @returns array
+     */
+    public function getContact($addressBookId, $uri) {
+        $result = [];
+        $query = $this->db->getQueryBuilder();
+        $query->select('*')->from($this->dbCardsTable)
+                ->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
+                ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+        $queryResult = $query->execute();
+        $contact = $queryResult->fetch();
+        $queryResult->closeCursor();
+
+        if (is_array($contact)) {
+            $result = $contact;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Returns the list of people whom this address book is shared with.
+     *
+     * Every element in this array should have the following properties:
+     *   * href - Often a mailto: address
+     *   * commonName - Optional, for example a first + last name
+     *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
+     *   * readOnly - boolean
+     *   * summary - Optional, a description for the share
+     *
+     * @return array
+     */
+    public function getShares($addressBookId) {
+        return $this->sharingBackend->getShares($addressBookId);
+    }
+
+    /**
+     * update properties table
+     *
+     * @param int $addressBookId
+     * @param string $cardUri
+     * @param string $vCardSerialized
+     */
+    protected function updateProperties($addressBookId, $cardUri, $vCardSerialized) {
+        $cardId = $this->getCardId($addressBookId, $cardUri);
+        $vCard = $this->readCard($vCardSerialized);
+
+        $this->purgeProperties($addressBookId, $cardId);
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert($this->dbCardsPropertiesTable)
+            ->values(
+                [
+                    'addressbookid' => $query->createNamedParameter($addressBookId),
+                    'cardid' => $query->createNamedParameter($cardId),
+                    'name' => $query->createParameter('name'),
+                    'value' => $query->createParameter('value'),
+                    'preferred' => $query->createParameter('preferred')
+                ]
+            );
+
+        foreach ($vCard->children() as $property) {
+            if(!in_array($property->name, self::$indexProperties)) {
+                continue;
+            }
+            $preferred = 0;
+            foreach($property->parameters as $parameter) {
+                if ($parameter->name === 'TYPE' && strtoupper($parameter->getValue()) === 'PREF') {
+                    $preferred = 1;
+                    break;
+                }
+            }
+            $query->setParameter('name', $property->name);
+            $query->setParameter('value', mb_substr($property->getValue(), 0, 254));
+            $query->setParameter('preferred', $preferred);
+            $query->execute();
+        }
+    }
+
+    /**
+     * read vCard data into a vCard object
+     *
+     * @param string $cardData
+     * @return VCard
+     */
+    protected function readCard($cardData) {
+        return  Reader::read($cardData);
+    }
+
+    /**
+     * delete all properties from a given card
+     *
+     * @param int $addressBookId
+     * @param int $cardId
+     */
+    protected function purgeProperties($addressBookId, $cardId) {
+        $query = $this->db->getQueryBuilder();
+        $query->delete($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('cardid', $query->createNamedParameter($cardId)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+        $query->execute();
+    }
+
+    /**
+     * get ID from a given contact
+     *
+     * @param int $addressBookId
+     * @param string $uri
+     * @return int
+     */
+    protected function getCardId($addressBookId, $uri) {
+        $query = $this->db->getQueryBuilder();
+        $query->select('id')->from($this->dbCardsTable)
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+
+        $result = $query->execute();
+        $cardIds = $result->fetch();
+        $result->closeCursor();
+
+        if (!isset($cardIds['id'])) {
+            throw new \InvalidArgumentException('Card does not exists: ' . $uri);
+        }
+
+        return (int)$cardIds['id'];
+    }
+
+    /**
+     * For shared address books the sharee is set in the ACL of the address book
+     * @param $addressBookId
+     * @param $acl
+     * @return array
+     */
+    public function applyShareAcl($addressBookId, $acl) {
+        return $this->sharingBackend->applyShareAcl($addressBookId, $acl);
+    }
+
+    private function convertPrincipal($principalUri, $toV2) {
+        if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
+            list(, $name) = \Sabre\Uri\split($principalUri);
+            if ($toV2 === true) {
+                return "principals/users/$name";
+            }
+            return "principals/$name";
+        }
+        return $principalUri;
+    }
+
+    private function addOwnerPrincipal(&$addressbookInfo) {
+        $ownerPrincipalKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal';
+        $displaynameKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}owner-displayname';
+        if (isset($addressbookInfo[$ownerPrincipalKey])) {
+            $uri = $addressbookInfo[$ownerPrincipalKey];
+        } else {
+            $uri = $addressbookInfo['principaluri'];
+        }
+
+        $principalInformation = $this->principalBackend->getPrincipalByPath($uri);
+        if (isset($principalInformation['{DAV:}displayname'])) {
+            $addressbookInfo[$displaynameKey] = $principalInformation['{DAV:}displayname'];
+        }
+    }
+
+    /**
+     * Extract UID from vcard
+     *
+     * @param string $cardData the vcard raw data
+     * @return string the uid
+     * @throws BadRequest if no UID is available
+     */
+    private function getUID($cardData) {
+        if ($cardData != '') {
+            $vCard = Reader::read($cardData);
+            if ($vCard->UID) {
+                $uid = $vCard->UID->getValue();
+                return $uid;
+            }
+            // should already be handled, but just in case
+            throw new BadRequest('vCards on CardDAV servers MUST have a UID property');
+        }
+        // should already be handled, but just in case
+        throw new BadRequest('vCard can not be empty');
+    }
 }

Spacing +53 added lines, -53 removed lines

@@ -124,7 +124,7 @@ 
 			->from('addressbooks')
 			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
 
-		return (int)$query->execute()->fetchColumn();
+		return (int) $query->execute()->fetchColumn();
 	}
 
 	/**
@@ -155,15 +155,15 @@ 
 		$addressBooks = [];
 
 		$result = $query->execute();
-		while($row = $result->fetch()) {
+		while ($row = $result->fetch()) {
 			$addressBooks[$row['id']] = [
 				'id'  => $row['id'],
 				'uri' => $row['uri'],
 				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
 				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+				'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+				'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 			];
 
 			$this->addOwnerPrincipal($addressBooks[$row['id']]);
@@ -174,10 +174,10 @@ 
 		$principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
 		$principals = array_merge($principals, $this->principalBackend->getCircleMembership($principalUriOriginal));
 
-		$principals = array_map(function ($principal) {
+		$principals = array_map(function($principal) {
 			return urldecode($principal);
 		}, $principals);
-		$principals[]= $principalUri;
+		$principals[] = $principalUri;
 
 		$query = $this->db->getQueryBuilder();
 		$result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
@@ -189,8 +189,8 @@ 
 			->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
 			->execute();
 
-		$readOnlyPropertyName = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only';
-		while($row = $result->fetch()) {
+		$readOnlyPropertyName = '{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}read-only';
+		while ($row = $result->fetch()) {
 			if ($row['principaluri'] === $principalUri) {
 				continue;
 			}
@@ -209,18 +209,18 @@ 
 			}
 
 			list(, $name) = \Sabre\Uri\split($row['principaluri']);
-			$uri = $row['uri'] . '_shared_by_' . $name;
-			$displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
+			$uri = $row['uri'].'_shared_by_'.$name;
+			$displayName = $row['displayname'].' ('.$this->getUserDisplayName($name).')';
 
 			$addressBooks[$row['id']] = [
 				'id'  => $row['id'],
 				'uri' => $uri,
 				'principaluri' => $principalUriOriginal,
 				'{DAV:}displayname' => $displayName,
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+				'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-				'{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
+				'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
+				'{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}owner-principal' => $row['principaluri'],
 				$readOnlyPropertyName => $readOnly,
 			];
 
@@ -241,15 +241,15 @@ 
 		$addressBooks = [];
 
 		$result = $query->execute();
-		while($row = $result->fetch()) {
+		while ($row = $result->fetch()) {
 			$addressBooks[$row['id']] = [
 				'id'  => $row['id'],
 				'uri' => $row['uri'],
 				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
 				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+				'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+				'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 			];
 
 			$this->addOwnerPrincipal($addressBooks[$row['id']]);
@@ -294,9 +294,9 @@ 
 			'uri' => $row['uri'],
 			'principaluri' => $row['principaluri'],
 			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+			'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+			'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 		];
 
 		$this->addOwnerPrincipal($addressBook);
@@ -328,9 +328,9 @@ 
 			'uri' => $row['uri'],
 			'principaluri' => $row['principaluri'],
 			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+			'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+			'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 		];
 
 		$this->addOwnerPrincipal($addressBook);
@@ -357,22 +357,22 @@ 
 	function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
 		$supportedProperties = [
 			'{DAV:}displayname',
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description',
+			'{'.Plugin::NS_CARDDAV.'}addressbook-description',
 		];
 
 		/**
 		 * @suppress SqlInjectionChecker
 		 */
-		$propPatch->handle($supportedProperties, function ($mutations) use ($addressBookId) {
+		$propPatch->handle($supportedProperties, function($mutations) use ($addressBookId) {
 
 			$updates = [];
-			foreach($mutations as $property=>$newValue) {
+			foreach ($mutations as $property=>$newValue) {
 
-				switch($property) {
+				switch ($property) {
 					case '{DAV:}displayname':
 						$updates['displayname'] = $newValue;
 						break;
-					case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
+					case '{'.Plugin::NS_CARDDAV.'}addressbook-description':
 						$updates['description'] = $newValue;
 						break;
 				}
@@ -380,7 +380,7 @@ 
 			$query = $this->db->getQueryBuilder();
 			$query->update('addressbooks');
 
-			foreach($updates as $key=>$value) {
+			foreach ($updates as $key=>$value) {
 				$query->set($key, $query->createNamedParameter($value));
 			}
 			$query->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
@@ -411,24 +411,24 @@ 
 			'synctoken' => 1
 		];
 
-		foreach($properties as $property=>$newValue) {
+		foreach ($properties as $property=>$newValue) {
 
-			switch($property) {
+			switch ($property) {
 				case '{DAV:}displayname':
 					$values['displayname'] = $newValue;
 					break;
-				case '{' . Plugin::NS_CARDDAV . '}addressbook-description':
+				case '{'.Plugin::NS_CARDDAV.'}addressbook-description':
 					$values['description'] = $newValue;
 					break;
 				default:
-					throw new BadRequest('Unknown property: ' . $property);
+					throw new BadRequest('Unknown property: '.$property);
 			}
 
 		}
 
 		// Fallback to make sure the displayname is set. Some clients may refuse
 		// to work with addressbooks not having a displayname.
-		if(is_null($values['displayname'])) {
+		if (is_null($values['displayname'])) {
 			$values['displayname'] = $url;
 		}
 
@@ -506,8 +506,8 @@ 
 		$cards = [];
 
 		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$row['etag'] = '"' . $row['etag'] . '"';
+		while ($row = $result->fetch()) {
+			$row['etag'] = '"'.$row['etag'].'"';
 			$row['carddata'] = $this->readBlob($row['carddata']);
 			$cards[] = $row;
 		}
@@ -541,7 +541,7 @@ 
 		if (!$row) {
 			return false;
 		}
-		$row['etag'] = '"' . $row['etag'] . '"';
+		$row['etag'] = '"'.$row['etag'].'"';
 		$row['carddata'] = $this->readBlob($row['carddata']);
 
 		return $row;
@@ -578,7 +578,7 @@ 
 			$result = $query->execute();
 
 			while ($row = $result->fetch()) {
-				$row['etag'] = '"' . $row['etag'] . '"';
+				$row['etag'] = '"'.$row['etag'].'"';
 				$row['carddata'] = $this->readBlob($row['carddata']);
 				$cards[] = $row;
 			}
@@ -651,7 +651,7 @@ 
 				'cardUri' => $cardUri,
 				'cardData' => $cardData]));
 
-		return '"' . $etag . '"';
+		return '"'.$etag.'"';
 	}
 
 	/**
@@ -703,7 +703,7 @@ 
 				'cardUri' => $cardUri,
 				'cardData' => $cardData]));
 
-		return '"' . $etag . '"';
+		return '"'.$etag.'"';
 	}
 
 	/**
@@ -801,7 +801,7 @@ 
 	function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
 		// Current synctoken
 		$stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
-		$stmt->execute([ $addressBookId ]);
+		$stmt->execute([$addressBookId]);
 		$currentToken = $stmt->fetchColumn(0);
 
 		if (is_null($currentToken)) return null;
@@ -816,8 +816,8 @@ 
 		if ($syncToken) {
 
 			$query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
-			if ($limit>0) {
-				$query .= " LIMIT " . (int)$limit;
+			if ($limit > 0) {
+				$query .= " LIMIT ".(int) $limit;
 			}
 
 			// Fetching all changes
@@ -828,15 +828,15 @@ 
 
 			// This loop ensures that any duplicates are overwritten, only the
 			// last change on a node is relevant.
-			while($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+			while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
 
 				$changes[$row['uri']] = $row['operation'];
 
 			}
 
-			foreach($changes as $uri => $operation) {
+			foreach ($changes as $uri => $operation) {
 
-				switch($operation) {
+				switch ($operation) {
 					case 1:
 						$result['added'][] = $uri;
 						break;
@@ -924,10 +924,10 @@ 
 
 		// No need for like when the pattern is empty
 		if ('' !== $pattern) {
-			if(\array_key_exists('escape_like_param', $options) && $options['escape_like_param'] === false) {
+			if (\array_key_exists('escape_like_param', $options) && $options['escape_like_param'] === false) {
 				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter($pattern)));
 			} else {
-				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%')));
+				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter('%'.$this->db->escapeLikeParameter($pattern).'%')));
 			}
 		}
 
@@ -939,7 +939,7 @@ 
 
 		$result->closeCursor();
 
-		return array_map(function ($array) {
+		return array_map(function($array) {
 			$array['carddata'] = $this->readBlob($array['carddata']);
 			return $array;
 		}, $cards);
@@ -981,7 +981,7 @@ 
 		$result->closeCursor();
 
 		if (!isset($uri['uri'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $id);
+			throw new \InvalidArgumentException('Card does not exists: '.$id);
 		}
 
 		return $uri['uri'];
@@ -1053,11 +1053,11 @@ 
 			);
 
 		foreach ($vCard->children() as $property) {
-			if(!in_array($property->name, self::$indexProperties)) {
+			if (!in_array($property->name, self::$indexProperties)) {
 				continue;
 			}
 			$preferred = 0;
-			foreach($property->parameters as $parameter) {
+			foreach ($property->parameters as $parameter) {
 				if ($parameter->name === 'TYPE' && strtoupper($parameter->getValue()) === 'PREF') {
 					$preferred = 1;
 					break;
@@ -1112,10 +1112,10 @@ 
 		$result->closeCursor();
 
 		if (!isset($cardIds['id'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $uri);
+			throw new \InvalidArgumentException('Card does not exists: '.$uri);
 		}
 
-		return (int)$cardIds['id'];
+		return (int) $cardIds['id'];
 	}
 
 	/**
@@ -1140,8 +1140,8 @@ 
 	}
 
 	private function addOwnerPrincipal(&$addressbookInfo) {
-		$ownerPrincipalKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal';
-		$displaynameKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}owner-displayname';
+		$ownerPrincipalKey = '{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}owner-principal';
+		$displaynameKey = '{'.\OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD.'}owner-displayname';
 		if (isset($addressbookInfo[$ownerPrincipalKey])) {
 			$uri = $addressbookInfo[$ownerPrincipalKey];
 		} else {

apps/cloud_federation_api/lib/Controller/RequestHandlerController.php

Indentation +244 added lines, -244 removed lines

@@ -53,249 +53,249 @@
  */
 class RequestHandlerController extends Controller {
 
-	/** @var ILogger */
-	private $logger;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	/** @var ICloudFederationProviderManager */
-	private $cloudFederationProviderManager;
-
-	/** @var Config */
-	private $config;
-
-	/** @var ICloudFederationFactory */
-	private $factory;
-
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
-
-	public function __construct($appName,
-								IRequest $request,
-								ILogger $logger,
-								IUserManager $userManager,
-								IGroupManager $groupManager,
-								IURLGenerator $urlGenerator,
-								ICloudFederationProviderManager $cloudFederationProviderManager,
-								Config $config,
-								ICloudFederationFactory $factory,
-								ICloudIdManager $cloudIdManager
-	) {
-		parent::__construct($appName, $request);
-
-		$this->logger = $logger;
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->urlGenerator = $urlGenerator;
-		$this->cloudFederationProviderManager = $cloudFederationProviderManager;
-		$this->config = $config;
-		$this->factory = $factory;
-		$this->cloudIdManager = $cloudIdManager;
-	}
-
-	/**
-	 * add share
-	 *
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 * @BruteForceProtection(action=receiveFederatedShare)
-	 *
-	 * @param string $shareWith
-	 * @param string $name resource name (e.g. document.odt)
-	 * @param string $description share description (optional)
-	 * @param string $providerId resource UID on the provider side
-	 * @param string $owner provider specific UID of the user who owns the resource
-	 * @param string $ownerDisplayName display name of the user who shared the item
-	 * @param string $sharedBy provider specific UID of the user who shared the resource
-	 * @param string $sharedByDisplayName display name of the user who shared the resource
-	 * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
-	 * @param string $shareType ('group' or 'user' share)
-	 * @param $resourceType ('file', 'calendar',...)
-	 * @return Http\DataResponse|JSONResponse
-	 *
-	 * Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"sharedSecret":"secret","permissions":"webdav-property"}}}' http://localhost/server/index.php/ocm/shares
-	 */
-	public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
-
-		// check if all required parameters are set
-		if ($shareWith === null ||
-			$name === null ||
-			$providerId === null ||
-			$owner === null ||
-			$resourceType === null ||
-			$shareType === null ||
-			!is_array($protocol) ||
-			!isset($protocol['name']) ||
-			!isset($protocol['options']) ||
-			!is_array($protocol['options']) ||
-			!isset($protocol['options']['sharedSecret'])
-		) {
-			return new JSONResponse(
-				['message' => 'Missing arguments'],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
-
-		$supportedShareTypes = $this->config->getSupportedShareTypes($resourceType);
-		if (!in_array($shareType, $supportedShareTypes)) {
-			return new JSONResponse(
-				['message' => 'Share type "' . $shareType . '" not implemented'],
-				Http::STATUS_NOT_IMPLEMENTED
-			);
-		}
-
-		$cloudId = $this->cloudIdManager->resolveCloudId($shareWith);
-		$shareWith = $cloudId->getUser();
-
-		if ($shareType === 'user') {
-			$shareWith = $this->mapUid($shareWith);
-
-			if (!$this->userManager->userExists($shareWith)) {
-				return new JSONResponse(
-					['message' => 'User "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
-					Http::STATUS_BAD_REQUEST
-				);
-			}
-		}
-
-		if ($shareType === 'group') {
-			if(!$this->groupManager->groupExists($shareWith)) {
-				return new JSONResponse(
-					['message' => 'Group "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
-					Http::STATUS_BAD_REQUEST
-				);
-			}
-		}
-
-		// if no explicit display name is given, we use the uid as display name
-		$ownerDisplayName = $ownerDisplayName === null ? $owner : $ownerDisplayName;
-		$sharedByDisplayName = $sharedByDisplayName === null ? $sharedBy : $sharedByDisplayName;
-
-		// sharedBy* parameter is optional, if nothing is set we assume that it is the same user as the owner
-		if ($sharedBy === null) {
-			$sharedBy = $owner;
-			$sharedByDisplayName = $ownerDisplayName;
-		}
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
-			$share = $this->factory->getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, '', $shareType, $resourceType);
-			$share->setProtocol($protocol);
-			$provider->shareReceived($share);
-		} catch (ProviderDoesNotExistsException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_NOT_IMPLEMENTED
-			);
-		} catch (ProviderCouldNotAddShareException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				$e->getCode()
-			);
-		} catch (\Exception $e) {
-			return new JSONResponse(
-				['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
-
-		$user = $this->userManager->get($shareWith);
-		$recipientDisplayName = '';
-		if($user) {
-			$recipientDisplayName = $user->getDisplayName();
-		}
-
-		return new JSONResponse(
-			['recipientDisplayName' => $recipientDisplayName],
-			Http::STATUS_CREATED);
-
-	}
-
-	/**
-	 * receive notification about existing share
-	 *
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 * @BruteForceProtection(action=receiveFederatedShareNotification)
-	 *
-	 * @param string $notificationType (notification type, e.g. SHARE_ACCEPTED)
-	 * @param string $resourceType (calendar, file, contact,...)
-	 * @param string $providerId id of the share
-	 * @param array $notification the actual payload of the notification
-	 * @return JSONResponse
-	 */
-	public function receiveNotification($notificationType, $resourceType, $providerId, array $notification) {
-
-		// check if all required parameters are set
-		if ($notificationType === null ||
-			$resourceType === null ||
-			$providerId === null ||
-			!is_array($notification)
-		) {
-			return new JSONResponse(
-				['message' => 'Missing arguments'],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
-			$result = $provider->notificationReceived($notificationType, $providerId, $notification);
-		} catch (ProviderDoesNotExistsException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_BAD_REQUEST
-			);
-		} catch (ShareNotFound $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_BAD_REQUEST
-			);
-		} catch (ActionNotSupportedException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_NOT_IMPLEMENTED
-			);
-		} catch (BadRequestException $e) {
-			return new JSONResponse($e->getReturnMessage(), Http::STATUS_BAD_REQUEST);
-		} catch (AuthenticationFailedException $e) {
-			return new JSONResponse(["message" => "RESOURCE_NOT_FOUND"], Http::STATUS_FORBIDDEN);
-		}
-		catch (\Exception $e) {
-			return new JSONResponse(
-				['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
-
-		return new JSONResponse($result,Http::STATUS_CREATED);
-
-	}
-
-	/**
-	 * map login name to internal LDAP UID if a LDAP backend is in use
-	 *
-	 * @param string $uid
-	 * @return string mixed
-	 */
-	private function mapUid($uid) {
-		// FIXME this should be a method in the user management instead
-		$this->logger->debug('shareWith before, ' . $uid, ['app' => $this->appName]);
-		\OCP\Util::emitHook(
-			'\OCA\Files_Sharing\API\Server2Server',
-			'preLoginNameUsedAsUserName',
-			['uid' => &$uid]
-		);
-		$this->logger->debug('shareWith after, ' . $uid, ['app' => $this->appName]);
-
-		return $uid;
-	}
+    /** @var ILogger */
+    private $logger;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var IURLGenerator */
+    private $urlGenerator;
+
+    /** @var ICloudFederationProviderManager */
+    private $cloudFederationProviderManager;
+
+    /** @var Config */
+    private $config;
+
+    /** @var ICloudFederationFactory */
+    private $factory;
+
+    /** @var ICloudIdManager */
+    private $cloudIdManager;
+
+    public function __construct($appName,
+                                IRequest $request,
+                                ILogger $logger,
+                                IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                IURLGenerator $urlGenerator,
+                                ICloudFederationProviderManager $cloudFederationProviderManager,
+                                Config $config,
+                                ICloudFederationFactory $factory,
+                                ICloudIdManager $cloudIdManager
+    ) {
+        parent::__construct($appName, $request);
+
+        $this->logger = $logger;
+        $this->userManager = $userManager;
+        $this->groupManager = $groupManager;
+        $this->urlGenerator = $urlGenerator;
+        $this->cloudFederationProviderManager = $cloudFederationProviderManager;
+        $this->config = $config;
+        $this->factory = $factory;
+        $this->cloudIdManager = $cloudIdManager;
+    }
+
+    /**
+     * add share
+     *
+     * @NoCSRFRequired
+     * @PublicPage
+     * @BruteForceProtection(action=receiveFederatedShare)
+     *
+     * @param string $shareWith
+     * @param string $name resource name (e.g. document.odt)
+     * @param string $description share description (optional)
+     * @param string $providerId resource UID on the provider side
+     * @param string $owner provider specific UID of the user who owns the resource
+     * @param string $ownerDisplayName display name of the user who shared the item
+     * @param string $sharedBy provider specific UID of the user who shared the resource
+     * @param string $sharedByDisplayName display name of the user who shared the resource
+     * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
+     * @param string $shareType ('group' or 'user' share)
+     * @param $resourceType ('file', 'calendar',...)
+     * @return Http\DataResponse|JSONResponse
+     *
+     * Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"sharedSecret":"secret","permissions":"webdav-property"}}}' http://localhost/server/index.php/ocm/shares
+     */
+    public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
+
+        // check if all required parameters are set
+        if ($shareWith === null ||
+            $name === null ||
+            $providerId === null ||
+            $owner === null ||
+            $resourceType === null ||
+            $shareType === null ||
+            !is_array($protocol) ||
+            !isset($protocol['name']) ||
+            !isset($protocol['options']) ||
+            !is_array($protocol['options']) ||
+            !isset($protocol['options']['sharedSecret'])
+        ) {
+            return new JSONResponse(
+                ['message' => 'Missing arguments'],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
+
+        $supportedShareTypes = $this->config->getSupportedShareTypes($resourceType);
+        if (!in_array($shareType, $supportedShareTypes)) {
+            return new JSONResponse(
+                ['message' => 'Share type "' . $shareType . '" not implemented'],
+                Http::STATUS_NOT_IMPLEMENTED
+            );
+        }
+
+        $cloudId = $this->cloudIdManager->resolveCloudId($shareWith);
+        $shareWith = $cloudId->getUser();
+
+        if ($shareType === 'user') {
+            $shareWith = $this->mapUid($shareWith);
+
+            if (!$this->userManager->userExists($shareWith)) {
+                return new JSONResponse(
+                    ['message' => 'User "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
+                    Http::STATUS_BAD_REQUEST
+                );
+            }
+        }
+
+        if ($shareType === 'group') {
+            if(!$this->groupManager->groupExists($shareWith)) {
+                return new JSONResponse(
+                    ['message' => 'Group "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
+                    Http::STATUS_BAD_REQUEST
+                );
+            }
+        }
+
+        // if no explicit display name is given, we use the uid as display name
+        $ownerDisplayName = $ownerDisplayName === null ? $owner : $ownerDisplayName;
+        $sharedByDisplayName = $sharedByDisplayName === null ? $sharedBy : $sharedByDisplayName;
+
+        // sharedBy* parameter is optional, if nothing is set we assume that it is the same user as the owner
+        if ($sharedBy === null) {
+            $sharedBy = $owner;
+            $sharedByDisplayName = $ownerDisplayName;
+        }
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
+            $share = $this->factory->getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, '', $shareType, $resourceType);
+            $share->setProtocol($protocol);
+            $provider->shareReceived($share);
+        } catch (ProviderDoesNotExistsException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_NOT_IMPLEMENTED
+            );
+        } catch (ProviderCouldNotAddShareException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                $e->getCode()
+            );
+        } catch (\Exception $e) {
+            return new JSONResponse(
+                ['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
+
+        $user = $this->userManager->get($shareWith);
+        $recipientDisplayName = '';
+        if($user) {
+            $recipientDisplayName = $user->getDisplayName();
+        }
+
+        return new JSONResponse(
+            ['recipientDisplayName' => $recipientDisplayName],
+            Http::STATUS_CREATED);
+
+    }
+
+    /**
+     * receive notification about existing share
+     *
+     * @NoCSRFRequired
+     * @PublicPage
+     * @BruteForceProtection(action=receiveFederatedShareNotification)
+     *
+     * @param string $notificationType (notification type, e.g. SHARE_ACCEPTED)
+     * @param string $resourceType (calendar, file, contact,...)
+     * @param string $providerId id of the share
+     * @param array $notification the actual payload of the notification
+     * @return JSONResponse
+     */
+    public function receiveNotification($notificationType, $resourceType, $providerId, array $notification) {
+
+        // check if all required parameters are set
+        if ($notificationType === null ||
+            $resourceType === null ||
+            $providerId === null ||
+            !is_array($notification)
+        ) {
+            return new JSONResponse(
+                ['message' => 'Missing arguments'],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
+            $result = $provider->notificationReceived($notificationType, $providerId, $notification);
+        } catch (ProviderDoesNotExistsException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_BAD_REQUEST
+            );
+        } catch (ShareNotFound $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_BAD_REQUEST
+            );
+        } catch (ActionNotSupportedException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_NOT_IMPLEMENTED
+            );
+        } catch (BadRequestException $e) {
+            return new JSONResponse($e->getReturnMessage(), Http::STATUS_BAD_REQUEST);
+        } catch (AuthenticationFailedException $e) {
+            return new JSONResponse(["message" => "RESOURCE_NOT_FOUND"], Http::STATUS_FORBIDDEN);
+        }
+        catch (\Exception $e) {
+            return new JSONResponse(
+                ['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
+
+        return new JSONResponse($result,Http::STATUS_CREATED);
+
+    }
+
+    /**
+     * map login name to internal LDAP UID if a LDAP backend is in use
+     *
+     * @param string $uid
+     * @return string mixed
+     */
+    private function mapUid($uid) {
+        // FIXME this should be a method in the user management instead
+        $this->logger->debug('shareWith before, ' . $uid, ['app' => $this->appName]);
+        \OCP\Util::emitHook(
+            '\OCA\Files_Sharing\API\Server2Server',
+            'preLoginNameUsedAsUserName',
+            ['uid' => &$uid]
+        );
+        $this->logger->debug('shareWith after, ' . $uid, ['app' => $this->appName]);
+
+        return $uid;
+    }
 
 }

apps/files/templates/list.php

Spacing +3 added lines, -3 removed lines

@@ -12,10 +12,10 @@ 
 	*/ ?>
 	<input type="hidden" name="permissions" value="" id="permissions">
 	<input type="hidden" id="free_space" value="<?php isset($_['freeSpace']) ? p($_['freeSpace']) : '' ?>">
-	<?php if(isset($_['dirToken'])):?>
+	<?php if (isset($_['dirToken'])):?>
 	<input type="hidden" id="publicUploadRequestToken" name="requesttoken" value="<?php p($_['requesttoken']) ?>" />
 	<input type="hidden" id="dirToken" name="dirToken" value="<?php p($_['dirToken']) ?>" />
-	<?php endif;?>
+	<?php endif; ?>
 	<input type="hidden" class="max_human_file_size"
 		   value="(max <?php isset($_['uploadMaxHumanFilesize']) ? p($_['uploadMaxHumanFilesize']) : ''; ?>)">
 </div>
@@ -77,6 +77,6 @@ 
 <div id="editor"></div><!-- FIXME Do not use this div in your app! It is deprecated and will be removed in the future! -->
 <div id="uploadsize-message" title="<?php p($l->t('Upload too large'))?>">
 	<p>
-	<?php p($l->t('The files you are trying to upload exceed the maximum size for file uploads on this server.'));?>
+	<?php p($l->t('The files you are trying to upload exceed the maximum size for file uploads on this server.')); ?>
 	</p>
 </div>

apps/files/lib/Command/Scan.php

Indentation +270 added lines, -270 removed lines

@@ -51,275 +51,275 @@
 
 class Scan extends Base {
 
-	/** @var IUserManager $userManager */
-	private $userManager;
-	/** @var float */
-	protected $execTime = 0;
-	/** @var int */
-	protected $foldersCounter = 0;
-	/** @var int */
-	protected $filesCounter = 0;
-
-	public function __construct(IUserManager $userManager) {
-		$this->userManager = $userManager;
-		parent::__construct();
-	}
-
-	protected function configure() {
-		parent::configure();
-
-		$this
-			->setName('files:scan')
-			->setDescription('rescan filesystem')
-			->addArgument(
-				'user_id',
-				InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
-				'will rescan all files of the given user(s)'
-			)
-			->addOption(
-				'path',
-				'p',
-				InputArgument::OPTIONAL,
-				'limit rescan to this path, eg. --path="/alice/files/Music", the user_id is determined by the path and the user_id parameter and --all are ignored'
-			)
-			->addOption(
-				'all',
-				null,
-				InputOption::VALUE_NONE,
-				'will rescan all files of all known users'
-			)->addOption(
-				'unscanned',
-				null,
-				InputOption::VALUE_NONE,
-				'only scan files which are marked as not fully scanned'
-			)->addOption(
-				'shallow',
-				null,
-				InputOption::VALUE_NONE,
-				'do not scan folders recursively'
-			)->addOption(
-				'home-only',
-				null,
-				InputOption::VALUE_NONE,
-				'only scan the home storage, ignoring any mounted external storage or share'
-			);
-	}
-
-	public function checkScanWarning($fullPath, OutputInterface $output) {
-		$normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
-		$path = basename($fullPath);
-
-		if ($normalizedPath !== $path) {
-			$output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
-		}
-	}
-
-	protected function scanFiles($user, $path, OutputInterface $output, $backgroundScan = false, $recursive = true, $homeOnly = false) {
-		$connection = $this->reconnectToDatabase($output);
-		$scanner = new \OC\Files\Utils\Scanner($user, $connection, \OC::$server->query(IEventDispatcher::class), \OC::$server->getLogger());
-
-		# check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
-
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
-			$output->writeln("\tFile\t<info>$path</info>", OutputInterface::VERBOSITY_VERBOSE);
-			++$this->filesCounter;
-			$this->abortIfInterrupted();
-		});
-
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
-			$output->writeln("\tFolder\t<info>$path</info>", OutputInterface::VERBOSITY_VERBOSE);
-			++$this->foldersCounter;
-			$this->abortIfInterrupted();
-		});
-
-		$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
-			$output->writeln('Error while scanning, storage not available (' . $e->getMessage() . ')', OutputInterface::VERBOSITY_VERBOSE);
-		});
-
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
-			$this->checkScanWarning($path, $output);
-		});
-
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
-			$this->checkScanWarning($path, $output);
-		});
-
-		try {
-			if ($backgroundScan) {
-				$scanner->backgroundScan($path);
-			} else {
-				$scanner->scan($path, $recursive, $homeOnly ? [$this, 'filterHomeMount'] : null);
-			}
-		} catch (ForbiddenException $e) {
-			$output->writeln("<error>Home storage for user $user not writable</error>");
-			$output->writeln('Make sure you\'re running the scan command only as the user the web server runs as');
-		} catch (InterruptedException $e) {
-			# exit the function if ctrl-c has been pressed
-			$output->writeln('Interrupted by user');
-		} catch (NotFoundException $e) {
-			$output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
-		} catch (\Exception $e) {
-			$output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
-			$output->writeln('<error>' . $e->getTraceAsString() . '</error>');
-		}
-	}
-
-	public function filterHomeMount(IMountPoint $mountPoint) {
-		// any mountpoint inside '/$user/files/'
-		return substr_count($mountPoint->getMountPoint(), '/') <= 3;
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output) {
-		$inputPath = $input->getOption('path');
-		if ($inputPath) {
-			$inputPath = '/' . trim($inputPath, '/');
-			list(, $user,) = explode('/', $inputPath, 3);
-			$users = [$user];
-		} else if ($input->getOption('all')) {
-			$users = $this->userManager->search('');
-		} else {
-			$users = $input->getArgument('user_id');
-		}
-
-		# restrict the verbosity level to VERBOSITY_VERBOSE
-		if ($output->getVerbosity() > OutputInterface::VERBOSITY_VERBOSE) {
-			$output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
-		}
-
-		# check quantity of users to be process and show it on the command line
-		$users_total = count($users);
-		if ($users_total === 0) {
-			$output->writeln('<error>Please specify the user id to scan, --all to scan for all users or --path=...</error>');
-			return;
-		}
-
-		$this->initTools();
-
-		$user_count = 0;
-		foreach ($users as $user) {
-			if (is_object($user)) {
-				$user = $user->getUID();
-			}
-			$path = $inputPath ? $inputPath : '/' . $user;
-			++$user_count;
-			if ($this->userManager->userExists($user)) {
-				$output->writeln("Starting scan for user $user_count out of $users_total ($user)");
-				$this->scanFiles($user, $path, $output, $input->getOption('unscanned'), !$input->getOption('shallow'), $input->getOption('home-only'));
-				$output->writeln('', OutputInterface::VERBOSITY_VERBOSE);
-			} else {
-				$output->writeln("<error>Unknown user $user_count $user</error>");
-				$output->writeln('', OutputInterface::VERBOSITY_VERBOSE);
-			}
-
-			try {
-				$this->abortIfInterrupted();
-			} catch (InterruptedException $e) {
-				break;
-			}
-		}
-
-		$this->presentStats($output);
-	}
-
-	/**
-	 * Initialises some useful tools for the Command
-	 */
-	protected function initTools() {
-		// Start the timer
-		$this->execTime = -microtime(true);
-		// Convert PHP errors to exceptions
-		set_error_handler([$this, 'exceptionErrorHandler'], E_ALL);
-	}
-
-	/**
-	 * Processes PHP errors as exceptions in order to be able to keep track of problems
-	 *
-	 * @see https://secure.php.net/manual/en/function.set-error-handler.php
-	 *
-	 * @param int $severity the level of the error raised
-	 * @param string $message
-	 * @param string $file the filename that the error was raised in
-	 * @param int $line the line number the error was raised
-	 *
-	 * @throws \ErrorException
-	 */
-	public function exceptionErrorHandler($severity, $message, $file, $line) {
-		if (!(error_reporting() & $severity)) {
-			// This error code is not included in error_reporting
-			return;
-		}
-		throw new \ErrorException($message, 0, $severity, $file, $line);
-	}
-
-	/**
-	 * @param OutputInterface $output
-	 */
-	protected function presentStats(OutputInterface $output) {
-		// Stop the timer
-		$this->execTime += microtime(true);
-
-		$headers = [
-			'Folders', 'Files', 'Elapsed time'
-		];
-
-		$this->showSummary($headers, null, $output);
-	}
-
-	/**
-	 * Shows a summary of operations
-	 *
-	 * @param string[] $headers
-	 * @param string[] $rows
-	 * @param OutputInterface $output
-	 */
-	protected function showSummary($headers, $rows, OutputInterface $output) {
-		$niceDate = $this->formatExecTime();
-		if (!$rows) {
-			$rows = [
-				$this->foldersCounter,
-				$this->filesCounter,
-				$niceDate,
-			];
-		}
-		$table = new Table($output);
-		$table
-			->setHeaders($headers)
-			->setRows([$rows]);
-		$table->render();
-	}
-
-
-	/**
-	 * Formats microtime into a human readable format
-	 *
-	 * @return string
-	 */
-	protected function formatExecTime() {
-		$secs = round($this->execTime);
-		# convert seconds into HH:MM:SS form
-		return sprintf('%02d:%02d:%02d', ($secs/3600), ($secs/60%60), $secs%60);
-	}
-
-	/**
-	 * @return \OCP\IDBConnection
-	 */
-	protected function reconnectToDatabase(OutputInterface $output) {
-		/** @var Connection | IDBConnection $connection */
-		$connection = \OC::$server->getDatabaseConnection();
-		try {
-			$connection->close();
-		} catch (\Exception $ex) {
-			$output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
-		}
-		while (!$connection->isConnected()) {
-			try {
-				$connection->connect();
-			} catch (\Exception $ex) {
-				$output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
-				sleep(60);
-			}
-		}
-		return $connection;
-	}
+    /** @var IUserManager $userManager */
+    private $userManager;
+    /** @var float */
+    protected $execTime = 0;
+    /** @var int */
+    protected $foldersCounter = 0;
+    /** @var int */
+    protected $filesCounter = 0;
+
+    public function __construct(IUserManager $userManager) {
+        $this->userManager = $userManager;
+        parent::__construct();
+    }
+
+    protected function configure() {
+        parent::configure();
+
+        $this
+            ->setName('files:scan')
+            ->setDescription('rescan filesystem')
+            ->addArgument(
+                'user_id',
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                'will rescan all files of the given user(s)'
+            )
+            ->addOption(
+                'path',
+                'p',
+                InputArgument::OPTIONAL,
+                'limit rescan to this path, eg. --path="/alice/files/Music", the user_id is determined by the path and the user_id parameter and --all are ignored'
+            )
+            ->addOption(
+                'all',
+                null,
+                InputOption::VALUE_NONE,
+                'will rescan all files of all known users'
+            )->addOption(
+                'unscanned',
+                null,
+                InputOption::VALUE_NONE,
+                'only scan files which are marked as not fully scanned'
+            )->addOption(
+                'shallow',
+                null,
+                InputOption::VALUE_NONE,
+                'do not scan folders recursively'
+            )->addOption(
+                'home-only',
+                null,
+                InputOption::VALUE_NONE,
+                'only scan the home storage, ignoring any mounted external storage or share'
+            );
+    }
+
+    public function checkScanWarning($fullPath, OutputInterface $output) {
+        $normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
+        $path = basename($fullPath);
+
+        if ($normalizedPath !== $path) {
+            $output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
+        }
+    }
+
+    protected function scanFiles($user, $path, OutputInterface $output, $backgroundScan = false, $recursive = true, $homeOnly = false) {
+        $connection = $this->reconnectToDatabase($output);
+        $scanner = new \OC\Files\Utils\Scanner($user, $connection, \OC::$server->query(IEventDispatcher::class), \OC::$server->getLogger());
+
+        # check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
+
+        $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+            $output->writeln("\tFile\t<info>$path</info>", OutputInterface::VERBOSITY_VERBOSE);
+            ++$this->filesCounter;
+            $this->abortIfInterrupted();
+        });
+
+        $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+            $output->writeln("\tFolder\t<info>$path</info>", OutputInterface::VERBOSITY_VERBOSE);
+            ++$this->foldersCounter;
+            $this->abortIfInterrupted();
+        });
+
+        $scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
+            $output->writeln('Error while scanning, storage not available (' . $e->getMessage() . ')', OutputInterface::VERBOSITY_VERBOSE);
+        });
+
+        $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+            $this->checkScanWarning($path, $output);
+        });
+
+        $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+            $this->checkScanWarning($path, $output);
+        });
+
+        try {
+            if ($backgroundScan) {
+                $scanner->backgroundScan($path);
+            } else {
+                $scanner->scan($path, $recursive, $homeOnly ? [$this, 'filterHomeMount'] : null);
+            }
+        } catch (ForbiddenException $e) {
+            $output->writeln("<error>Home storage for user $user not writable</error>");
+            $output->writeln('Make sure you\'re running the scan command only as the user the web server runs as');
+        } catch (InterruptedException $e) {
+            # exit the function if ctrl-c has been pressed
+            $output->writeln('Interrupted by user');
+        } catch (NotFoundException $e) {
+            $output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
+        } catch (\Exception $e) {
+            $output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
+            $output->writeln('<error>' . $e->getTraceAsString() . '</error>');
+        }
+    }
+
+    public function filterHomeMount(IMountPoint $mountPoint) {
+        // any mountpoint inside '/$user/files/'
+        return substr_count($mountPoint->getMountPoint(), '/') <= 3;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        $inputPath = $input->getOption('path');
+        if ($inputPath) {
+            $inputPath = '/' . trim($inputPath, '/');
+            list(, $user,) = explode('/', $inputPath, 3);
+            $users = [$user];
+        } else if ($input->getOption('all')) {
+            $users = $this->userManager->search('');
+        } else {
+            $users = $input->getArgument('user_id');
+        }
+
+        # restrict the verbosity level to VERBOSITY_VERBOSE
+        if ($output->getVerbosity() > OutputInterface::VERBOSITY_VERBOSE) {
+            $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
+        }
+
+        # check quantity of users to be process and show it on the command line
+        $users_total = count($users);
+        if ($users_total === 0) {
+            $output->writeln('<error>Please specify the user id to scan, --all to scan for all users or --path=...</error>');
+            return;
+        }
+
+        $this->initTools();
+
+        $user_count = 0;
+        foreach ($users as $user) {
+            if (is_object($user)) {
+                $user = $user->getUID();
+            }
+            $path = $inputPath ? $inputPath : '/' . $user;
+            ++$user_count;
+            if ($this->userManager->userExists($user)) {
+                $output->writeln("Starting scan for user $user_count out of $users_total ($user)");
+                $this->scanFiles($user, $path, $output, $input->getOption('unscanned'), !$input->getOption('shallow'), $input->getOption('home-only'));
+                $output->writeln('', OutputInterface::VERBOSITY_VERBOSE);
+            } else {
+                $output->writeln("<error>Unknown user $user_count $user</error>");
+                $output->writeln('', OutputInterface::VERBOSITY_VERBOSE);
+            }
+
+            try {
+                $this->abortIfInterrupted();
+            } catch (InterruptedException $e) {
+                break;
+            }
+        }
+
+        $this->presentStats($output);
+    }
+
+    /**
+     * Initialises some useful tools for the Command
+     */
+    protected function initTools() {
+        // Start the timer
+        $this->execTime = -microtime(true);
+        // Convert PHP errors to exceptions
+        set_error_handler([$this, 'exceptionErrorHandler'], E_ALL);
+    }
+
+    /**
+     * Processes PHP errors as exceptions in order to be able to keep track of problems
+     *
+     * @see https://secure.php.net/manual/en/function.set-error-handler.php
+     *
+     * @param int $severity the level of the error raised
+     * @param string $message
+     * @param string $file the filename that the error was raised in
+     * @param int $line the line number the error was raised
+     *
+     * @throws \ErrorException
+     */
+    public function exceptionErrorHandler($severity, $message, $file, $line) {
+        if (!(error_reporting() & $severity)) {
+            // This error code is not included in error_reporting
+            return;
+        }
+        throw new \ErrorException($message, 0, $severity, $file, $line);
+    }
+
+    /**
+     * @param OutputInterface $output
+     */
+    protected function presentStats(OutputInterface $output) {
+        // Stop the timer
+        $this->execTime += microtime(true);
+
+        $headers = [
+            'Folders', 'Files', 'Elapsed time'
+        ];
+
+        $this->showSummary($headers, null, $output);
+    }
+
+    /**
+     * Shows a summary of operations
+     *
+     * @param string[] $headers
+     * @param string[] $rows
+     * @param OutputInterface $output
+     */
+    protected function showSummary($headers, $rows, OutputInterface $output) {
+        $niceDate = $this->formatExecTime();
+        if (!$rows) {
+            $rows = [
+                $this->foldersCounter,
+                $this->filesCounter,
+                $niceDate,
+            ];
+        }
+        $table = new Table($output);
+        $table
+            ->setHeaders($headers)
+            ->setRows([$rows]);
+        $table->render();
+    }
+
+
+    /**
+     * Formats microtime into a human readable format
+     *
+     * @return string
+     */
+    protected function formatExecTime() {
+        $secs = round($this->execTime);
+        # convert seconds into HH:MM:SS form
+        return sprintf('%02d:%02d:%02d', ($secs/3600), ($secs/60%60), $secs%60);
+    }
+
+    /**
+     * @return \OCP\IDBConnection
+     */
+    protected function reconnectToDatabase(OutputInterface $output) {
+        /** @var Connection | IDBConnection $connection */
+        $connection = \OC::$server->getDatabaseConnection();
+        try {
+            $connection->close();
+        } catch (\Exception $ex) {
+            $output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
+        }
+        while (!$connection->isConnected()) {
+            try {
+                $connection->connect();
+            } catch (\Exception $ex) {
+                $output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
+                sleep(60);
+            }
+        }
+        return $connection;
+    }
 
 }

Spacing +13 added lines, -13 removed lines

@@ -110,7 +110,7 @@ 
 		$path = basename($fullPath);
 
 		if ($normalizedPath !== $path) {
-			$output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
+			$output->writeln("\t<error>Entry \"".$fullPath.'" will not be accessible due to incompatible encoding</error>');
 		}
 	}
 
@@ -120,27 +120,27 @@ 
 
 		# check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
 
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
 			$output->writeln("\tFile\t<info>$path</info>", OutputInterface::VERBOSITY_VERBOSE);
 			++$this->filesCounter;
 			$this->abortIfInterrupted();
 		});
 
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
 			$output->writeln("\tFolder\t<info>$path</info>", OutputInterface::VERBOSITY_VERBOSE);
 			++$this->foldersCounter;
 			$this->abortIfInterrupted();
 		});
 
-		$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
-			$output->writeln('Error while scanning, storage not available (' . $e->getMessage() . ')', OutputInterface::VERBOSITY_VERBOSE);
+		$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function(StorageNotAvailableException $e) use ($output) {
+			$output->writeln('Error while scanning, storage not available ('.$e->getMessage().')', OutputInterface::VERBOSITY_VERBOSE);
 		});
 
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
 			$this->checkScanWarning($path, $output);
 		});
 
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
 			$this->checkScanWarning($path, $output);
 		});
 
@@ -157,10 +157,10 @@ 
 			# exit the function if ctrl-c has been pressed
 			$output->writeln('Interrupted by user');
 		} catch (NotFoundException $e) {
-			$output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
+			$output->writeln('<error>Path not found: '.$e->getMessage().'</error>');
 		} catch (\Exception $e) {
-			$output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
-			$output->writeln('<error>' . $e->getTraceAsString() . '</error>');
+			$output->writeln('<error>Exception during scan: '.$e->getMessage().'</error>');
+			$output->writeln('<error>'.$e->getTraceAsString().'</error>');
 		}
 	}
 
@@ -172,7 +172,7 @@ 
 	protected function execute(InputInterface $input, OutputInterface $output) {
 		$inputPath = $input->getOption('path');
 		if ($inputPath) {
-			$inputPath = '/' . trim($inputPath, '/');
+			$inputPath = '/'.trim($inputPath, '/');
 			list(, $user,) = explode('/', $inputPath, 3);
 			$users = [$user];
 		} else if ($input->getOption('all')) {
@@ -200,7 +200,7 @@ 
 			if (is_object($user)) {
 				$user = $user->getUID();
 			}
-			$path = $inputPath ? $inputPath : '/' . $user;
+			$path = $inputPath ? $inputPath : '/'.$user;
 			++$user_count;
 			if ($this->userManager->userExists($user)) {
 				$output->writeln("Starting scan for user $user_count out of $users_total ($user)");
@@ -297,7 +297,7 @@ 
 	protected function formatExecTime() {
 		$secs = round($this->execTime);
 		# convert seconds into HH:MM:SS form
-		return sprintf('%02d:%02d:%02d', ($secs/3600), ($secs/60%60), $secs%60);
+		return sprintf('%02d:%02d:%02d', ($secs / 3600), ($secs / 60 % 60), $secs % 60);
 	}
 
 	/**

apps/oauth2/lib/Controller/OauthApiController.php

Indentation +133 added lines, -133 removed lines

@@ -44,137 +44,137 @@
 use OCP\Security\ISecureRandom;
 
 class OauthApiController extends Controller {
-	/** @var AccessTokenMapper */
-	private $accessTokenMapper;
-	/** @var ClientMapper */
-	private $clientMapper;
-	/** @var ICrypto */
-	private $crypto;
-	/** @var TokenProvider */
-	private $tokenProvider;
-	/** @var ISecureRandom */
-	private $secureRandom;
-	/** @var ITimeFactory */
-	private $time;
-	/** @var Throttler */
-	private $throttler;
-
-	public function __construct(string $appName,
-								IRequest $request,
-								ICrypto $crypto,
-								AccessTokenMapper $accessTokenMapper,
-								ClientMapper $clientMapper,
-								TokenProvider $tokenProvider,
-								ISecureRandom $secureRandom,
-								ITimeFactory $time,
-								Throttler $throttler) {
-		parent::__construct($appName, $request);
-		$this->crypto = $crypto;
-		$this->accessTokenMapper = $accessTokenMapper;
-		$this->clientMapper = $clientMapper;
-		$this->tokenProvider = $tokenProvider;
-		$this->secureRandom = $secureRandom;
-		$this->time = $time;
-		$this->throttler = $throttler;
-	}
-
-	/**
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * @param string $grant_type
-	 * @param string $code
-	 * @param string $refresh_token
-	 * @param string $client_id
-	 * @param string $client_secret
-	 * @return JSONResponse
-	 */
-	public function getToken($grant_type, $code, $refresh_token, $client_id, $client_secret): JSONResponse {
-
-		// We only handle two types
-		if ($grant_type !== 'authorization_code' && $grant_type !== 'refresh_token') {
-			return new JSONResponse([
-				'error' => 'invalid_grant',
-			], Http::STATUS_BAD_REQUEST);
-		}
-
-		// We handle the initial and refresh tokens the same way
-		if ($grant_type === 'refresh_token') {
-			$code = $refresh_token;
-		}
-
-		try {
-			$accessToken = $this->accessTokenMapper->getByCode($code);
-		} catch (AccessTokenNotFoundException $e) {
-			return new JSONResponse([
-				'error' => 'invalid_request',
-			], Http::STATUS_BAD_REQUEST);
-		}
-
-		try {
-			$client = $this->clientMapper->getByUid($accessToken->getClientId());
-		} catch (ClientNotFoundException $e) {
-			return new JSONResponse([
-				'error' => 'invalid_request',
-			], Http::STATUS_BAD_REQUEST);
-		}
-
-		if (isset($this->request->server['PHP_AUTH_USER'])) {
-			$client_id = $this->request->server['PHP_AUTH_USER'];
-			$client_secret = $this->request->server['PHP_AUTH_PW'];
-		}
-
-		// The client id and secret must match. Else we don't provide an access token!
-		if ($client->getClientIdentifier() !== $client_id || $client->getSecret() !== $client_secret) {
-			return new JSONResponse([
-				'error' => 'invalid_client',
-			], Http::STATUS_BAD_REQUEST);
-		}
-
-		$decryptedToken = $this->crypto->decrypt($accessToken->getEncryptedToken(), $code);
-
-		// Obtain the appToken assoicated
-		try {
-			$appToken = $this->tokenProvider->getTokenById($accessToken->getTokenId());
-		} catch (ExpiredTokenException $e) {
-			$appToken = $e->getToken();
-		} catch (InvalidTokenException $e) {
-			//We can't do anything...
-			$this->accessTokenMapper->delete($accessToken);
-			return new JSONResponse([
-				'error' => 'invalid_request',
-			], Http::STATUS_BAD_REQUEST);
-		}
-
-		// Rotate the apptoken (so the old one becomes invalid basically)
-		$newToken = $this->secureRandom->generate(72, ISecureRandom::CHAR_UPPER.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_DIGITS);
-
-		$appToken = $this->tokenProvider->rotate(
-			$appToken,
-			$decryptedToken,
-			$newToken
-		);
-
-		// Expiration is in 1 hour again
-		$appToken->setExpires($this->time->getTime() + 3600);
-		$this->tokenProvider->updateToken($appToken);
-
-		// Generate a new refresh token and encrypt the new apptoken in the DB
-		$newCode = $this->secureRandom->generate(128, ISecureRandom::CHAR_UPPER.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_DIGITS);
-		$accessToken->setHashedCode(hash('sha512', $newCode));
-		$accessToken->setEncryptedToken($this->crypto->encrypt($newToken, $newCode));
-		$this->accessTokenMapper->update($accessToken);
-
-		$this->throttler->resetDelay($this->request->getRemoteAddress(), 'login', ['user' => $appToken->getUID()]);
-
-		return new JSONResponse(
-			[
-				'access_token' => $newToken,
-				'token_type' => 'Bearer',
-				'expires_in' => 3600,
-				'refresh_token' => $newCode,
-				'user_id' => $appToken->getUID(),
-			]
-		);
-	}
+    /** @var AccessTokenMapper */
+    private $accessTokenMapper;
+    /** @var ClientMapper */
+    private $clientMapper;
+    /** @var ICrypto */
+    private $crypto;
+    /** @var TokenProvider */
+    private $tokenProvider;
+    /** @var ISecureRandom */
+    private $secureRandom;
+    /** @var ITimeFactory */
+    private $time;
+    /** @var Throttler */
+    private $throttler;
+
+    public function __construct(string $appName,
+                                IRequest $request,
+                                ICrypto $crypto,
+                                AccessTokenMapper $accessTokenMapper,
+                                ClientMapper $clientMapper,
+                                TokenProvider $tokenProvider,
+                                ISecureRandom $secureRandom,
+                                ITimeFactory $time,
+                                Throttler $throttler) {
+        parent::__construct($appName, $request);
+        $this->crypto = $crypto;
+        $this->accessTokenMapper = $accessTokenMapper;
+        $this->clientMapper = $clientMapper;
+        $this->tokenProvider = $tokenProvider;
+        $this->secureRandom = $secureRandom;
+        $this->time = $time;
+        $this->throttler = $throttler;
+    }
+
+    /**
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * @param string $grant_type
+     * @param string $code
+     * @param string $refresh_token
+     * @param string $client_id
+     * @param string $client_secret
+     * @return JSONResponse
+     */
+    public function getToken($grant_type, $code, $refresh_token, $client_id, $client_secret): JSONResponse {
+
+        // We only handle two types
+        if ($grant_type !== 'authorization_code' && $grant_type !== 'refresh_token') {
+            return new JSONResponse([
+                'error' => 'invalid_grant',
+            ], Http::STATUS_BAD_REQUEST);
+        }
+
+        // We handle the initial and refresh tokens the same way
+        if ($grant_type === 'refresh_token') {
+            $code = $refresh_token;
+        }
+
+        try {
+            $accessToken = $this->accessTokenMapper->getByCode($code);
+        } catch (AccessTokenNotFoundException $e) {
+            return new JSONResponse([
+                'error' => 'invalid_request',
+            ], Http::STATUS_BAD_REQUEST);
+        }
+
+        try {
+            $client = $this->clientMapper->getByUid($accessToken->getClientId());
+        } catch (ClientNotFoundException $e) {
+            return new JSONResponse([
+                'error' => 'invalid_request',
+            ], Http::STATUS_BAD_REQUEST);
+        }
+
+        if (isset($this->request->server['PHP_AUTH_USER'])) {
+            $client_id = $this->request->server['PHP_AUTH_USER'];
+            $client_secret = $this->request->server['PHP_AUTH_PW'];
+        }
+
+        // The client id and secret must match. Else we don't provide an access token!
+        if ($client->getClientIdentifier() !== $client_id || $client->getSecret() !== $client_secret) {
+            return new JSONResponse([
+                'error' => 'invalid_client',
+            ], Http::STATUS_BAD_REQUEST);
+        }
+
+        $decryptedToken = $this->crypto->decrypt($accessToken->getEncryptedToken(), $code);
+
+        // Obtain the appToken assoicated
+        try {
+            $appToken = $this->tokenProvider->getTokenById($accessToken->getTokenId());
+        } catch (ExpiredTokenException $e) {
+            $appToken = $e->getToken();
+        } catch (InvalidTokenException $e) {
+            //We can't do anything...
+            $this->accessTokenMapper->delete($accessToken);
+            return new JSONResponse([
+                'error' => 'invalid_request',
+            ], Http::STATUS_BAD_REQUEST);
+        }
+
+        // Rotate the apptoken (so the old one becomes invalid basically)
+        $newToken = $this->secureRandom->generate(72, ISecureRandom::CHAR_UPPER.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_DIGITS);
+
+        $appToken = $this->tokenProvider->rotate(
+            $appToken,
+            $decryptedToken,
+            $newToken
+        );
+
+        // Expiration is in 1 hour again
+        $appToken->setExpires($this->time->getTime() + 3600);
+        $this->tokenProvider->updateToken($appToken);
+
+        // Generate a new refresh token and encrypt the new apptoken in the DB
+        $newCode = $this->secureRandom->generate(128, ISecureRandom::CHAR_UPPER.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_DIGITS);
+        $accessToken->setHashedCode(hash('sha512', $newCode));
+        $accessToken->setEncryptedToken($this->crypto->encrypt($newToken, $newCode));
+        $this->accessTokenMapper->update($accessToken);
+
+        $this->throttler->resetDelay($this->request->getRemoteAddress(), 'login', ['user' => $appToken->getUID()]);
+
+        return new JSONResponse(
+            [
+                'access_token' => $newToken,
+                'token_type' => 'Bearer',
+                'expires_in' => 3600,
+                'refresh_token' => $newCode,
+                'user_id' => $appToken->getUID(),
+            ]
+        );
+    }
 }

apps/settings/templates/settings/admin/sharing.php

Spacing +30 added lines, -30 removed lines

@@ -27,82 +27,82 @@ 
 ?>
 
 <div class="section" id="shareAPI">
-	<h2><?php p($l->t('Sharing'));?></h2>
+	<h2><?php p($l->t('Sharing')); ?></h2>
 	<a target="_blank" rel="noreferrer noopener" class="icon-info"
-	   title="<?php p($l->t('Open documentation'));?>"
+	   title="<?php p($l->t('Open documentation')); ?>"
 	   href="<?php p(link_to_docs('admin-sharing')); ?>"></a>
-        <p class="settings-hint"><?php p($l->t('As admin you can fine-tune the sharing behavior. Please see the documentation for more information.'));?></p>
+        <p class="settings-hint"><?php p($l->t('As admin you can fine-tune the sharing behavior. Please see the documentation for more information.')); ?></p>
 	<p id="enable">
 		<input type="checkbox" name="shareapi_enabled" id="shareAPIEnabled" class="checkbox"
 			   value="1" <?php if ($_['shareAPIEnabled'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="shareAPIEnabled"><?php p($l->t('Allow apps to use the Share API'));?></label><br/>
+		<label for="shareAPIEnabled"><?php p($l->t('Allow apps to use the Share API')); ?></label><br/>
 	</p>
 
 	<p id="internalShareSettings" class="indent <?php if ($_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<input type="checkbox" name="shareapi_default_internal_expire_date" id="shareapiDefaultInternalExpireDate" class="checkbox"
 			   value="1" <?php if ($_['shareDefaultInternalExpireDateSet'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="shareapiDefaultInternalExpireDate"><?php p($l->t('Set default expiration date for shares'));?></label><br/>
+		<label for="shareapiDefaultInternalExpireDate"><?php p($l->t('Set default expiration date for shares')); ?></label><br/>
 	</p>
-	<p id="setDefaultInternalExpireDate" class="double-indent <?php if ($_['shareDefaultInternalExpireDateSet'] === 'no' || $_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p id="setDefaultInternalExpireDate" class="double-indent <?php if ($_['shareDefaultInternalExpireDateSet'] === 'no' || $_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<?php p($l->t('Expire after ')); ?>
 		<input type="text" name='shareapi_internal_expire_after_n_days' id="shareapiInternalExpireAfterNDays" placeholder="<?php p('7')?>"
 			   value='<?php p($_['shareInternalExpireAfterNDays']) ?>' />
 		<?php p($l->t('days')); ?>
 		<input type="checkbox" name="shareapi_internal_enforce_expire_date" id="shareapiInternalEnforceExpireDate" class="checkbox"
 			   value="1" <?php if ($_['shareInternalEnforceExpireDate'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="shareapiInternalEnforceExpireDate"><?php p($l->t('Enforce expiration date'));?></label><br/>
+		<label for="shareapiInternalEnforceExpireDate"><?php p($l->t('Enforce expiration date')); ?></label><br/>
 	</p>
 
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<input type="checkbox" name="shareapi_allow_links" id="allowLinks" class="checkbox"
 			   value="1" <?php if ($_['allowLinks'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="allowLinks"><?php p($l->t('Allow users to share via link'));?></label><br/>
+		<label for="allowLinks"><?php p($l->t('Allow users to share via link')); ?></label><br/>
 	</p>
 
 	<p id="publicLinkSettings" class="indent <?php if ($_['allowLinks'] !== 'yes' || $_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<input type="checkbox" name="shareapi_allow_public_upload" id="allowPublicUpload" class="checkbox"
 			   value="1" <?php if ($_['allowPublicUpload'] == 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="allowPublicUpload"><?php p($l->t('Allow public uploads'));?></label><br/>
+		<label for="allowPublicUpload"><?php p($l->t('Allow public uploads')); ?></label><br/>
 		<input type="checkbox" name="shareapi_enable_link_password_by_default" id="enableLinkPasswordByDefault" class="checkbox"
 			   value="1" <?php if ($_['enableLinkPasswordByDefault'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="enableLinkPasswordByDefault"><?php p($l->t('Always ask for a password'));?></label><br/>
+		<label for="enableLinkPasswordByDefault"><?php p($l->t('Always ask for a password')); ?></label><br/>
 		<input type="checkbox" name="shareapi_enforce_links_password" id="enforceLinkPassword" class="checkbox"
 			   value="1" <?php if ($_['enforceLinkPassword']) print_unescaped('checked="checked"'); ?> />
-		<label for="enforceLinkPassword"><?php p($l->t('Enforce password protection'));?></label><br/>
+		<label for="enforceLinkPassword"><?php p($l->t('Enforce password protection')); ?></label><br/>
 
 		<input type="checkbox" name="shareapi_default_expire_date" id="shareapiDefaultExpireDate" class="checkbox"
 			   value="1" <?php if ($_['shareDefaultExpireDateSet'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="shareapiDefaultExpireDate"><?php p($l->t('Set default expiration date for link shares'));?></label><br/>
+		<label for="shareapiDefaultExpireDate"><?php p($l->t('Set default expiration date for link shares')); ?></label><br/>
 
 	</p>
-	<p id="setDefaultExpireDate" class="double-indent <?php if ($_['allowLinks'] !== 'yes' || $_['shareDefaultExpireDateSet'] === 'no' || $_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p id="setDefaultExpireDate" class="double-indent <?php if ($_['allowLinks'] !== 'yes' || $_['shareDefaultExpireDateSet'] === 'no' || $_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<?php p($l->t('Expire after ')); ?>
 		<input type="text" name='shareapi_expire_after_n_days' id="shareapiExpireAfterNDays" placeholder="<?php p('7')?>"
 			   value='<?php p($_['shareExpireAfterNDays']) ?>' />
 		<?php p($l->t('days')); ?>
 		<input type="checkbox" name="shareapi_enforce_expire_date" id="shareapiEnforceExpireDate" class="checkbox"
 			   value="1" <?php if ($_['shareEnforceExpireDate'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="shareapiEnforceExpireDate"><?php p($l->t('Enforce expiration date'));?></label><br/>
+		<label for="shareapiEnforceExpireDate"><?php p($l->t('Enforce expiration date')); ?></label><br/>
 	</p>
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<input type="checkbox" name="shareapi_allow_resharing" id="allowResharing" class="checkbox"
 			   value="1" <?php if ($_['allowResharing'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="allowResharing"><?php p($l->t('Allow resharing'));?></label><br/>
+		<label for="allowResharing"><?php p($l->t('Allow resharing')); ?></label><br/>
 	</p>
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<input type="checkbox" name="shareapi_allow_group_sharing" id="allowGroupSharing" class="checkbox"
 			   value="1" <?php if ($_['allowGroupSharing'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="allowGroupSharing"><?php p($l->t('Allow sharing with groups'));?></label><br />
+		<label for="allowGroupSharing"><?php p($l->t('Allow sharing with groups')); ?></label><br />
 	</p>
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<input type="checkbox" name="shareapi_only_share_with_group_members" id="onlyShareWithGroupMembers" class="checkbox"
 			   value="1" <?php if ($_['onlyShareWithGroupMembers']) print_unescaped('checked="checked"'); ?> />
-		<label for="onlyShareWithGroupMembers"><?php p($l->t('Restrict users to only share with users in their groups'));?></label><br/>
+		<label for="onlyShareWithGroupMembers"><?php p($l->t('Restrict users to only share with users in their groups')); ?></label><br/>
 	</p>
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<input type="checkbox" name="shareapi_exclude_groups" id="shareapiExcludeGroups" class="checkbox"
 			   value="1" <?php if ($_['shareExcludeGroups']) print_unescaped('checked="checked"'); ?> />
-		<label for="shareapiExcludeGroups"><?php p($l->t('Exclude groups from sharing'));?></label><br/>
+		<label for="shareapiExcludeGroups"><?php p($l->t('Exclude groups from sharing')); ?></label><br/>
 	</p>
 	<p id="selectExcludedGroups" class="indent <?php if (!$_['shareExcludeGroups'] || $_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<input name="shareapi_exclude_groups_list" type="hidden" id="excludedGroups" value="<?php p($_['shareExcludedGroupsList']) ?>" style="width: 400px" class="noJSAutoUpdate"/>
@@ -110,35 +110,35 @@ 
 		<em><?php p($l->t('These groups will still be able to receive shares, but not to initiate them.')); ?></em>
 	</p>
 
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<input type="checkbox" name="shareapi_allow_share_dialog_user_enumeration" value="1" id="shareapi_allow_share_dialog_user_enumeration" class="checkbox"
 			<?php if ($_['allowShareDialogUserEnumeration'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="shareapi_allow_share_dialog_user_enumeration"><?php p($l->t('Allow username autocompletion in share dialog. If this is disabled the full username or email address needs to be entered.'));?></label><br />
+		<label for="shareapi_allow_share_dialog_user_enumeration"><?php p($l->t('Allow username autocompletion in share dialog. If this is disabled the full username or email address needs to be entered.')); ?></label><br />
 	</p>
 
-	<p id="shareapi_restrict_user_enumeration_to_group_setting" class="indent <?php if ($_['shareAPIEnabled'] === 'no' || $_['allowShareDialogUserEnumeration'] === 'no') p('hidden');?>">
+	<p id="shareapi_restrict_user_enumeration_to_group_setting" class="indent <?php if ($_['shareAPIEnabled'] === 'no' || $_['allowShareDialogUserEnumeration'] === 'no') p('hidden'); ?>">
 		<input type="checkbox" name="shareapi_restrict_user_enumeration_to_group" value="1" id="shareapi_restrict_user_enumeration_to_group" class="checkbox"
 			<?php if ($_['restrictUserEnumerationToGroup'] === 'yes') print_unescaped('checked="checked"'); ?> />
-		<label for="shareapi_restrict_user_enumeration_to_group"><?php p($l->t('Restrict username autocompletion to users within the same groups'));?></label><br />
+		<label for="shareapi_restrict_user_enumeration_to_group"><?php p($l->t('Restrict username autocompletion to users within the same groups')); ?></label><br />
 	</p>
 
 	<p>
 		<input type="checkbox" id="publicShareDisclaimer" class="checkbox noJSAutoUpdate"
 			<?php if ($_['publicShareDisclaimerText'] !== null) print_unescaped('checked="checked"'); ?> />
-		<label for="publicShareDisclaimer"><?php p($l->t('Show disclaimer text on the public link upload page. (Only shown when the file list is hidden.)'));?></label>
+		<label for="publicShareDisclaimer"><?php p($l->t('Show disclaimer text on the public link upload page. (Only shown when the file list is hidden.)')); ?></label>
 		<span id="publicShareDisclaimerStatus" class="msg" style="display:none"></span>
 		<br/>
 		<textarea placeholder="<?php p($l->t('This text will be shown on the public link upload page when the file list is hidden.')) ?>" id="publicShareDisclaimerText" <?php if ($_['publicShareDisclaimerText'] === null) { print_unescaped('class="hidden"'); } ?>><?php p($_['publicShareDisclaimerText']) ?></textarea>
 	</p>
 
-	<h3><?php p($l->t('Default share permissions'));?></h3>
+	<h3><?php p($l->t('Default share permissions')); ?></h3>
 	<input type="hidden" name="shareapi_default_permissions" id="shareApiDefaultPermissions" class="checkbox"
 		   value="<?php p($_['shareApiDefaultPermissions']) ?>" />
 	<p id="shareApiDefaultPermissionsSection" class="indent <?php if ($_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
 		<?php foreach ($_['shareApiDefaultPermissionsCheckboxes'] as $perm): ?>
 			<input type="checkbox" name="shareapi_default_permission_<?php p($perm['id']) ?>" id="shareapi_default_permission_<?php p($perm['id']) ?>"
 				   class="noautosave checkbox" value="<?php p($perm['value']) ?>" <?php if (($_['shareApiDefaultPermissions'] & $perm['value']) !== 0) print_unescaped('checked="checked"'); ?> />
-			<label for="shareapi_default_permission_<?php p($perm['id']) ?>"><?php p($perm['label']);?></label>
+			<label for="shareapi_default_permission_<?php p($perm['id']) ?>"><?php p($perm['label']); ?></label>
 		<?php endforeach ?>
 	</p>
 </div>

Braces +120 added lines, -30 removed lines

@@ -34,97 +34,181 @@ 
         <p class="settings-hint"><?php p($l->t('As admin you can fine-tune the sharing behavior. Please see the documentation for more information.'));?></p>
 	<p id="enable">
 		<input type="checkbox" name="shareapi_enabled" id="shareAPIEnabled" class="checkbox"
-			   value="1" <?php if ($_['shareAPIEnabled'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['shareAPIEnabled'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="shareAPIEnabled"><?php p($l->t('Allow apps to use the Share API'));?></label><br/>
 	</p>
 
-	<p id="internalShareSettings" class="indent <?php if ($_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
+	<p id="internalShareSettings" class="indent <?php if ($_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<input type="checkbox" name="shareapi_default_internal_expire_date" id="shareapiDefaultInternalExpireDate" class="checkbox"
-			   value="1" <?php if ($_['shareDefaultInternalExpireDateSet'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['shareDefaultInternalExpireDateSet'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="shareapiDefaultInternalExpireDate"><?php p($l->t('Set default expiration date for shares'));?></label><br/>
 	</p>
-	<p id="setDefaultInternalExpireDate" class="double-indent <?php if ($_['shareDefaultInternalExpireDateSet'] === 'no' || $_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p id="setDefaultInternalExpireDate" class="double-indent <?php if ($_['shareDefaultInternalExpireDateSet'] === 'no' || $_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<?php p($l->t('Expire after ')); ?>
 		<input type="text" name='shareapi_internal_expire_after_n_days' id="shareapiInternalExpireAfterNDays" placeholder="<?php p('7')?>"
 			   value='<?php p($_['shareInternalExpireAfterNDays']) ?>' />
 		<?php p($l->t('days')); ?>
 		<input type="checkbox" name="shareapi_internal_enforce_expire_date" id="shareapiInternalEnforceExpireDate" class="checkbox"
-			   value="1" <?php if ($_['shareInternalEnforceExpireDate'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['shareInternalEnforceExpireDate'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="shareapiInternalEnforceExpireDate"><?php p($l->t('Enforce expiration date'));?></label><br/>
 	</p>
 
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<input type="checkbox" name="shareapi_allow_links" id="allowLinks" class="checkbox"
-			   value="1" <?php if ($_['allowLinks'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['allowLinks'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="allowLinks"><?php p($l->t('Allow users to share via link'));?></label><br/>
 	</p>
 
-	<p id="publicLinkSettings" class="indent <?php if ($_['allowLinks'] !== 'yes' || $_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
+	<p id="publicLinkSettings" class="indent <?php if ($_['allowLinks'] !== 'yes' || $_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<input type="checkbox" name="shareapi_allow_public_upload" id="allowPublicUpload" class="checkbox"
-			   value="1" <?php if ($_['allowPublicUpload'] == 'yes') print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['allowPublicUpload'] == 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="allowPublicUpload"><?php p($l->t('Allow public uploads'));?></label><br/>
 		<input type="checkbox" name="shareapi_enable_link_password_by_default" id="enableLinkPasswordByDefault" class="checkbox"
-			   value="1" <?php if ($_['enableLinkPasswordByDefault'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['enableLinkPasswordByDefault'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="enableLinkPasswordByDefault"><?php p($l->t('Always ask for a password'));?></label><br/>
 		<input type="checkbox" name="shareapi_enforce_links_password" id="enforceLinkPassword" class="checkbox"
-			   value="1" <?php if ($_['enforceLinkPassword']) print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['enforceLinkPassword']) {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="enforceLinkPassword"><?php p($l->t('Enforce password protection'));?></label><br/>
 
 		<input type="checkbox" name="shareapi_default_expire_date" id="shareapiDefaultExpireDate" class="checkbox"
-			   value="1" <?php if ($_['shareDefaultExpireDateSet'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['shareDefaultExpireDateSet'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="shareapiDefaultExpireDate"><?php p($l->t('Set default expiration date for link shares'));?></label><br/>
 
 	</p>
-	<p id="setDefaultExpireDate" class="double-indent <?php if ($_['allowLinks'] !== 'yes' || $_['shareDefaultExpireDateSet'] === 'no' || $_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p id="setDefaultExpireDate" class="double-indent <?php if ($_['allowLinks'] !== 'yes' || $_['shareDefaultExpireDateSet'] === 'no' || $_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<?php p($l->t('Expire after ')); ?>
 		<input type="text" name='shareapi_expire_after_n_days' id="shareapiExpireAfterNDays" placeholder="<?php p('7')?>"
 			   value='<?php p($_['shareExpireAfterNDays']) ?>' />
 		<?php p($l->t('days')); ?>
 		<input type="checkbox" name="shareapi_enforce_expire_date" id="shareapiEnforceExpireDate" class="checkbox"
-			   value="1" <?php if ($_['shareEnforceExpireDate'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['shareEnforceExpireDate'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="shareapiEnforceExpireDate"><?php p($l->t('Enforce expiration date'));?></label><br/>
 	</p>
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<input type="checkbox" name="shareapi_allow_resharing" id="allowResharing" class="checkbox"
-			   value="1" <?php if ($_['allowResharing'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['allowResharing'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="allowResharing"><?php p($l->t('Allow resharing'));?></label><br/>
 	</p>
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<input type="checkbox" name="shareapi_allow_group_sharing" id="allowGroupSharing" class="checkbox"
-			   value="1" <?php if ($_['allowGroupSharing'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['allowGroupSharing'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="allowGroupSharing"><?php p($l->t('Allow sharing with groups'));?></label><br />
 	</p>
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<input type="checkbox" name="shareapi_only_share_with_group_members" id="onlyShareWithGroupMembers" class="checkbox"
-			   value="1" <?php if ($_['onlyShareWithGroupMembers']) print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['onlyShareWithGroupMembers']) {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="onlyShareWithGroupMembers"><?php p($l->t('Restrict users to only share with users in their groups'));?></label><br/>
 	</p>
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<input type="checkbox" name="shareapi_exclude_groups" id="shareapiExcludeGroups" class="checkbox"
-			   value="1" <?php if ($_['shareExcludeGroups']) print_unescaped('checked="checked"'); ?> />
+			   value="1" <?php if ($_['shareExcludeGroups']) {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="shareapiExcludeGroups"><?php p($l->t('Exclude groups from sharing'));?></label><br/>
 	</p>
-	<p id="selectExcludedGroups" class="indent <?php if (!$_['shareExcludeGroups'] || $_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
+	<p id="selectExcludedGroups" class="indent <?php if (!$_['shareExcludeGroups'] || $_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<input name="shareapi_exclude_groups_list" type="hidden" id="excludedGroups" value="<?php p($_['shareExcludedGroupsList']) ?>" style="width: 400px" class="noJSAutoUpdate"/>
 		<br />
 		<em><?php p($l->t('These groups will still be able to receive shares, but not to initiate them.')); ?></em>
 	</p>
 
-	<p class="<?php if ($_['shareAPIEnabled'] === 'no') p('hidden');?>">
+	<p class="<?php if ($_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<input type="checkbox" name="shareapi_allow_share_dialog_user_enumeration" value="1" id="shareapi_allow_share_dialog_user_enumeration" class="checkbox"
-			<?php if ($_['allowShareDialogUserEnumeration'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			<?php if ($_['allowShareDialogUserEnumeration'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="shareapi_allow_share_dialog_user_enumeration"><?php p($l->t('Allow username autocompletion in share dialog. If this is disabled the full username or email address needs to be entered.'));?></label><br />
 	</p>
 
-	<p id="shareapi_restrict_user_enumeration_to_group_setting" class="indent <?php if ($_['shareAPIEnabled'] === 'no' || $_['allowShareDialogUserEnumeration'] === 'no') p('hidden');?>">
+	<p id="shareapi_restrict_user_enumeration_to_group_setting" class="indent <?php if ($_['shareAPIEnabled'] === 'no' || $_['allowShareDialogUserEnumeration'] === 'no') {
+    p('hidden');
+}
+?>">
 		<input type="checkbox" name="shareapi_restrict_user_enumeration_to_group" value="1" id="shareapi_restrict_user_enumeration_to_group" class="checkbox"
-			<?php if ($_['restrictUserEnumerationToGroup'] === 'yes') print_unescaped('checked="checked"'); ?> />
+			<?php if ($_['restrictUserEnumerationToGroup'] === 'yes') {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="shareapi_restrict_user_enumeration_to_group"><?php p($l->t('Restrict username autocompletion to users within the same groups'));?></label><br />
 	</p>
 
 	<p>
 		<input type="checkbox" id="publicShareDisclaimer" class="checkbox noJSAutoUpdate"
-			<?php if ($_['publicShareDisclaimerText'] !== null) print_unescaped('checked="checked"'); ?> />
+			<?php if ($_['publicShareDisclaimerText'] !== null) {
+    print_unescaped('checked="checked"');
+}
+?> />
 		<label for="publicShareDisclaimer"><?php p($l->t('Show disclaimer text on the public link upload page. (Only shown when the file list is hidden.)'));?></label>
 		<span id="publicShareDisclaimerStatus" class="msg" style="display:none"></span>
 		<br/>
@@ -134,10 +218,16 @@ 
 	<h3><?php p($l->t('Default share permissions'));?></h3>
 	<input type="hidden" name="shareapi_default_permissions" id="shareApiDefaultPermissions" class="checkbox"
 		   value="<?php p($_['shareApiDefaultPermissions']) ?>" />
-	<p id="shareApiDefaultPermissionsSection" class="indent <?php if ($_['shareAPIEnabled'] === 'no') p('hidden'); ?>">
+	<p id="shareApiDefaultPermissionsSection" class="indent <?php if ($_['shareAPIEnabled'] === 'no') {
+    p('hidden');
+}
+?>">
 		<?php foreach ($_['shareApiDefaultPermissionsCheckboxes'] as $perm): ?>
 			<input type="checkbox" name="shareapi_default_permission_<?php p($perm['id']) ?>" id="shareapi_default_permission_<?php p($perm['id']) ?>"
-				   class="noautosave checkbox" value="<?php p($perm['value']) ?>" <?php if (($_['shareApiDefaultPermissions'] & $perm['value']) !== 0) print_unescaped('checked="checked"'); ?> />
+				   class="noautosave checkbox" value="<?php p($perm['value']) ?>" <?php if (($_['shareApiDefaultPermissions'] & $perm['value']) !== 0) {
+    print_unescaped('checked="checked"');
+}
+?> />
 			<label for="shareapi_default_permission_<?php p($perm['id']) ?>"><?php p($perm['label']);?></label>
 		<?php endforeach ?>
 	</p>

apps/settings/templates/settings/admin/overview.php

Spacing +10 added lines, -10 removed lines

@@ -28,24 +28,24 @@ 
 ?>
 
 <div id="security-warning" class="section">
-	<h2 class="inlineblock"><?php p($l->t('Security & setup warnings'));?></h2>
-	<a target="_blank" rel="noreferrer" class="icon-info" title="<?php p($l->t('Open documentation'));?>" href="<?php p(link_to_docs('admin-warnings')); ?>"></a>
-	<p class="settings-hint"><?php p($l->t('It\'s important for the security and performance of your instance that everything is configured correctly. To help you with that we are doing some automatic checks. Please see the linked documentation for more information.'));?></p>
+	<h2 class="inlineblock"><?php p($l->t('Security & setup warnings')); ?></h2>
+	<a target="_blank" rel="noreferrer" class="icon-info" title="<?php p($l->t('Open documentation')); ?>" href="<?php p(link_to_docs('admin-warnings')); ?>"></a>
+	<p class="settings-hint"><?php p($l->t('It\'s important for the security and performance of your instance that everything is configured correctly. To help you with that we are doing some automatic checks. Please see the linked documentation for more information.')); ?></p>
 
 	<div id="security-warning-state-ok" class="hidden">
-		<span class="icon icon-checkmark-white"></span><span class="message"><?php p($l->t('All checks passed.'));?></span>
+		<span class="icon icon-checkmark-white"></span><span class="message"><?php p($l->t('All checks passed.')); ?></span>
 	</div>
 	<div id="security-warning-state-failure" class="hidden">
-		<span class="icon icon-close-white"></span><span class="message"><?php p($l->t('There are some errors regarding your setup.'));?></span>
+		<span class="icon icon-close-white"></span><span class="message"><?php p($l->t('There are some errors regarding your setup.')); ?></span>
 	</div>
 	<div id="security-warning-state-warning" class="hidden">
-		<span class="icon icon-error-white"></span><span class="message"><?php p($l->t('There are some warnings regarding your setup.'));?></span>
+		<span class="icon icon-error-white"></span><span class="message"><?php p($l->t('There are some warnings regarding your setup.')); ?></span>
 	</div>
 	<div id="security-warning-state-loading">
-		<span class="icon loading"></span><span class="message"><?php p($l->t('Checking for system and security issues.'));?></span>
+		<span class="icon loading"></span><span class="message"><?php p($l->t('Checking for system and security issues.')); ?></span>
 	</div>
 
-	<div id="postsetupchecks" data-check-wellknown="<?php if($_['checkForWorkingWellKnownSetup']) { p('true'); } else { p('false'); } ?>">
+	<div id="postsetupchecks" data-check-wellknown="<?php if ($_['checkForWorkingWellKnownSetup']) { p('true'); } else { p('false'); } ?>">
 		<ul class="errors hidden"></ul>
 		<ul class="warnings hidden"></ul>
 		<ul class="info hidden"></ul>
@@ -55,13 +55,13 @@ 
 	</p>
 
 	<p class="extra-top-margin">
-		<?php print_unescaped($l->t('Check the security of your Nextcloud over <a target="_blank" rel="noreferrer noopener" href="%s">our security scan ↗</a>.', ['https://scan.nextcloud.com']));?>
+		<?php print_unescaped($l->t('Check the security of your Nextcloud over <a target="_blank" rel="noreferrer noopener" href="%s">our security scan ↗</a>.', ['https://scan.nextcloud.com'])); ?>
 	</p>
 
 </div>
 
 <div id="version" class="section">
 	<!-- should be the last part, so Updater can follow if enabled (it has no heading therefore). -->
-	<h2><?php p($l->t('Version'));?></h2>
+	<h2><?php p($l->t('Version')); ?></h2>
 	<p><strong><a href="<?php print_unescaped($theme->getBaseUrl()); ?>" rel="noreferrer noopener" target="_blank"><?php p($theme->getTitle()); ?></a> <?php p(OC_Util::getHumanVersion()) ?></strong></p>
 </div>

apps/settings/templates/settings/frame.php

Spacing +7 added lines, -7 removed lines

@@ -22,7 +22,7 @@ 
  */
 
 style('settings', 'settings');
-script('settings', [ 'settings', 'admin', 'log', 'certificates']);
+script('settings', ['settings', 'admin', 'log', 'certificates']);
 script('core', 'setupchecks');
 script('files', 'jquery.fileupload');
 
@@ -30,14 +30,14 @@ 
 
 <div id="app-navigation">
 	<ul>
-		<?php if(!empty($_['forms']['admin'])) { ?>
+		<?php if (!empty($_['forms']['admin'])) { ?>
 			<li class="app-navigation-caption"><?php p($l->t('Personal')); ?></li>
 		<?php
 		}
-		foreach($_['forms']['personal'] as $form) {
+		foreach ($_['forms']['personal'] as $form) {
 			if (isset($form['anchor'])) {
 				$anchor = \OC::$server->getURLGenerator()->linkToRoute('settings.PersonalSettings.index', ['section' => $form['anchor']]);
-				$class = 'nav-icon-' . $form['anchor'];
+				$class = 'nav-icon-'.$form['anchor'];
 				$sectionName = $form['section-name'];
 				$active = $form['active'] ? ' class="active"' : '';
 				?>
@@ -57,16 +57,16 @@ 
 		?>
 
 		<?php
-		if(!empty($_['forms']['admin'])) {
+		if (!empty($_['forms']['admin'])) {
 			?>
 			<li class="app-navigation-caption"><?php p($l->t('Administration')); ?></li>
 			<?php
 		}
-		foreach($_['forms']['admin'] as $form) {
+		foreach ($_['forms']['admin'] as $form) {
 			if (isset($form['anchor'])) {
 
 				$anchor = \OC::$server->getURLGenerator()->linkToRoute('settings.AdminSettings.index', ['section' => $form['anchor']]);
-				$class = 'nav-icon-' . $form['anchor'];
+				$class = 'nav-icon-'.$form['anchor'];
 				$sectionName = $form['section-name'];
 				$active = $form['active'] ? ' class="active"' : '';
 		?>