nextcloud / server

apps/files_trashbin/lib/Trashbin.php

Doc Comments +2 added lines, -2 removed lines

@@ -671,7 +671,7 @@ 
 	 * if the size limit for the trash bin is reached, we delete the oldest
 	 * files in the trash bin until we meet the limit again
 	 *
-	 * @param array $files
+	 * @param \OCP\Files\FileInfo[] $files
 	 * @param string $user
 	 * @param int $availableSpace available disc space
 	 * @return int size of deleted files
@@ -699,7 +699,7 @@ 
 	/**
 	 * delete files older then max storage time
 	 *
-	 * @param array $files list of files sorted by mtime
+	 * @param \OCP\Files\FileInfo[] $files list of files sorted by mtime
 	 * @param string $user
 	 * @return integer[] size of deleted files and number of deleted files
 	 */

Indentation +952 added lines, -952 removed lines

@@ -49,956 +49,956 @@
 
 class Trashbin {
 
-	// unit: percentage; 50% of available disk space/quota
-	const DEFAULTMAXSIZE = 50;
-
-	/**
-	 * Whether versions have already be rescanned during this PHP request
-	 *
-	 * @var bool
-	 */
-	private static $scannedVersions = false;
-
-	/**
-	 * Ensure we don't need to scan the file during the move to trash
-	 * by triggering the scan in the pre-hook
-	 *
-	 * @param array $params
-	 */
-	public static function ensureFileScannedHook($params) {
-		try {
-			self::getUidAndFilename($params['path']);
-		} catch (NotFoundException $e) {
-			// nothing to scan for non existing files
-		}
-	}
-
-	/**
-	 * get the UID of the owner of the file and the path to the file relative to
-	 * owners files folder
-	 *
-	 * @param string $filename
-	 * @return array
-	 * @throws \OC\User\NoUserException
-	 */
-	public static function getUidAndFilename($filename) {
-		$uid = Filesystem::getOwner($filename);
-		$userManager = \OC::$server->getUserManager();
-		// if the user with the UID doesn't exists, e.g. because the UID points
-		// to a remote user with a federated cloud ID we use the current logged-in
-		// user. We need a valid local user to move the file to the right trash bin
-		if (!$userManager->userExists($uid)) {
-			$uid = User::getUser();
-		}
-		if (!$uid) {
-			// no owner, usually because of share link from ext storage
-			return [null, null];
-		}
-		Filesystem::initMountPoints($uid);
-		if ($uid !== User::getUser()) {
-			$info = Filesystem::getFileInfo($filename);
-			$ownerView = new View('/' . $uid . '/files');
-			try {
-				$filename = $ownerView->getPath($info['fileid']);
-			} catch (NotFoundException $e) {
-				$filename = null;
-			}
-		}
-		return [$uid, $filename];
-	}
-
-	/**
-	 * get original location of files for user
-	 *
-	 * @param string $user
-	 * @return array (filename => array (timestamp => original location))
-	 */
-	public static function getLocations($user) {
-		$query = \OC_DB::prepare('SELECT `id`, `timestamp`, `location`'
-			. ' FROM `*PREFIX*files_trash` WHERE `user`=?');
-		$result = $query->execute(array($user));
-		$array = array();
-		while ($row = $result->fetchRow()) {
-			if (isset($array[$row['id']])) {
-				$array[$row['id']][$row['timestamp']] = $row['location'];
-			} else {
-				$array[$row['id']] = array($row['timestamp'] => $row['location']);
-			}
-		}
-		return $array;
-	}
-
-	/**
-	 * get original location of file
-	 *
-	 * @param string $user
-	 * @param string $filename
-	 * @param string $timestamp
-	 * @return string original location
-	 */
-	public static function getLocation($user, $filename, $timestamp) {
-		$query = \OC_DB::prepare('SELECT `location` FROM `*PREFIX*files_trash`'
-			. ' WHERE `user`=? AND `id`=? AND `timestamp`=?');
-		$result = $query->execute(array($user, $filename, $timestamp))->fetchAll();
-		if (isset($result[0]['location'])) {
-			return $result[0]['location'];
-		} else {
-			return false;
-		}
-	}
-
-	private static function setUpTrash($user) {
-		$view = new View('/' . $user);
-		if (!$view->is_dir('files_trashbin')) {
-			$view->mkdir('files_trashbin');
-		}
-		if (!$view->is_dir('files_trashbin/files')) {
-			$view->mkdir('files_trashbin/files');
-		}
-		if (!$view->is_dir('files_trashbin/versions')) {
-			$view->mkdir('files_trashbin/versions');
-		}
-		if (!$view->is_dir('files_trashbin/keys')) {
-			$view->mkdir('files_trashbin/keys');
-		}
-	}
-
-
-	/**
-	 * copy file to owners trash
-	 *
-	 * @param string $sourcePath
-	 * @param string $owner
-	 * @param string $targetPath
-	 * @param $user
-	 * @param integer $timestamp
-	 */
-	private static function copyFilesToUser($sourcePath, $owner, $targetPath, $user, $timestamp) {
-		self::setUpTrash($owner);
-
-		$targetFilename = basename($targetPath);
-		$targetLocation = dirname($targetPath);
-
-		$sourceFilename = basename($sourcePath);
-
-		$view = new View('/');
-
-		$target = $user . '/files_trashbin/files/' . $targetFilename . '.d' . $timestamp;
-		$source = $owner . '/files_trashbin/files/' . $sourceFilename . '.d' . $timestamp;
-		self::copy_recursive($source, $target, $view);
-
-
-		if ($view->file_exists($target)) {
-			$query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)");
-			$result = $query->execute(array($targetFilename, $timestamp, $targetLocation, $user));
-			if (!$result) {
-				\OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated for the files owner', \OCP\Util::ERROR);
-			}
-		}
-	}
-
-
-	/**
-	 * move file to the trash bin
-	 *
-	 * @param string $file_path path to the deleted file/directory relative to the files root directory
-	 * @param bool $ownerOnly delete for owner only (if file gets moved out of a shared folder)
-	 *
-	 * @return bool
-	 */
-	public static function move2trash($file_path, $ownerOnly = false) {
-		// get the user for which the filesystem is setup
-		$root = Filesystem::getRoot();
-		list(, $user) = explode('/', $root);
-		list($owner, $ownerPath) = self::getUidAndFilename($file_path);
-
-		// if no owner found (ex: ext storage + share link), will use the current user's trashbin then
-		if (is_null($owner)) {
-			$owner = $user;
-			$ownerPath = $file_path;
-		}
-
-		$ownerView = new View('/' . $owner);
-		// file has been deleted in between
-		if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/' . $ownerPath)) {
-			return true;
-		}
-
-		self::setUpTrash($user);
-		if ($owner !== $user) {
-			// also setup for owner
-			self::setUpTrash($owner);
-		}
-
-		$path_parts = pathinfo($ownerPath);
-
-		$filename = $path_parts['basename'];
-		$location = $path_parts['dirname'];
-		$timestamp = time();
-
-		// disable proxy to prevent recursive calls
-		$trashPath = '/files_trashbin/files/' . $filename . '.d' . $timestamp;
-
-		/** @var \OC\Files\Storage\Storage $trashStorage */
-		list($trashStorage, $trashInternalPath) = $ownerView->resolvePath($trashPath);
-		/** @var \OC\Files\Storage\Storage $sourceStorage */
-		list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/' . $ownerPath);
-		try {
-			$moveSuccessful = true;
-			if ($trashStorage->file_exists($trashInternalPath)) {
-				$trashStorage->unlink($trashInternalPath);
-			}
-			$trashStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath);
-		} catch (\OCA\Files_Trashbin\Exceptions\CopyRecursiveException $e) {
-			$moveSuccessful = false;
-			if ($trashStorage->file_exists($trashInternalPath)) {
-				$trashStorage->unlink($trashInternalPath);
-			}
-			\OCP\Util::writeLog('files_trashbin', 'Couldn\'t move ' . $file_path . ' to the trash bin', \OCP\Util::ERROR);
-		}
-
-		if ($sourceStorage->file_exists($sourceInternalPath)) { // failed to delete the original file, abort
-			if ($sourceStorage->is_dir($sourceInternalPath)) {
-				$sourceStorage->rmdir($sourceInternalPath);
-			} else {
-				$sourceStorage->unlink($sourceInternalPath);
-			}
-			return false;
-		}
-
-		$trashStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath);
-
-		if ($moveSuccessful) {
-			$query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)");
-			$result = $query->execute(array($filename, $timestamp, $location, $owner));
-			if (!$result) {
-				\OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated', \OCP\Util::ERROR);
-			}
-			\OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_moveToTrash', array('filePath' => Filesystem::normalizePath($file_path),
-				'trashPath' => Filesystem::normalizePath($filename . '.d' . $timestamp)));
-
-			self::retainVersions($filename, $owner, $ownerPath, $timestamp);
-
-			// if owner !== user we need to also add a copy to the users trash
-			if ($user !== $owner && $ownerOnly === false) {
-				self::copyFilesToUser($ownerPath, $owner, $file_path, $user, $timestamp);
-			}
-		}
-
-		self::scheduleExpire($user);
-
-		// if owner !== user we also need to update the owners trash size
-		if ($owner !== $user) {
-			self::scheduleExpire($owner);
-		}
-
-		return $moveSuccessful;
-	}
-
-	/**
-	 * Move file versions to trash so that they can be restored later
-	 *
-	 * @param string $filename of deleted file
-	 * @param string $owner owner user id
-	 * @param string $ownerPath path relative to the owner's home storage
-	 * @param integer $timestamp when the file was deleted
-	 */
-	private static function retainVersions($filename, $owner, $ownerPath, $timestamp) {
-		if (\OCP\App::isEnabled('files_versions') && !empty($ownerPath)) {
-
-			$user = User::getUser();
-			$rootView = new View('/');
-
-			if ($rootView->is_dir($owner . '/files_versions/' . $ownerPath)) {
-				if ($owner !== $user) {
-					self::copy_recursive($owner . '/files_versions/' . $ownerPath, $owner . '/files_trashbin/versions/' . basename($ownerPath) . '.d' . $timestamp, $rootView);
-				}
-				self::move($rootView, $owner . '/files_versions/' . $ownerPath, $user . '/files_trashbin/versions/' . $filename . '.d' . $timestamp);
-			} else if ($versions = \OCA\Files_Versions\Storage::getVersions($owner, $ownerPath)) {
-
-				foreach ($versions as $v) {
-					if ($owner !== $user) {
-						self::copy($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $owner . '/files_trashbin/versions/' . $v['name'] . '.v' . $v['version'] . '.d' . $timestamp);
-					}
-					self::move($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $user . '/files_trashbin/versions/' . $filename . '.v' . $v['version'] . '.d' . $timestamp);
-				}
-			}
-		}
-	}
-
-	/**
-	 * Move a file or folder on storage level
-	 *
-	 * @param View $view
-	 * @param string $source
-	 * @param string $target
-	 * @return bool
-	 */
-	private static function move(View $view, $source, $target) {
-		/** @var \OC\Files\Storage\Storage $sourceStorage */
-		list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source);
-		/** @var \OC\Files\Storage\Storage $targetStorage */
-		list($targetStorage, $targetInternalPath) = $view->resolvePath($target);
-		/** @var \OC\Files\Storage\Storage $ownerTrashStorage */
-
-		$result = $targetStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		if ($result) {
-			$targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		}
-		return $result;
-	}
-
-	/**
-	 * Copy a file or folder on storage level
-	 *
-	 * @param View $view
-	 * @param string $source
-	 * @param string $target
-	 * @return bool
-	 */
-	private static function copy(View $view, $source, $target) {
-		/** @var \OC\Files\Storage\Storage $sourceStorage */
-		list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source);
-		/** @var \OC\Files\Storage\Storage $targetStorage */
-		list($targetStorage, $targetInternalPath) = $view->resolvePath($target);
-		/** @var \OC\Files\Storage\Storage $ownerTrashStorage */
-
-		$result = $targetStorage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		if ($result) {
-			$targetStorage->getUpdater()->update($targetInternalPath);
-		}
-		return $result;
-	}
-
-	/**
-	 * Restore a file or folder from trash bin
-	 *
-	 * @param string $file path to the deleted file/folder relative to "files_trashbin/files/",
-	 * including the timestamp suffix ".d12345678"
-	 * @param string $filename name of the file/folder
-	 * @param int $timestamp time when the file/folder was deleted
-	 *
-	 * @return bool true on success, false otherwise
-	 */
-	public static function restore($file, $filename, $timestamp) {
-		$user = User::getUser();
-		$view = new View('/' . $user);
-
-		$location = '';
-		if ($timestamp) {
-			$location = self::getLocation($user, $filename, $timestamp);
-			if ($location === false) {
-				\OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: ' . $user . ' $filename: ' . $filename . ', $timestamp: ' . $timestamp . ')', \OCP\Util::ERROR);
-			} else {
-				// if location no longer exists, restore file in the root directory
-				if ($location !== '/' &&
-					(!$view->is_dir('files/' . $location) ||
-						!$view->isCreatable('files/' . $location))
-				) {
-					$location = '';
-				}
-			}
-		}
-
-		// we need a  extension in case a file/dir with the same name already exists
-		$uniqueFilename = self::getUniqueFilename($location, $filename, $view);
-
-		$source = Filesystem::normalizePath('files_trashbin/files/' . $file);
-		$target = Filesystem::normalizePath('files/' . $location . '/' . $uniqueFilename);
-		if (!$view->file_exists($source)) {
-			return false;
-		}
-		$mtime = $view->filemtime($source);
-
-		// restore file
-		$restoreResult = $view->rename($source, $target);
-
-		// handle the restore result
-		if ($restoreResult) {
-			$fakeRoot = $view->getRoot();
-			$view->chroot('/' . $user . '/files');
-			$view->touch('/' . $location . '/' . $uniqueFilename, $mtime);
-			$view->chroot($fakeRoot);
-			\OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename),
-				'trashPath' => Filesystem::normalizePath($file)));
-
-			self::restoreVersions($view, $file, $filename, $uniqueFilename, $location, $timestamp);
-
-			if ($timestamp) {
-				$query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?');
-				$query->execute(array($user, $filename, $timestamp));
-			}
-
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * restore versions from trash bin
-	 *
-	 * @param View $view file view
-	 * @param string $file complete path to file
-	 * @param string $filename name of file once it was deleted
-	 * @param string $uniqueFilename new file name to restore the file without overwriting existing files
-	 * @param string $location location if file
-	 * @param int $timestamp deletion time
-	 * @return false|null
-	 */
-	private static function restoreVersions(View $view, $file, $filename, $uniqueFilename, $location, $timestamp) {
-
-		if (\OCP\App::isEnabled('files_versions')) {
-
-			$user = User::getUser();
-			$rootView = new View('/');
-
-			$target = Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename);
-
-			list($owner, $ownerPath) = self::getUidAndFilename($target);
-
-			// file has been deleted in between
-			if (empty($ownerPath)) {
-				return false;
-			}
-
-			if ($timestamp) {
-				$versionedFile = $filename;
-			} else {
-				$versionedFile = $file;
-			}
-
-			if ($view->is_dir('/files_trashbin/versions/' . $file)) {
-				$rootView->rename(Filesystem::normalizePath($user . '/files_trashbin/versions/' . $file), Filesystem::normalizePath($owner . '/files_versions/' . $ownerPath));
-			} else if ($versions = self::getVersionsFromTrash($versionedFile, $timestamp, $user)) {
-				foreach ($versions as $v) {
-					if ($timestamp) {
-						$rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v . '.d' . $timestamp, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
-					} else {
-						$rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
-					}
-				}
-			}
-		}
-	}
-
-	/**
-	 * delete all files from the trash
-	 */
-	public static function deleteAll() {
-		$user = User::getUser();
-		$userRoot = \OC::$server->getUserFolder($user)->getParent();
-		$view = new View('/' . $user);
-		$fileInfos = $view->getDirectoryContent('files_trashbin/files');
-
-		try {
-			$trash = $userRoot->get('files_trashbin');
-		} catch (NotFoundException $e) {
-			return false;
-		}
-
-		// Array to store the relative path in (after the file is deleted, the view won't be able to relativise the path anymore)
-		$filePaths = array();
-		foreach($fileInfos as $fileInfo){
-			$filePaths[] = $view->getRelativePath($fileInfo->getPath());
-		}
-		unset($fileInfos); // save memory
-
-		// Bulk PreDelete-Hook
-		\OC_Hook::emit('\OCP\Trashbin', 'preDeleteAll', array('paths' => $filePaths));
-
-		// Single-File Hooks
-		foreach($filePaths as $path){
-			self::emitTrashbinPreDelete($path);
-		}
-
-		// actual file deletion
-		$trash->delete();
-		$query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?');
-		$query->execute(array($user));
-
-		// Bulk PostDelete-Hook
-		\OC_Hook::emit('\OCP\Trashbin', 'deleteAll', array('paths' => $filePaths));
-
-		// Single-File Hooks
-		foreach($filePaths as $path){
-			self::emitTrashbinPostDelete($path);
-		}
-
-		$trash = $userRoot->newFolder('files_trashbin');
-		$trash->newFolder('files');
-
-		return true;
-	}
-
-	/**
-	 * wrapper function to emit the 'preDelete' hook of \OCP\Trashbin before a file is deleted
-	 * @param string $path
-	 */
-	protected static function emitTrashbinPreDelete($path){
-		\OC_Hook::emit('\OCP\Trashbin', 'preDelete', array('path' => $path));
-	}
-
-	/**
-	 * wrapper function to emit the 'delete' hook of \OCP\Trashbin after a file has been deleted
-	 * @param string $path
-	 */
-	protected static function emitTrashbinPostDelete($path){
-		\OC_Hook::emit('\OCP\Trashbin', 'delete', array('path' => $path));
-	}
-
-	/**
-	 * delete file from trash bin permanently
-	 *
-	 * @param string $filename path to the file
-	 * @param string $user
-	 * @param int $timestamp of deletion time
-	 *
-	 * @return int size of deleted files
-	 */
-	public static function delete($filename, $user, $timestamp = null) {
-		$userRoot = \OC::$server->getUserFolder($user)->getParent();
-		$view = new View('/' . $user);
-		$size = 0;
-
-		if ($timestamp) {
-			$query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?');
-			$query->execute(array($user, $filename, $timestamp));
-			$file = $filename . '.d' . $timestamp;
-		} else {
-			$file = $filename;
-		}
-
-		$size += self::deleteVersions($view, $file, $filename, $timestamp, $user);
-
-		try {
-			$node = $userRoot->get('/files_trashbin/files/' . $file);
-		} catch (NotFoundException $e) {
-			return $size;
-		}
-
-		if ($node instanceof Folder) {
-			$size += self::calculateSize(new View('/' . $user . '/files_trashbin/files/' . $file));
-		} else if ($node instanceof File) {
-			$size += $view->filesize('/files_trashbin/files/' . $file);
-		}
-
-		self::emitTrashbinPreDelete('/files_trashbin/files/' . $file);
-		$node->delete();
-		self::emitTrashbinPostDelete('/files_trashbin/files/' . $file);
-
-		return $size;
-	}
-
-	/**
-	 * @param View $view
-	 * @param string $file
-	 * @param string $filename
-	 * @param integer|null $timestamp
-	 * @param string $user
-	 * @return int
-	 */
-	private static function deleteVersions(View $view, $file, $filename, $timestamp, $user) {
-		$size = 0;
-		if (\OCP\App::isEnabled('files_versions')) {
-			if ($view->is_dir('files_trashbin/versions/' . $file)) {
-				$size += self::calculateSize(new View('/' . $user . '/files_trashbin/versions/' . $file));
-				$view->unlink('files_trashbin/versions/' . $file);
-			} else if ($versions = self::getVersionsFromTrash($filename, $timestamp, $user)) {
-				foreach ($versions as $v) {
-					if ($timestamp) {
-						$size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
-						$view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
-					} else {
-						$size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v);
-						$view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v);
-					}
-				}
-			}
-		}
-		return $size;
-	}
-
-	/**
-	 * check to see whether a file exists in trashbin
-	 *
-	 * @param string $filename path to the file
-	 * @param int $timestamp of deletion time
-	 * @return bool true if file exists, otherwise false
-	 */
-	public static function file_exists($filename, $timestamp = null) {
-		$user = User::getUser();
-		$view = new View('/' . $user);
-
-		if ($timestamp) {
-			$filename = $filename . '.d' . $timestamp;
-		} else {
-			$filename = $filename;
-		}
-
-		$target = Filesystem::normalizePath('files_trashbin/files/' . $filename);
-		return $view->file_exists($target);
-	}
-
-	/**
-	 * deletes used space for trash bin in db if user was deleted
-	 *
-	 * @param string $uid id of deleted user
-	 * @return bool result of db delete operation
-	 */
-	public static function deleteUser($uid) {
-		$query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?');
-		return $query->execute(array($uid));
-	}
-
-	/**
-	 * calculate remaining free space for trash bin
-	 *
-	 * @param integer $trashbinSize current size of the trash bin
-	 * @param string $user
-	 * @return int available free space for trash bin
-	 */
-	private static function calculateFreeSpace($trashbinSize, $user) {
-		$softQuota = true;
-		$userObject = \OC::$server->getUserManager()->get($user);
-		if(is_null($userObject)) {
-			return 0;
-		}
-		$quota = $userObject->getQuota();
-		if ($quota === null || $quota === 'none') {
-			$quota = Filesystem::free_space('/');
-			$softQuota = false;
-			// inf or unknown free space
-			if ($quota < 0) {
-				$quota = PHP_INT_MAX;
-			}
-		} else {
-			$quota = \OCP\Util::computerFileSize($quota);
-		}
-
-		// calculate available space for trash bin
-		// subtract size of files and current trash bin size from quota
-		if ($softQuota) {
-			$userFolder = \OC::$server->getUserFolder($user);
-			if(is_null($userFolder)) {
-				return 0;
-			}
-			$free = $quota - $userFolder->getSize(); // remaining free space for user
-			if ($free > 0) {
-				$availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $trashbinSize; // how much space can be used for versions
-			} else {
-				$availableSpace = $free - $trashbinSize;
-			}
-		} else {
-			$availableSpace = $quota;
-		}
-
-		return $availableSpace;
-	}
-
-	/**
-	 * resize trash bin if necessary after a new file was added to Nextcloud
-	 *
-	 * @param string $user user id
-	 */
-	public static function resizeTrash($user) {
-
-		$size = self::getTrashbinSize($user);
-
-		$freeSpace = self::calculateFreeSpace($size, $user);
-
-		if ($freeSpace < 0) {
-			self::scheduleExpire($user);
-		}
-	}
-
-	/**
-	 * clean up the trash bin
-	 *
-	 * @param string $user
-	 */
-	public static function expire($user) {
-		$trashBinSize = self::getTrashbinSize($user);
-		$availableSpace = self::calculateFreeSpace($trashBinSize, $user);
-
-		$dirContent = Helper::getTrashFiles('/', $user, 'mtime');
-
-		// delete all files older then $retention_obligation
-		list($delSize, $count) = self::deleteExpiredFiles($dirContent, $user);
-
-		$availableSpace += $delSize;
-
-		// delete files from trash until we meet the trash bin size limit again
-		self::deleteFiles(array_slice($dirContent, $count), $user, $availableSpace);
-	}
-
-	/**
-	 * @param string $user
-	 */
-	private static function scheduleExpire($user) {
-		// let the admin disable auto expire
-		$application = new Application();
-		$expiration = $application->getContainer()->query('Expiration');
-		if ($expiration->isEnabled()) {
-			\OC::$server->getCommandBus()->push(new Expire($user));
-		}
-	}
-
-	/**
-	 * if the size limit for the trash bin is reached, we delete the oldest
-	 * files in the trash bin until we meet the limit again
-	 *
-	 * @param array $files
-	 * @param string $user
-	 * @param int $availableSpace available disc space
-	 * @return int size of deleted files
-	 */
-	protected static function deleteFiles($files, $user, $availableSpace) {
-		$application = new Application();
-		$expiration = $application->getContainer()->query('Expiration');
-		$size = 0;
-
-		if ($availableSpace < 0) {
-			foreach ($files as $file) {
-				if ($availableSpace < 0 && $expiration->isExpired($file['mtime'], true)) {
-					$tmp = self::delete($file['name'], $user, $file['mtime']);
-					\OCP\Util::writeLog('files_trashbin', 'remove "' . $file['name'] . '" (' . $tmp . 'B) to meet the limit of trash bin size (50% of available quota)', \OCP\Util::INFO);
-					$availableSpace += $tmp;
-					$size += $tmp;
-				} else {
-					break;
-				}
-			}
-		}
-		return $size;
-	}
-
-	/**
-	 * delete files older then max storage time
-	 *
-	 * @param array $files list of files sorted by mtime
-	 * @param string $user
-	 * @return integer[] size of deleted files and number of deleted files
-	 */
-	public static function deleteExpiredFiles($files, $user) {
-		$application = new Application();
-		$expiration = $application->getContainer()->query('Expiration');
-		$size = 0;
-		$count = 0;
-		foreach ($files as $file) {
-			$timestamp = $file['mtime'];
-			$filename = $file['name'];
-			if ($expiration->isExpired($timestamp)) {
-				$count++;
-				$size += self::delete($filename, $user, $timestamp);
-				\OC::$server->getLogger()->info(
-					'Remove "' . $filename . '" from trashbin because it exceeds max retention obligation term.',
-					['app' => 'files_trashbin']
-				);
-			} else {
-				break;
-			}
-		}
-
-		return array($size, $count);
-	}
-
-	/**
-	 * recursive copy to copy a whole directory
-	 *
-	 * @param string $source source path, relative to the users files directory
-	 * @param string $destination destination path relative to the users root directoy
-	 * @param View $view file view for the users root directory
-	 * @return int
-	 * @throws Exceptions\CopyRecursiveException
-	 */
-	private static function copy_recursive($source, $destination, View $view) {
-		$size = 0;
-		if ($view->is_dir($source)) {
-			$view->mkdir($destination);
-			$view->touch($destination, $view->filemtime($source));
-			foreach ($view->getDirectoryContent($source) as $i) {
-				$pathDir = $source . '/' . $i['name'];
-				if ($view->is_dir($pathDir)) {
-					$size += self::copy_recursive($pathDir, $destination . '/' . $i['name'], $view);
-				} else {
-					$size += $view->filesize($pathDir);
-					$result = $view->copy($pathDir, $destination . '/' . $i['name']);
-					if (!$result) {
-						throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException();
-					}
-					$view->touch($destination . '/' . $i['name'], $view->filemtime($pathDir));
-				}
-			}
-		} else {
-			$size += $view->filesize($source);
-			$result = $view->copy($source, $destination);
-			if (!$result) {
-				throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException();
-			}
-			$view->touch($destination, $view->filemtime($source));
-		}
-		return $size;
-	}
-
-	/**
-	 * find all versions which belong to the file we want to restore
-	 *
-	 * @param string $filename name of the file which should be restored
-	 * @param int $timestamp timestamp when the file was deleted
-	 * @return array
-	 */
-	private static function getVersionsFromTrash($filename, $timestamp, $user) {
-		$view = new View('/' . $user . '/files_trashbin/versions');
-		$versions = array();
-
-		//force rescan of versions, local storage may not have updated the cache
-		if (!self::$scannedVersions) {
-			/** @var \OC\Files\Storage\Storage $storage */
-			list($storage,) = $view->resolvePath('/');
-			$storage->getScanner()->scan('files_trashbin/versions');
-			self::$scannedVersions = true;
-		}
-
-		if ($timestamp) {
-			// fetch for old versions
-			$matches = $view->searchRaw($filename . '.v%.d' . $timestamp);
-			$offset = -strlen($timestamp) - 2;
-		} else {
-			$matches = $view->searchRaw($filename . '.v%');
-		}
-
-		if (is_array($matches)) {
-			foreach ($matches as $ma) {
-				if ($timestamp) {
-					$parts = explode('.v', substr($ma['path'], 0, $offset));
-					$versions[] = (end($parts));
-				} else {
-					$parts = explode('.v', $ma);
-					$versions[] = (end($parts));
-				}
-			}
-		}
-		return $versions;
-	}
-
-	/**
-	 * find unique extension for restored file if a file with the same name already exists
-	 *
-	 * @param string $location where the file should be restored
-	 * @param string $filename name of the file
-	 * @param View $view filesystem view relative to users root directory
-	 * @return string with unique extension
-	 */
-	private static function getUniqueFilename($location, $filename, View $view) {
-		$ext = pathinfo($filename, PATHINFO_EXTENSION);
-		$name = pathinfo($filename, PATHINFO_FILENAME);
-		$l = \OC::$server->getL10N('files_trashbin');
-
-		$location = '/' . trim($location, '/');
-
-		// if extension is not empty we set a dot in front of it
-		if ($ext !== '') {
-			$ext = '.' . $ext;
-		}
-
-		if ($view->file_exists('files' . $location . '/' . $filename)) {
-			$i = 2;
-			$uniqueName = $name . " (" . $l->t("restored") . ")" . $ext;
-			while ($view->file_exists('files' . $location . '/' . $uniqueName)) {
-				$uniqueName = $name . " (" . $l->t("restored") . " " . $i . ")" . $ext;
-				$i++;
-			}
-
-			return $uniqueName;
-		}
-
-		return $filename;
-	}
-
-	/**
-	 * get the size from a given root folder
-	 *
-	 * @param View $view file view on the root folder
-	 * @return integer size of the folder
-	 */
-	private static function calculateSize($view) {
-		$root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . $view->getAbsolutePath('');
-		if (!file_exists($root)) {
-			return 0;
-		}
-		$iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($root), \RecursiveIteratorIterator::CHILD_FIRST);
-		$size = 0;
-
-		/**
-		 * RecursiveDirectoryIterator on an NFS path isn't iterable with foreach
-		 * This bug is fixed in PHP 5.5.9 or before
-		 * See #8376
-		 */
-		$iterator->rewind();
-		while ($iterator->valid()) {
-			$path = $iterator->current();
-			$relpath = substr($path, strlen($root) - 1);
-			if (!$view->is_dir($relpath)) {
-				$size += $view->filesize($relpath);
-			}
-			$iterator->next();
-		}
-		return $size;
-	}
-
-	/**
-	 * get current size of trash bin from a given user
-	 *
-	 * @param string $user user who owns the trash bin
-	 * @return integer trash bin size
-	 */
-	private static function getTrashbinSize($user) {
-		$view = new View('/' . $user);
-		$fileInfo = $view->getFileInfo('/files_trashbin');
-		return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
-	}
-
-	/**
-	 * register hooks
-	 */
-	public static function registerHooks() {
-		// create storage wrapper on setup
-		\OCP\Util::connectHook('OC_Filesystem', 'preSetup', 'OCA\Files_Trashbin\Storage', 'setupStorage');
-		//Listen to delete user signal
-		\OCP\Util::connectHook('OC_User', 'pre_deleteUser', 'OCA\Files_Trashbin\Hooks', 'deleteUser_hook');
-		//Listen to post write hook
-		\OCP\Util::connectHook('OC_Filesystem', 'post_write', 'OCA\Files_Trashbin\Hooks', 'post_write_hook');
-		// pre and post-rename, disable trash logic for the copy+unlink case
-		\OCP\Util::connectHook('OC_Filesystem', 'delete', 'OCA\Files_Trashbin\Trashbin', 'ensureFileScannedHook');
-		\OCP\Util::connectHook('OC_Filesystem', 'rename', 'OCA\Files_Trashbin\Storage', 'preRenameHook');
-		\OCP\Util::connectHook('OC_Filesystem', 'post_rename', 'OCA\Files_Trashbin\Storage', 'postRenameHook');
-	}
-
-	/**
-	 * check if trash bin is empty for a given user
-	 *
-	 * @param string $user
-	 * @return bool
-	 */
-	public static function isEmpty($user) {
-
-		$view = new View('/' . $user . '/files_trashbin');
-		if ($view->is_dir('/files') && $dh = $view->opendir('/files')) {
-			while ($file = readdir($dh)) {
-				if (!Filesystem::isIgnoredDir($file)) {
-					return false;
-				}
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * @param $path
-	 * @return string
-	 */
-	public static function preview_icon($path) {
-		return \OCP\Util::linkToRoute('core_ajax_trashbin_preview', array('x' => 32, 'y' => 32, 'file' => $path));
-	}
+    // unit: percentage; 50% of available disk space/quota
+    const DEFAULTMAXSIZE = 50;
+
+    /**
+     * Whether versions have already be rescanned during this PHP request
+     *
+     * @var bool
+     */
+    private static $scannedVersions = false;
+
+    /**
+     * Ensure we don't need to scan the file during the move to trash
+     * by triggering the scan in the pre-hook
+     *
+     * @param array $params
+     */
+    public static function ensureFileScannedHook($params) {
+        try {
+            self::getUidAndFilename($params['path']);
+        } catch (NotFoundException $e) {
+            // nothing to scan for non existing files
+        }
+    }
+
+    /**
+     * get the UID of the owner of the file and the path to the file relative to
+     * owners files folder
+     *
+     * @param string $filename
+     * @return array
+     * @throws \OC\User\NoUserException
+     */
+    public static function getUidAndFilename($filename) {
+        $uid = Filesystem::getOwner($filename);
+        $userManager = \OC::$server->getUserManager();
+        // if the user with the UID doesn't exists, e.g. because the UID points
+        // to a remote user with a federated cloud ID we use the current logged-in
+        // user. We need a valid local user to move the file to the right trash bin
+        if (!$userManager->userExists($uid)) {
+            $uid = User::getUser();
+        }
+        if (!$uid) {
+            // no owner, usually because of share link from ext storage
+            return [null, null];
+        }
+        Filesystem::initMountPoints($uid);
+        if ($uid !== User::getUser()) {
+            $info = Filesystem::getFileInfo($filename);
+            $ownerView = new View('/' . $uid . '/files');
+            try {
+                $filename = $ownerView->getPath($info['fileid']);
+            } catch (NotFoundException $e) {
+                $filename = null;
+            }
+        }
+        return [$uid, $filename];
+    }
+
+    /**
+     * get original location of files for user
+     *
+     * @param string $user
+     * @return array (filename => array (timestamp => original location))
+     */
+    public static function getLocations($user) {
+        $query = \OC_DB::prepare('SELECT `id`, `timestamp`, `location`'
+            . ' FROM `*PREFIX*files_trash` WHERE `user`=?');
+        $result = $query->execute(array($user));
+        $array = array();
+        while ($row = $result->fetchRow()) {
+            if (isset($array[$row['id']])) {
+                $array[$row['id']][$row['timestamp']] = $row['location'];
+            } else {
+                $array[$row['id']] = array($row['timestamp'] => $row['location']);
+            }
+        }
+        return $array;
+    }
+
+    /**
+     * get original location of file
+     *
+     * @param string $user
+     * @param string $filename
+     * @param string $timestamp
+     * @return string original location
+     */
+    public static function getLocation($user, $filename, $timestamp) {
+        $query = \OC_DB::prepare('SELECT `location` FROM `*PREFIX*files_trash`'
+            . ' WHERE `user`=? AND `id`=? AND `timestamp`=?');
+        $result = $query->execute(array($user, $filename, $timestamp))->fetchAll();
+        if (isset($result[0]['location'])) {
+            return $result[0]['location'];
+        } else {
+            return false;
+        }
+    }
+
+    private static function setUpTrash($user) {
+        $view = new View('/' . $user);
+        if (!$view->is_dir('files_trashbin')) {
+            $view->mkdir('files_trashbin');
+        }
+        if (!$view->is_dir('files_trashbin/files')) {
+            $view->mkdir('files_trashbin/files');
+        }
+        if (!$view->is_dir('files_trashbin/versions')) {
+            $view->mkdir('files_trashbin/versions');
+        }
+        if (!$view->is_dir('files_trashbin/keys')) {
+            $view->mkdir('files_trashbin/keys');
+        }
+    }
+
+
+    /**
+     * copy file to owners trash
+     *
+     * @param string $sourcePath
+     * @param string $owner
+     * @param string $targetPath
+     * @param $user
+     * @param integer $timestamp
+     */
+    private static function copyFilesToUser($sourcePath, $owner, $targetPath, $user, $timestamp) {
+        self::setUpTrash($owner);
+
+        $targetFilename = basename($targetPath);
+        $targetLocation = dirname($targetPath);
+
+        $sourceFilename = basename($sourcePath);
+
+        $view = new View('/');
+
+        $target = $user . '/files_trashbin/files/' . $targetFilename . '.d' . $timestamp;
+        $source = $owner . '/files_trashbin/files/' . $sourceFilename . '.d' . $timestamp;
+        self::copy_recursive($source, $target, $view);
+
+
+        if ($view->file_exists($target)) {
+            $query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)");
+            $result = $query->execute(array($targetFilename, $timestamp, $targetLocation, $user));
+            if (!$result) {
+                \OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated for the files owner', \OCP\Util::ERROR);
+            }
+        }
+    }
+
+
+    /**
+     * move file to the trash bin
+     *
+     * @param string $file_path path to the deleted file/directory relative to the files root directory
+     * @param bool $ownerOnly delete for owner only (if file gets moved out of a shared folder)
+     *
+     * @return bool
+     */
+    public static function move2trash($file_path, $ownerOnly = false) {
+        // get the user for which the filesystem is setup
+        $root = Filesystem::getRoot();
+        list(, $user) = explode('/', $root);
+        list($owner, $ownerPath) = self::getUidAndFilename($file_path);
+
+        // if no owner found (ex: ext storage + share link), will use the current user's trashbin then
+        if (is_null($owner)) {
+            $owner = $user;
+            $ownerPath = $file_path;
+        }
+
+        $ownerView = new View('/' . $owner);
+        // file has been deleted in between
+        if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/' . $ownerPath)) {
+            return true;
+        }
+
+        self::setUpTrash($user);
+        if ($owner !== $user) {
+            // also setup for owner
+            self::setUpTrash($owner);
+        }
+
+        $path_parts = pathinfo($ownerPath);
+
+        $filename = $path_parts['basename'];
+        $location = $path_parts['dirname'];
+        $timestamp = time();
+
+        // disable proxy to prevent recursive calls
+        $trashPath = '/files_trashbin/files/' . $filename . '.d' . $timestamp;
+
+        /** @var \OC\Files\Storage\Storage $trashStorage */
+        list($trashStorage, $trashInternalPath) = $ownerView->resolvePath($trashPath);
+        /** @var \OC\Files\Storage\Storage $sourceStorage */
+        list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/' . $ownerPath);
+        try {
+            $moveSuccessful = true;
+            if ($trashStorage->file_exists($trashInternalPath)) {
+                $trashStorage->unlink($trashInternalPath);
+            }
+            $trashStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath);
+        } catch (\OCA\Files_Trashbin\Exceptions\CopyRecursiveException $e) {
+            $moveSuccessful = false;
+            if ($trashStorage->file_exists($trashInternalPath)) {
+                $trashStorage->unlink($trashInternalPath);
+            }
+            \OCP\Util::writeLog('files_trashbin', 'Couldn\'t move ' . $file_path . ' to the trash bin', \OCP\Util::ERROR);
+        }
+
+        if ($sourceStorage->file_exists($sourceInternalPath)) { // failed to delete the original file, abort
+            if ($sourceStorage->is_dir($sourceInternalPath)) {
+                $sourceStorage->rmdir($sourceInternalPath);
+            } else {
+                $sourceStorage->unlink($sourceInternalPath);
+            }
+            return false;
+        }
+
+        $trashStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath);
+
+        if ($moveSuccessful) {
+            $query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)");
+            $result = $query->execute(array($filename, $timestamp, $location, $owner));
+            if (!$result) {
+                \OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated', \OCP\Util::ERROR);
+            }
+            \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_moveToTrash', array('filePath' => Filesystem::normalizePath($file_path),
+                'trashPath' => Filesystem::normalizePath($filename . '.d' . $timestamp)));
+
+            self::retainVersions($filename, $owner, $ownerPath, $timestamp);
+
+            // if owner !== user we need to also add a copy to the users trash
+            if ($user !== $owner && $ownerOnly === false) {
+                self::copyFilesToUser($ownerPath, $owner, $file_path, $user, $timestamp);
+            }
+        }
+
+        self::scheduleExpire($user);
+
+        // if owner !== user we also need to update the owners trash size
+        if ($owner !== $user) {
+            self::scheduleExpire($owner);
+        }
+
+        return $moveSuccessful;
+    }
+
+    /**
+     * Move file versions to trash so that they can be restored later
+     *
+     * @param string $filename of deleted file
+     * @param string $owner owner user id
+     * @param string $ownerPath path relative to the owner's home storage
+     * @param integer $timestamp when the file was deleted
+     */
+    private static function retainVersions($filename, $owner, $ownerPath, $timestamp) {
+        if (\OCP\App::isEnabled('files_versions') && !empty($ownerPath)) {
+
+            $user = User::getUser();
+            $rootView = new View('/');
+
+            if ($rootView->is_dir($owner . '/files_versions/' . $ownerPath)) {
+                if ($owner !== $user) {
+                    self::copy_recursive($owner . '/files_versions/' . $ownerPath, $owner . '/files_trashbin/versions/' . basename($ownerPath) . '.d' . $timestamp, $rootView);
+                }
+                self::move($rootView, $owner . '/files_versions/' . $ownerPath, $user . '/files_trashbin/versions/' . $filename . '.d' . $timestamp);
+            } else if ($versions = \OCA\Files_Versions\Storage::getVersions($owner, $ownerPath)) {
+
+                foreach ($versions as $v) {
+                    if ($owner !== $user) {
+                        self::copy($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $owner . '/files_trashbin/versions/' . $v['name'] . '.v' . $v['version'] . '.d' . $timestamp);
+                    }
+                    self::move($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $user . '/files_trashbin/versions/' . $filename . '.v' . $v['version'] . '.d' . $timestamp);
+                }
+            }
+        }
+    }
+
+    /**
+     * Move a file or folder on storage level
+     *
+     * @param View $view
+     * @param string $source
+     * @param string $target
+     * @return bool
+     */
+    private static function move(View $view, $source, $target) {
+        /** @var \OC\Files\Storage\Storage $sourceStorage */
+        list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source);
+        /** @var \OC\Files\Storage\Storage $targetStorage */
+        list($targetStorage, $targetInternalPath) = $view->resolvePath($target);
+        /** @var \OC\Files\Storage\Storage $ownerTrashStorage */
+
+        $result = $targetStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        if ($result) {
+            $targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        }
+        return $result;
+    }
+
+    /**
+     * Copy a file or folder on storage level
+     *
+     * @param View $view
+     * @param string $source
+     * @param string $target
+     * @return bool
+     */
+    private static function copy(View $view, $source, $target) {
+        /** @var \OC\Files\Storage\Storage $sourceStorage */
+        list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source);
+        /** @var \OC\Files\Storage\Storage $targetStorage */
+        list($targetStorage, $targetInternalPath) = $view->resolvePath($target);
+        /** @var \OC\Files\Storage\Storage $ownerTrashStorage */
+
+        $result = $targetStorage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        if ($result) {
+            $targetStorage->getUpdater()->update($targetInternalPath);
+        }
+        return $result;
+    }
+
+    /**
+     * Restore a file or folder from trash bin
+     *
+     * @param string $file path to the deleted file/folder relative to "files_trashbin/files/",
+     * including the timestamp suffix ".d12345678"
+     * @param string $filename name of the file/folder
+     * @param int $timestamp time when the file/folder was deleted
+     *
+     * @return bool true on success, false otherwise
+     */
+    public static function restore($file, $filename, $timestamp) {
+        $user = User::getUser();
+        $view = new View('/' . $user);
+
+        $location = '';
+        if ($timestamp) {
+            $location = self::getLocation($user, $filename, $timestamp);
+            if ($location === false) {
+                \OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: ' . $user . ' $filename: ' . $filename . ', $timestamp: ' . $timestamp . ')', \OCP\Util::ERROR);
+            } else {
+                // if location no longer exists, restore file in the root directory
+                if ($location !== '/' &&
+                    (!$view->is_dir('files/' . $location) ||
+                        !$view->isCreatable('files/' . $location))
+                ) {
+                    $location = '';
+                }
+            }
+        }
+
+        // we need a  extension in case a file/dir with the same name already exists
+        $uniqueFilename = self::getUniqueFilename($location, $filename, $view);
+
+        $source = Filesystem::normalizePath('files_trashbin/files/' . $file);
+        $target = Filesystem::normalizePath('files/' . $location . '/' . $uniqueFilename);
+        if (!$view->file_exists($source)) {
+            return false;
+        }
+        $mtime = $view->filemtime($source);
+
+        // restore file
+        $restoreResult = $view->rename($source, $target);
+
+        // handle the restore result
+        if ($restoreResult) {
+            $fakeRoot = $view->getRoot();
+            $view->chroot('/' . $user . '/files');
+            $view->touch('/' . $location . '/' . $uniqueFilename, $mtime);
+            $view->chroot($fakeRoot);
+            \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename),
+                'trashPath' => Filesystem::normalizePath($file)));
+
+            self::restoreVersions($view, $file, $filename, $uniqueFilename, $location, $timestamp);
+
+            if ($timestamp) {
+                $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?');
+                $query->execute(array($user, $filename, $timestamp));
+            }
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * restore versions from trash bin
+     *
+     * @param View $view file view
+     * @param string $file complete path to file
+     * @param string $filename name of file once it was deleted
+     * @param string $uniqueFilename new file name to restore the file without overwriting existing files
+     * @param string $location location if file
+     * @param int $timestamp deletion time
+     * @return false|null
+     */
+    private static function restoreVersions(View $view, $file, $filename, $uniqueFilename, $location, $timestamp) {
+
+        if (\OCP\App::isEnabled('files_versions')) {
+
+            $user = User::getUser();
+            $rootView = new View('/');
+
+            $target = Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename);
+
+            list($owner, $ownerPath) = self::getUidAndFilename($target);
+
+            // file has been deleted in between
+            if (empty($ownerPath)) {
+                return false;
+            }
+
+            if ($timestamp) {
+                $versionedFile = $filename;
+            } else {
+                $versionedFile = $file;
+            }
+
+            if ($view->is_dir('/files_trashbin/versions/' . $file)) {
+                $rootView->rename(Filesystem::normalizePath($user . '/files_trashbin/versions/' . $file), Filesystem::normalizePath($owner . '/files_versions/' . $ownerPath));
+            } else if ($versions = self::getVersionsFromTrash($versionedFile, $timestamp, $user)) {
+                foreach ($versions as $v) {
+                    if ($timestamp) {
+                        $rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v . '.d' . $timestamp, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
+                    } else {
+                        $rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * delete all files from the trash
+     */
+    public static function deleteAll() {
+        $user = User::getUser();
+        $userRoot = \OC::$server->getUserFolder($user)->getParent();
+        $view = new View('/' . $user);
+        $fileInfos = $view->getDirectoryContent('files_trashbin/files');
+
+        try {
+            $trash = $userRoot->get('files_trashbin');
+        } catch (NotFoundException $e) {
+            return false;
+        }
+
+        // Array to store the relative path in (after the file is deleted, the view won't be able to relativise the path anymore)
+        $filePaths = array();
+        foreach($fileInfos as $fileInfo){
+            $filePaths[] = $view->getRelativePath($fileInfo->getPath());
+        }
+        unset($fileInfos); // save memory
+
+        // Bulk PreDelete-Hook
+        \OC_Hook::emit('\OCP\Trashbin', 'preDeleteAll', array('paths' => $filePaths));
+
+        // Single-File Hooks
+        foreach($filePaths as $path){
+            self::emitTrashbinPreDelete($path);
+        }
+
+        // actual file deletion
+        $trash->delete();
+        $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?');
+        $query->execute(array($user));
+
+        // Bulk PostDelete-Hook
+        \OC_Hook::emit('\OCP\Trashbin', 'deleteAll', array('paths' => $filePaths));
+
+        // Single-File Hooks
+        foreach($filePaths as $path){
+            self::emitTrashbinPostDelete($path);
+        }
+
+        $trash = $userRoot->newFolder('files_trashbin');
+        $trash->newFolder('files');
+
+        return true;
+    }
+
+    /**
+     * wrapper function to emit the 'preDelete' hook of \OCP\Trashbin before a file is deleted
+     * @param string $path
+     */
+    protected static function emitTrashbinPreDelete($path){
+        \OC_Hook::emit('\OCP\Trashbin', 'preDelete', array('path' => $path));
+    }
+
+    /**
+     * wrapper function to emit the 'delete' hook of \OCP\Trashbin after a file has been deleted
+     * @param string $path
+     */
+    protected static function emitTrashbinPostDelete($path){
+        \OC_Hook::emit('\OCP\Trashbin', 'delete', array('path' => $path));
+    }
+
+    /**
+     * delete file from trash bin permanently
+     *
+     * @param string $filename path to the file
+     * @param string $user
+     * @param int $timestamp of deletion time
+     *
+     * @return int size of deleted files
+     */
+    public static function delete($filename, $user, $timestamp = null) {
+        $userRoot = \OC::$server->getUserFolder($user)->getParent();
+        $view = new View('/' . $user);
+        $size = 0;
+
+        if ($timestamp) {
+            $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?');
+            $query->execute(array($user, $filename, $timestamp));
+            $file = $filename . '.d' . $timestamp;
+        } else {
+            $file = $filename;
+        }
+
+        $size += self::deleteVersions($view, $file, $filename, $timestamp, $user);
+
+        try {
+            $node = $userRoot->get('/files_trashbin/files/' . $file);
+        } catch (NotFoundException $e) {
+            return $size;
+        }
+
+        if ($node instanceof Folder) {
+            $size += self::calculateSize(new View('/' . $user . '/files_trashbin/files/' . $file));
+        } else if ($node instanceof File) {
+            $size += $view->filesize('/files_trashbin/files/' . $file);
+        }
+
+        self::emitTrashbinPreDelete('/files_trashbin/files/' . $file);
+        $node->delete();
+        self::emitTrashbinPostDelete('/files_trashbin/files/' . $file);
+
+        return $size;
+    }
+
+    /**
+     * @param View $view
+     * @param string $file
+     * @param string $filename
+     * @param integer|null $timestamp
+     * @param string $user
+     * @return int
+     */
+    private static function deleteVersions(View $view, $file, $filename, $timestamp, $user) {
+        $size = 0;
+        if (\OCP\App::isEnabled('files_versions')) {
+            if ($view->is_dir('files_trashbin/versions/' . $file)) {
+                $size += self::calculateSize(new View('/' . $user . '/files_trashbin/versions/' . $file));
+                $view->unlink('files_trashbin/versions/' . $file);
+            } else if ($versions = self::getVersionsFromTrash($filename, $timestamp, $user)) {
+                foreach ($versions as $v) {
+                    if ($timestamp) {
+                        $size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
+                        $view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
+                    } else {
+                        $size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v);
+                        $view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v);
+                    }
+                }
+            }
+        }
+        return $size;
+    }
+
+    /**
+     * check to see whether a file exists in trashbin
+     *
+     * @param string $filename path to the file
+     * @param int $timestamp of deletion time
+     * @return bool true if file exists, otherwise false
+     */
+    public static function file_exists($filename, $timestamp = null) {
+        $user = User::getUser();
+        $view = new View('/' . $user);
+
+        if ($timestamp) {
+            $filename = $filename . '.d' . $timestamp;
+        } else {
+            $filename = $filename;
+        }
+
+        $target = Filesystem::normalizePath('files_trashbin/files/' . $filename);
+        return $view->file_exists($target);
+    }
+
+    /**
+     * deletes used space for trash bin in db if user was deleted
+     *
+     * @param string $uid id of deleted user
+     * @return bool result of db delete operation
+     */
+    public static function deleteUser($uid) {
+        $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?');
+        return $query->execute(array($uid));
+    }
+
+    /**
+     * calculate remaining free space for trash bin
+     *
+     * @param integer $trashbinSize current size of the trash bin
+     * @param string $user
+     * @return int available free space for trash bin
+     */
+    private static function calculateFreeSpace($trashbinSize, $user) {
+        $softQuota = true;
+        $userObject = \OC::$server->getUserManager()->get($user);
+        if(is_null($userObject)) {
+            return 0;
+        }
+        $quota = $userObject->getQuota();
+        if ($quota === null || $quota === 'none') {
+            $quota = Filesystem::free_space('/');
+            $softQuota = false;
+            // inf or unknown free space
+            if ($quota < 0) {
+                $quota = PHP_INT_MAX;
+            }
+        } else {
+            $quota = \OCP\Util::computerFileSize($quota);
+        }
+
+        // calculate available space for trash bin
+        // subtract size of files and current trash bin size from quota
+        if ($softQuota) {
+            $userFolder = \OC::$server->getUserFolder($user);
+            if(is_null($userFolder)) {
+                return 0;
+            }
+            $free = $quota - $userFolder->getSize(); // remaining free space for user
+            if ($free > 0) {
+                $availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $trashbinSize; // how much space can be used for versions
+            } else {
+                $availableSpace = $free - $trashbinSize;
+            }
+        } else {
+            $availableSpace = $quota;
+        }
+
+        return $availableSpace;
+    }
+
+    /**
+     * resize trash bin if necessary after a new file was added to Nextcloud
+     *
+     * @param string $user user id
+     */
+    public static function resizeTrash($user) {
+
+        $size = self::getTrashbinSize($user);
+
+        $freeSpace = self::calculateFreeSpace($size, $user);
+
+        if ($freeSpace < 0) {
+            self::scheduleExpire($user);
+        }
+    }
+
+    /**
+     * clean up the trash bin
+     *
+     * @param string $user
+     */
+    public static function expire($user) {
+        $trashBinSize = self::getTrashbinSize($user);
+        $availableSpace = self::calculateFreeSpace($trashBinSize, $user);
+
+        $dirContent = Helper::getTrashFiles('/', $user, 'mtime');
+
+        // delete all files older then $retention_obligation
+        list($delSize, $count) = self::deleteExpiredFiles($dirContent, $user);
+
+        $availableSpace += $delSize;
+
+        // delete files from trash until we meet the trash bin size limit again
+        self::deleteFiles(array_slice($dirContent, $count), $user, $availableSpace);
+    }
+
+    /**
+     * @param string $user
+     */
+    private static function scheduleExpire($user) {
+        // let the admin disable auto expire
+        $application = new Application();
+        $expiration = $application->getContainer()->query('Expiration');
+        if ($expiration->isEnabled()) {
+            \OC::$server->getCommandBus()->push(new Expire($user));
+        }
+    }
+
+    /**
+     * if the size limit for the trash bin is reached, we delete the oldest
+     * files in the trash bin until we meet the limit again
+     *
+     * @param array $files
+     * @param string $user
+     * @param int $availableSpace available disc space
+     * @return int size of deleted files
+     */
+    protected static function deleteFiles($files, $user, $availableSpace) {
+        $application = new Application();
+        $expiration = $application->getContainer()->query('Expiration');
+        $size = 0;
+
+        if ($availableSpace < 0) {
+            foreach ($files as $file) {
+                if ($availableSpace < 0 && $expiration->isExpired($file['mtime'], true)) {
+                    $tmp = self::delete($file['name'], $user, $file['mtime']);
+                    \OCP\Util::writeLog('files_trashbin', 'remove "' . $file['name'] . '" (' . $tmp . 'B) to meet the limit of trash bin size (50% of available quota)', \OCP\Util::INFO);
+                    $availableSpace += $tmp;
+                    $size += $tmp;
+                } else {
+                    break;
+                }
+            }
+        }
+        return $size;
+    }
+
+    /**
+     * delete files older then max storage time
+     *
+     * @param array $files list of files sorted by mtime
+     * @param string $user
+     * @return integer[] size of deleted files and number of deleted files
+     */
+    public static function deleteExpiredFiles($files, $user) {
+        $application = new Application();
+        $expiration = $application->getContainer()->query('Expiration');
+        $size = 0;
+        $count = 0;
+        foreach ($files as $file) {
+            $timestamp = $file['mtime'];
+            $filename = $file['name'];
+            if ($expiration->isExpired($timestamp)) {
+                $count++;
+                $size += self::delete($filename, $user, $timestamp);
+                \OC::$server->getLogger()->info(
+                    'Remove "' . $filename . '" from trashbin because it exceeds max retention obligation term.',
+                    ['app' => 'files_trashbin']
+                );
+            } else {
+                break;
+            }
+        }
+
+        return array($size, $count);
+    }
+
+    /**
+     * recursive copy to copy a whole directory
+     *
+     * @param string $source source path, relative to the users files directory
+     * @param string $destination destination path relative to the users root directoy
+     * @param View $view file view for the users root directory
+     * @return int
+     * @throws Exceptions\CopyRecursiveException
+     */
+    private static function copy_recursive($source, $destination, View $view) {
+        $size = 0;
+        if ($view->is_dir($source)) {
+            $view->mkdir($destination);
+            $view->touch($destination, $view->filemtime($source));
+            foreach ($view->getDirectoryContent($source) as $i) {
+                $pathDir = $source . '/' . $i['name'];
+                if ($view->is_dir($pathDir)) {
+                    $size += self::copy_recursive($pathDir, $destination . '/' . $i['name'], $view);
+                } else {
+                    $size += $view->filesize($pathDir);
+                    $result = $view->copy($pathDir, $destination . '/' . $i['name']);
+                    if (!$result) {
+                        throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException();
+                    }
+                    $view->touch($destination . '/' . $i['name'], $view->filemtime($pathDir));
+                }
+            }
+        } else {
+            $size += $view->filesize($source);
+            $result = $view->copy($source, $destination);
+            if (!$result) {
+                throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException();
+            }
+            $view->touch($destination, $view->filemtime($source));
+        }
+        return $size;
+    }
+
+    /**
+     * find all versions which belong to the file we want to restore
+     *
+     * @param string $filename name of the file which should be restored
+     * @param int $timestamp timestamp when the file was deleted
+     * @return array
+     */
+    private static function getVersionsFromTrash($filename, $timestamp, $user) {
+        $view = new View('/' . $user . '/files_trashbin/versions');
+        $versions = array();
+
+        //force rescan of versions, local storage may not have updated the cache
+        if (!self::$scannedVersions) {
+            /** @var \OC\Files\Storage\Storage $storage */
+            list($storage,) = $view->resolvePath('/');
+            $storage->getScanner()->scan('files_trashbin/versions');
+            self::$scannedVersions = true;
+        }
+
+        if ($timestamp) {
+            // fetch for old versions
+            $matches = $view->searchRaw($filename . '.v%.d' . $timestamp);
+            $offset = -strlen($timestamp) - 2;
+        } else {
+            $matches = $view->searchRaw($filename . '.v%');
+        }
+
+        if (is_array($matches)) {
+            foreach ($matches as $ma) {
+                if ($timestamp) {
+                    $parts = explode('.v', substr($ma['path'], 0, $offset));
+                    $versions[] = (end($parts));
+                } else {
+                    $parts = explode('.v', $ma);
+                    $versions[] = (end($parts));
+                }
+            }
+        }
+        return $versions;
+    }
+
+    /**
+     * find unique extension for restored file if a file with the same name already exists
+     *
+     * @param string $location where the file should be restored
+     * @param string $filename name of the file
+     * @param View $view filesystem view relative to users root directory
+     * @return string with unique extension
+     */
+    private static function getUniqueFilename($location, $filename, View $view) {
+        $ext = pathinfo($filename, PATHINFO_EXTENSION);
+        $name = pathinfo($filename, PATHINFO_FILENAME);
+        $l = \OC::$server->getL10N('files_trashbin');
+
+        $location = '/' . trim($location, '/');
+
+        // if extension is not empty we set a dot in front of it
+        if ($ext !== '') {
+            $ext = '.' . $ext;
+        }
+
+        if ($view->file_exists('files' . $location . '/' . $filename)) {
+            $i = 2;
+            $uniqueName = $name . " (" . $l->t("restored") . ")" . $ext;
+            while ($view->file_exists('files' . $location . '/' . $uniqueName)) {
+                $uniqueName = $name . " (" . $l->t("restored") . " " . $i . ")" . $ext;
+                $i++;
+            }
+
+            return $uniqueName;
+        }
+
+        return $filename;
+    }
+
+    /**
+     * get the size from a given root folder
+     *
+     * @param View $view file view on the root folder
+     * @return integer size of the folder
+     */
+    private static function calculateSize($view) {
+        $root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . $view->getAbsolutePath('');
+        if (!file_exists($root)) {
+            return 0;
+        }
+        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($root), \RecursiveIteratorIterator::CHILD_FIRST);
+        $size = 0;
+
+        /**
+         * RecursiveDirectoryIterator on an NFS path isn't iterable with foreach
+         * This bug is fixed in PHP 5.5.9 or before
+         * See #8376
+         */
+        $iterator->rewind();
+        while ($iterator->valid()) {
+            $path = $iterator->current();
+            $relpath = substr($path, strlen($root) - 1);
+            if (!$view->is_dir($relpath)) {
+                $size += $view->filesize($relpath);
+            }
+            $iterator->next();
+        }
+        return $size;
+    }
+
+    /**
+     * get current size of trash bin from a given user
+     *
+     * @param string $user user who owns the trash bin
+     * @return integer trash bin size
+     */
+    private static function getTrashbinSize($user) {
+        $view = new View('/' . $user);
+        $fileInfo = $view->getFileInfo('/files_trashbin');
+        return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
+    }
+
+    /**
+     * register hooks
+     */
+    public static function registerHooks() {
+        // create storage wrapper on setup
+        \OCP\Util::connectHook('OC_Filesystem', 'preSetup', 'OCA\Files_Trashbin\Storage', 'setupStorage');
+        //Listen to delete user signal
+        \OCP\Util::connectHook('OC_User', 'pre_deleteUser', 'OCA\Files_Trashbin\Hooks', 'deleteUser_hook');
+        //Listen to post write hook
+        \OCP\Util::connectHook('OC_Filesystem', 'post_write', 'OCA\Files_Trashbin\Hooks', 'post_write_hook');
+        // pre and post-rename, disable trash logic for the copy+unlink case
+        \OCP\Util::connectHook('OC_Filesystem', 'delete', 'OCA\Files_Trashbin\Trashbin', 'ensureFileScannedHook');
+        \OCP\Util::connectHook('OC_Filesystem', 'rename', 'OCA\Files_Trashbin\Storage', 'preRenameHook');
+        \OCP\Util::connectHook('OC_Filesystem', 'post_rename', 'OCA\Files_Trashbin\Storage', 'postRenameHook');
+    }
+
+    /**
+     * check if trash bin is empty for a given user
+     *
+     * @param string $user
+     * @return bool
+     */
+    public static function isEmpty($user) {
+
+        $view = new View('/' . $user . '/files_trashbin');
+        if ($view->is_dir('/files') && $dh = $view->opendir('/files')) {
+            while ($file = readdir($dh)) {
+                if (!Filesystem::isIgnoredDir($file)) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
+    /**
+     * @param $path
+     * @return string
+     */
+    public static function preview_icon($path) {
+        return \OCP\Util::linkToRoute('core_ajax_trashbin_preview', array('x' => 32, 'y' => 32, 'file' => $path));
+    }
 }

Spacing +72 added lines, -72 removed lines

@@ -97,7 +97,7 @@ 
 		Filesystem::initMountPoints($uid);
 		if ($uid !== User::getUser()) {
 			$info = Filesystem::getFileInfo($filename);
-			$ownerView = new View('/' . $uid . '/files');
+			$ownerView = new View('/'.$uid.'/files');
 			try {
 				$filename = $ownerView->getPath($info['fileid']);
 			} catch (NotFoundException $e) {
@@ -148,7 +148,7 @@ 
 	}
 
 	private static function setUpTrash($user) {
-		$view = new View('/' . $user);
+		$view = new View('/'.$user);
 		if (!$view->is_dir('files_trashbin')) {
 			$view->mkdir('files_trashbin');
 		}
@@ -183,8 +183,8 @@ 
 
 		$view = new View('/');
 
-		$target = $user . '/files_trashbin/files/' . $targetFilename . '.d' . $timestamp;
-		$source = $owner . '/files_trashbin/files/' . $sourceFilename . '.d' . $timestamp;
+		$target = $user.'/files_trashbin/files/'.$targetFilename.'.d'.$timestamp;
+		$source = $owner.'/files_trashbin/files/'.$sourceFilename.'.d'.$timestamp;
 		self::copy_recursive($source, $target, $view);
 
 
@@ -218,9 +218,9 @@ 
 			$ownerPath = $file_path;
 		}
 
-		$ownerView = new View('/' . $owner);
+		$ownerView = new View('/'.$owner);
 		// file has been deleted in between
-		if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/' . $ownerPath)) {
+		if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/'.$ownerPath)) {
 			return true;
 		}
 
@@ -237,12 +237,12 @@ 
 		$timestamp = time();
 
 		// disable proxy to prevent recursive calls
-		$trashPath = '/files_trashbin/files/' . $filename . '.d' . $timestamp;
+		$trashPath = '/files_trashbin/files/'.$filename.'.d'.$timestamp;
 
 		/** @var \OC\Files\Storage\Storage $trashStorage */
 		list($trashStorage, $trashInternalPath) = $ownerView->resolvePath($trashPath);
 		/** @var \OC\Files\Storage\Storage $sourceStorage */
-		list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/' . $ownerPath);
+		list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/'.$ownerPath);
 		try {
 			$moveSuccessful = true;
 			if ($trashStorage->file_exists($trashInternalPath)) {
@@ -254,7 +254,7 @@ 
 			if ($trashStorage->file_exists($trashInternalPath)) {
 				$trashStorage->unlink($trashInternalPath);
 			}
-			\OCP\Util::writeLog('files_trashbin', 'Couldn\'t move ' . $file_path . ' to the trash bin', \OCP\Util::ERROR);
+			\OCP\Util::writeLog('files_trashbin', 'Couldn\'t move '.$file_path.' to the trash bin', \OCP\Util::ERROR);
 		}
 
 		if ($sourceStorage->file_exists($sourceInternalPath)) { // failed to delete the original file, abort
@@ -275,7 +275,7 @@ 
 				\OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated', \OCP\Util::ERROR);
 			}
 			\OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_moveToTrash', array('filePath' => Filesystem::normalizePath($file_path),
-				'trashPath' => Filesystem::normalizePath($filename . '.d' . $timestamp)));
+				'trashPath' => Filesystem::normalizePath($filename.'.d'.$timestamp)));
 
 			self::retainVersions($filename, $owner, $ownerPath, $timestamp);
 
@@ -309,18 +309,18 @@ 
 			$user = User::getUser();
 			$rootView = new View('/');
 
-			if ($rootView->is_dir($owner . '/files_versions/' . $ownerPath)) {
+			if ($rootView->is_dir($owner.'/files_versions/'.$ownerPath)) {
 				if ($owner !== $user) {
-					self::copy_recursive($owner . '/files_versions/' . $ownerPath, $owner . '/files_trashbin/versions/' . basename($ownerPath) . '.d' . $timestamp, $rootView);
+					self::copy_recursive($owner.'/files_versions/'.$ownerPath, $owner.'/files_trashbin/versions/'.basename($ownerPath).'.d'.$timestamp, $rootView);
 				}
-				self::move($rootView, $owner . '/files_versions/' . $ownerPath, $user . '/files_trashbin/versions/' . $filename . '.d' . $timestamp);
+				self::move($rootView, $owner.'/files_versions/'.$ownerPath, $user.'/files_trashbin/versions/'.$filename.'.d'.$timestamp);
 			} else if ($versions = \OCA\Files_Versions\Storage::getVersions($owner, $ownerPath)) {
 
 				foreach ($versions as $v) {
 					if ($owner !== $user) {
-						self::copy($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $owner . '/files_trashbin/versions/' . $v['name'] . '.v' . $v['version'] . '.d' . $timestamp);
+						self::copy($rootView, $owner.'/files_versions'.$v['path'].'.v'.$v['version'], $owner.'/files_trashbin/versions/'.$v['name'].'.v'.$v['version'].'.d'.$timestamp);
 					}
-					self::move($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $user . '/files_trashbin/versions/' . $filename . '.v' . $v['version'] . '.d' . $timestamp);
+					self::move($rootView, $owner.'/files_versions'.$v['path'].'.v'.$v['version'], $user.'/files_trashbin/versions/'.$filename.'.v'.$v['version'].'.d'.$timestamp);
 				}
 			}
 		}
@@ -382,18 +382,18 @@ 
 	 */
 	public static function restore($file, $filename, $timestamp) {
 		$user = User::getUser();
-		$view = new View('/' . $user);
+		$view = new View('/'.$user);
 
 		$location = '';
 		if ($timestamp) {
 			$location = self::getLocation($user, $filename, $timestamp);
 			if ($location === false) {
-				\OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: ' . $user . ' $filename: ' . $filename . ', $timestamp: ' . $timestamp . ')', \OCP\Util::ERROR);
+				\OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: '.$user.' $filename: '.$filename.', $timestamp: '.$timestamp.')', \OCP\Util::ERROR);
 			} else {
 				// if location no longer exists, restore file in the root directory
 				if ($location !== '/' &&
-					(!$view->is_dir('files/' . $location) ||
-						!$view->isCreatable('files/' . $location))
+					(!$view->is_dir('files/'.$location) ||
+						!$view->isCreatable('files/'.$location))
 				) {
 					$location = '';
 				}
@@ -403,8 +403,8 @@ 
 		// we need a  extension in case a file/dir with the same name already exists
 		$uniqueFilename = self::getUniqueFilename($location, $filename, $view);
 
-		$source = Filesystem::normalizePath('files_trashbin/files/' . $file);
-		$target = Filesystem::normalizePath('files/' . $location . '/' . $uniqueFilename);
+		$source = Filesystem::normalizePath('files_trashbin/files/'.$file);
+		$target = Filesystem::normalizePath('files/'.$location.'/'.$uniqueFilename);
 		if (!$view->file_exists($source)) {
 			return false;
 		}
@@ -416,10 +416,10 @@ 
 		// handle the restore result
 		if ($restoreResult) {
 			$fakeRoot = $view->getRoot();
-			$view->chroot('/' . $user . '/files');
-			$view->touch('/' . $location . '/' . $uniqueFilename, $mtime);
+			$view->chroot('/'.$user.'/files');
+			$view->touch('/'.$location.'/'.$uniqueFilename, $mtime);
 			$view->chroot($fakeRoot);
-			\OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename),
+			\OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/'.$location.'/'.$uniqueFilename),
 				'trashPath' => Filesystem::normalizePath($file)));
 
 			self::restoreVersions($view, $file, $filename, $uniqueFilename, $location, $timestamp);
@@ -453,7 +453,7 @@ 
 			$user = User::getUser();
 			$rootView = new View('/');
 
-			$target = Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename);
+			$target = Filesystem::normalizePath('/'.$location.'/'.$uniqueFilename);
 
 			list($owner, $ownerPath) = self::getUidAndFilename($target);
 
@@ -468,14 +468,14 @@ 
 				$versionedFile = $file;
 			}
 
-			if ($view->is_dir('/files_trashbin/versions/' . $file)) {
-				$rootView->rename(Filesystem::normalizePath($user . '/files_trashbin/versions/' . $file), Filesystem::normalizePath($owner . '/files_versions/' . $ownerPath));
+			if ($view->is_dir('/files_trashbin/versions/'.$file)) {
+				$rootView->rename(Filesystem::normalizePath($user.'/files_trashbin/versions/'.$file), Filesystem::normalizePath($owner.'/files_versions/'.$ownerPath));
 			} else if ($versions = self::getVersionsFromTrash($versionedFile, $timestamp, $user)) {
 				foreach ($versions as $v) {
 					if ($timestamp) {
-						$rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v . '.d' . $timestamp, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
+						$rootView->rename($user.'/files_trashbin/versions/'.$versionedFile.'.v'.$v.'.d'.$timestamp, $owner.'/files_versions/'.$ownerPath.'.v'.$v);
 					} else {
-						$rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
+						$rootView->rename($user.'/files_trashbin/versions/'.$versionedFile.'.v'.$v, $owner.'/files_versions/'.$ownerPath.'.v'.$v);
 					}
 				}
 			}
@@ -488,7 +488,7 @@ 
 	public static function deleteAll() {
 		$user = User::getUser();
 		$userRoot = \OC::$server->getUserFolder($user)->getParent();
-		$view = new View('/' . $user);
+		$view = new View('/'.$user);
 		$fileInfos = $view->getDirectoryContent('files_trashbin/files');
 
 		try {
@@ -499,7 +499,7 @@ 
 
 		// Array to store the relative path in (after the file is deleted, the view won't be able to relativise the path anymore)
 		$filePaths = array();
-		foreach($fileInfos as $fileInfo){
+		foreach ($fileInfos as $fileInfo) {
 			$filePaths[] = $view->getRelativePath($fileInfo->getPath());
 		}
 		unset($fileInfos); // save memory
@@ -508,7 +508,7 @@ 
 		\OC_Hook::emit('\OCP\Trashbin', 'preDeleteAll', array('paths' => $filePaths));
 
 		// Single-File Hooks
-		foreach($filePaths as $path){
+		foreach ($filePaths as $path) {
 			self::emitTrashbinPreDelete($path);
 		}
 
@@ -521,7 +521,7 @@ 
 		\OC_Hook::emit('\OCP\Trashbin', 'deleteAll', array('paths' => $filePaths));
 
 		// Single-File Hooks
-		foreach($filePaths as $path){
+		foreach ($filePaths as $path) {
 			self::emitTrashbinPostDelete($path);
 		}
 
@@ -535,7 +535,7 @@ 
 	 * wrapper function to emit the 'preDelete' hook of \OCP\Trashbin before a file is deleted
 	 * @param string $path
 	 */
-	protected static function emitTrashbinPreDelete($path){
+	protected static function emitTrashbinPreDelete($path) {
 		\OC_Hook::emit('\OCP\Trashbin', 'preDelete', array('path' => $path));
 	}
 
@@ -543,7 +543,7 @@ 
 	 * wrapper function to emit the 'delete' hook of \OCP\Trashbin after a file has been deleted
 	 * @param string $path
 	 */
-	protected static function emitTrashbinPostDelete($path){
+	protected static function emitTrashbinPostDelete($path) {
 		\OC_Hook::emit('\OCP\Trashbin', 'delete', array('path' => $path));
 	}
 
@@ -558,13 +558,13 @@ 
 	 */
 	public static function delete($filename, $user, $timestamp = null) {
 		$userRoot = \OC::$server->getUserFolder($user)->getParent();
-		$view = new View('/' . $user);
+		$view = new View('/'.$user);
 		$size = 0;
 
 		if ($timestamp) {
 			$query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?');
 			$query->execute(array($user, $filename, $timestamp));
-			$file = $filename . '.d' . $timestamp;
+			$file = $filename.'.d'.$timestamp;
 		} else {
 			$file = $filename;
 		}
@@ -572,20 +572,20 @@ 
 		$size += self::deleteVersions($view, $file, $filename, $timestamp, $user);
 
 		try {
-			$node = $userRoot->get('/files_trashbin/files/' . $file);
+			$node = $userRoot->get('/files_trashbin/files/'.$file);
 		} catch (NotFoundException $e) {
 			return $size;
 		}
 
 		if ($node instanceof Folder) {
-			$size += self::calculateSize(new View('/' . $user . '/files_trashbin/files/' . $file));
+			$size += self::calculateSize(new View('/'.$user.'/files_trashbin/files/'.$file));
 		} else if ($node instanceof File) {
-			$size += $view->filesize('/files_trashbin/files/' . $file);
+			$size += $view->filesize('/files_trashbin/files/'.$file);
 		}
 
-		self::emitTrashbinPreDelete('/files_trashbin/files/' . $file);
+		self::emitTrashbinPreDelete('/files_trashbin/files/'.$file);
 		$node->delete();
-		self::emitTrashbinPostDelete('/files_trashbin/files/' . $file);
+		self::emitTrashbinPostDelete('/files_trashbin/files/'.$file);
 
 		return $size;
 	}
@@ -601,17 +601,17 @@ 
 	private static function deleteVersions(View $view, $file, $filename, $timestamp, $user) {
 		$size = 0;
 		if (\OCP\App::isEnabled('files_versions')) {
-			if ($view->is_dir('files_trashbin/versions/' . $file)) {
-				$size += self::calculateSize(new View('/' . $user . '/files_trashbin/versions/' . $file));
-				$view->unlink('files_trashbin/versions/' . $file);
+			if ($view->is_dir('files_trashbin/versions/'.$file)) {
+				$size += self::calculateSize(new View('/'.$user.'/files_trashbin/versions/'.$file));
+				$view->unlink('files_trashbin/versions/'.$file);
 			} else if ($versions = self::getVersionsFromTrash($filename, $timestamp, $user)) {
 				foreach ($versions as $v) {
 					if ($timestamp) {
-						$size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
-						$view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
+						$size += $view->filesize('/files_trashbin/versions/'.$filename.'.v'.$v.'.d'.$timestamp);
+						$view->unlink('/files_trashbin/versions/'.$filename.'.v'.$v.'.d'.$timestamp);
 					} else {
-						$size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v);
-						$view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v);
+						$size += $view->filesize('/files_trashbin/versions/'.$filename.'.v'.$v);
+						$view->unlink('/files_trashbin/versions/'.$filename.'.v'.$v);
 					}
 				}
 			}
@@ -628,15 +628,15 @@ 
 	 */
 	public static function file_exists($filename, $timestamp = null) {
 		$user = User::getUser();
-		$view = new View('/' . $user);
+		$view = new View('/'.$user);
 
 		if ($timestamp) {
-			$filename = $filename . '.d' . $timestamp;
+			$filename = $filename.'.d'.$timestamp;
 		} else {
 			$filename = $filename;
 		}
 
-		$target = Filesystem::normalizePath('files_trashbin/files/' . $filename);
+		$target = Filesystem::normalizePath('files_trashbin/files/'.$filename);
 		return $view->file_exists($target);
 	}
 
@@ -661,7 +661,7 @@ 
 	private static function calculateFreeSpace($trashbinSize, $user) {
 		$softQuota = true;
 		$userObject = \OC::$server->getUserManager()->get($user);
-		if(is_null($userObject)) {
+		if (is_null($userObject)) {
 			return 0;
 		}
 		$quota = $userObject->getQuota();
@@ -680,7 +680,7 @@ 
 		// subtract size of files and current trash bin size from quota
 		if ($softQuota) {
 			$userFolder = \OC::$server->getUserFolder($user);
-			if(is_null($userFolder)) {
+			if (is_null($userFolder)) {
 				return 0;
 			}
 			$free = $quota - $userFolder->getSize(); // remaining free space for user
@@ -762,7 +762,7 @@ 
 			foreach ($files as $file) {
 				if ($availableSpace < 0 && $expiration->isExpired($file['mtime'], true)) {
 					$tmp = self::delete($file['name'], $user, $file['mtime']);
-					\OCP\Util::writeLog('files_trashbin', 'remove "' . $file['name'] . '" (' . $tmp . 'B) to meet the limit of trash bin size (50% of available quota)', \OCP\Util::INFO);
+					\OCP\Util::writeLog('files_trashbin', 'remove "'.$file['name'].'" ('.$tmp.'B) to meet the limit of trash bin size (50% of available quota)', \OCP\Util::INFO);
 					$availableSpace += $tmp;
 					$size += $tmp;
 				} else {
@@ -792,7 +792,7 @@ 
 				$count++;
 				$size += self::delete($filename, $user, $timestamp);
 				\OC::$server->getLogger()->info(
-					'Remove "' . $filename . '" from trashbin because it exceeds max retention obligation term.',
+					'Remove "'.$filename.'" from trashbin because it exceeds max retention obligation term.',
 					['app' => 'files_trashbin']
 				);
 			} else {
@@ -818,16 +818,16 @@ 
 			$view->mkdir($destination);
 			$view->touch($destination, $view->filemtime($source));
 			foreach ($view->getDirectoryContent($source) as $i) {
-				$pathDir = $source . '/' . $i['name'];
+				$pathDir = $source.'/'.$i['name'];
 				if ($view->is_dir($pathDir)) {
-					$size += self::copy_recursive($pathDir, $destination . '/' . $i['name'], $view);
+					$size += self::copy_recursive($pathDir, $destination.'/'.$i['name'], $view);
 				} else {
 					$size += $view->filesize($pathDir);
-					$result = $view->copy($pathDir, $destination . '/' . $i['name']);
+					$result = $view->copy($pathDir, $destination.'/'.$i['name']);
 					if (!$result) {
 						throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException();
 					}
-					$view->touch($destination . '/' . $i['name'], $view->filemtime($pathDir));
+					$view->touch($destination.'/'.$i['name'], $view->filemtime($pathDir));
 				}
 			}
 		} else {
@@ -849,7 +849,7 @@ 
 	 * @return array
 	 */
 	private static function getVersionsFromTrash($filename, $timestamp, $user) {
-		$view = new View('/' . $user . '/files_trashbin/versions');
+		$view = new View('/'.$user.'/files_trashbin/versions');
 		$versions = array();
 
 		//force rescan of versions, local storage may not have updated the cache
@@ -862,10 +862,10 @@ 
 
 		if ($timestamp) {
 			// fetch for old versions
-			$matches = $view->searchRaw($filename . '.v%.d' . $timestamp);
+			$matches = $view->searchRaw($filename.'.v%.d'.$timestamp);
 			$offset = -strlen($timestamp) - 2;
 		} else {
-			$matches = $view->searchRaw($filename . '.v%');
+			$matches = $view->searchRaw($filename.'.v%');
 		}
 
 		if (is_array($matches)) {
@@ -895,18 +895,18 @@ 
 		$name = pathinfo($filename, PATHINFO_FILENAME);
 		$l = \OC::$server->getL10N('files_trashbin');
 
-		$location = '/' . trim($location, '/');
+		$location = '/'.trim($location, '/');
 
 		// if extension is not empty we set a dot in front of it
 		if ($ext !== '') {
-			$ext = '.' . $ext;
+			$ext = '.'.$ext;
 		}
 
-		if ($view->file_exists('files' . $location . '/' . $filename)) {
+		if ($view->file_exists('files'.$location.'/'.$filename)) {
 			$i = 2;
-			$uniqueName = $name . " (" . $l->t("restored") . ")" . $ext;
-			while ($view->file_exists('files' . $location . '/' . $uniqueName)) {
-				$uniqueName = $name . " (" . $l->t("restored") . " " . $i . ")" . $ext;
+			$uniqueName = $name." (".$l->t("restored").")".$ext;
+			while ($view->file_exists('files'.$location.'/'.$uniqueName)) {
+				$uniqueName = $name." (".$l->t("restored")." ".$i.")".$ext;
 				$i++;
 			}
 
@@ -923,7 +923,7 @@ 
 	 * @return integer size of the folder
 	 */
 	private static function calculateSize($view) {
-		$root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . $view->getAbsolutePath('');
+		$root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').$view->getAbsolutePath('');
 		if (!file_exists($root)) {
 			return 0;
 		}
@@ -954,7 +954,7 @@ 
 	 * @return integer trash bin size
 	 */
 	private static function getTrashbinSize($user) {
-		$view = new View('/' . $user);
+		$view = new View('/'.$user);
 		$fileInfo = $view->getFileInfo('/files_trashbin');
 		return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
 	}
@@ -983,7 +983,7 @@ 
 	 */
 	public static function isEmpty($user) {
 
-		$view = new View('/' . $user . '/files_trashbin');
+		$view = new View('/'.$user.'/files_trashbin');
 		if ($view->is_dir('/files') && $dh = $view->opendir('/files')) {
 			while ($file = readdir($dh)) {
 				if (!Filesystem::isIgnoredDir($file)) {

apps/updatenotification/lib/Notification/Notifier.php

Doc Comments +3 added lines

@@ -102,6 +102,9 @@
 		return \OC_App::getAppVersions();
 	}
 
+	/**
+	 * @param string $appId
+	 */
 	protected function getAppInfo($appId) {
 		return \OC_App::getAppInfo($appId);
 	}

Spacing +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
 			$notification->setParsedSubject($l->t('Update to %1$s is available.', [$parameters['version']]));
 
 			if ($this->isAdmin()) {
-				$notification->setLink($this->url->linkToRouteAbsolute('settings.AdminSettings.index') . '#updater');
+				$notification->setLink($this->url->linkToRouteAbsolute('settings.AdminSettings.index').'#updater');
 			}
 		} else {
 			$appInfo = $this->getAppInfo($notification->getObjectType());
@@ -111,7 +111,7 @@ 
 				]);
 
 			if ($this->isAdmin()) {
-				$notification->setLink($this->url->linkToRouteAbsolute('settings.AppSettings.viewApps') . '#app-' . $notification->getObjectType());
+				$notification->setLink($this->url->linkToRouteAbsolute('settings.AppSettings.viewApps').'#app-'.$notification->getObjectType());
 			}
 		}
 

Indentation +137 added lines, -137 removed lines

@@ -36,141 +36,141 @@
 
 class Notifier implements INotifier {
 
-	/** @var IURLGenerator */
-	protected $url;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IManager */
-	protected $notificationManager;
-
-	/** @var IFactory */
-	protected $l10NFactory;
-
-	/** @var IUserSession */
-	protected $userSession;
-
-	/** @var IGroupManager */
-	protected $groupManager;
-
-	/** @var string[] */
-	protected $appVersions;
-
-	/**
-	 * Notifier constructor.
-	 *
-	 * @param IURLGenerator $url
-	 * @param IConfig $config
-	 * @param IManager $notificationManager
-	 * @param IFactory $l10NFactory
-	 * @param IUserSession $userSession
-	 * @param IGroupManager $groupManager
-	 */
-	public function __construct(IURLGenerator $url, IConfig $config, IManager $notificationManager, IFactory $l10NFactory, IUserSession $userSession, IGroupManager $groupManager) {
-		$this->url = $url;
-		$this->notificationManager = $notificationManager;
-		$this->config = $config;
-		$this->l10NFactory = $l10NFactory;
-		$this->userSession = $userSession;
-		$this->groupManager = $groupManager;
-		$this->appVersions = $this->getAppVersions();
-	}
-
-	/**
-	 * @param INotification $notification
-	 * @param string $languageCode The code of the language that should be used to prepare the notification
-	 * @return INotification
-	 * @throws \InvalidArgumentException When the notification was not prepared by a notifier
-	 * @since 9.0.0
-	 */
-	public function prepare(INotification $notification, $languageCode) {
-		if ($notification->getApp() !== 'updatenotification') {
-			throw new \InvalidArgumentException();
-		}
-
-		$l = $this->l10NFactory->get('updatenotification', $languageCode);
-		if ($notification->getSubject() === 'connection_error') {
-			$errors = (int) $this->config->getAppValue('updatenotification', 'update_check_errors', 0);
-			if ($errors === 0) {
-				$this->notificationManager->markProcessed($notification);
-				throw new \InvalidArgumentException();
-			}
-
-			$notification->setParsedSubject($l->t('The update server could not be reached since %d days to check for new updates.', [$errors]))
-				->setParsedMessage($l->t('Please check the Nextcloud and server log files for errors.'));
-		} elseif ($notification->getObjectType() === 'core') {
-			$this->updateAlreadyInstalledCheck($notification, $this->getCoreVersions());
-
-			$parameters = $notification->getSubjectParameters();
-			$notification->setParsedSubject($l->t('Update to %1$s is available.', [$parameters['version']]));
-
-			if ($this->isAdmin()) {
-				$notification->setLink($this->url->linkToRouteAbsolute('settings.AdminSettings.index') . '#updater');
-			}
-		} else {
-			$appInfo = $this->getAppInfo($notification->getObjectType());
-			$appName = ($appInfo === null) ? $notification->getObjectType() : $appInfo['name'];
-
-			if (isset($this->appVersions[$notification->getObjectType()])) {
-				$this->updateAlreadyInstalledCheck($notification, $this->appVersions[$notification->getObjectType()]);
-			}
-
-			$notification->setParsedSubject($l->t('Update for %1$s to version %2$s is available.', [$appName, $notification->getObjectId()]))
-				->setRichSubject($l->t('Update for {app} to version %s is available.', [$notification->getObjectId()]), [
-					'app' => [
-						'type' => 'app',
-						'id' => $notification->getObjectType(),
-						'name' => $appName,
-					]
-				]);
-
-			if ($this->isAdmin()) {
-				$notification->setLink($this->url->linkToRouteAbsolute('settings.AppSettings.viewApps') . '#app-' . $notification->getObjectType());
-			}
-		}
-
-		$notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('updatenotification', 'notification.svg')));
-
-		return $notification;
-	}
-
-	/**
-	 * Remove the notification and prevent rendering, when the update is installed
-	 *
-	 * @param INotification $notification
-	 * @param string $installedVersion
-	 * @throws \InvalidArgumentException When the update is already installed
-	 */
-	protected function updateAlreadyInstalledCheck(INotification $notification, $installedVersion) {
-		if (version_compare($notification->getObjectId(), $installedVersion, '<=')) {
-			$this->notificationManager->markProcessed($notification);
-			throw new \InvalidArgumentException();
-		}
-	}
-
-	/**
-	 * @return bool
-	 */
-	protected function isAdmin() {
-		$user = $this->userSession->getUser();
-
-		if ($user instanceof IUser) {
-			return $this->groupManager->isAdmin($user->getUID());
-		}
-
-		return false;
-	}
-
-	protected function getCoreVersions() {
-		return implode('.', \OCP\Util::getVersion());
-	}
-
-	protected function getAppVersions() {
-		return \OC_App::getAppVersions();
-	}
-
-	protected function getAppInfo($appId) {
-		return \OC_App::getAppInfo($appId);
-	}
+    /** @var IURLGenerator */
+    protected $url;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IManager */
+    protected $notificationManager;
+
+    /** @var IFactory */
+    protected $l10NFactory;
+
+    /** @var IUserSession */
+    protected $userSession;
+
+    /** @var IGroupManager */
+    protected $groupManager;
+
+    /** @var string[] */
+    protected $appVersions;
+
+    /**
+     * Notifier constructor.
+     *
+     * @param IURLGenerator $url
+     * @param IConfig $config
+     * @param IManager $notificationManager
+     * @param IFactory $l10NFactory
+     * @param IUserSession $userSession
+     * @param IGroupManager $groupManager
+     */
+    public function __construct(IURLGenerator $url, IConfig $config, IManager $notificationManager, IFactory $l10NFactory, IUserSession $userSession, IGroupManager $groupManager) {
+        $this->url = $url;
+        $this->notificationManager = $notificationManager;
+        $this->config = $config;
+        $this->l10NFactory = $l10NFactory;
+        $this->userSession = $userSession;
+        $this->groupManager = $groupManager;
+        $this->appVersions = $this->getAppVersions();
+    }
+
+    /**
+     * @param INotification $notification
+     * @param string $languageCode The code of the language that should be used to prepare the notification
+     * @return INotification
+     * @throws \InvalidArgumentException When the notification was not prepared by a notifier
+     * @since 9.0.0
+     */
+    public function prepare(INotification $notification, $languageCode) {
+        if ($notification->getApp() !== 'updatenotification') {
+            throw new \InvalidArgumentException();
+        }
+
+        $l = $this->l10NFactory->get('updatenotification', $languageCode);
+        if ($notification->getSubject() === 'connection_error') {
+            $errors = (int) $this->config->getAppValue('updatenotification', 'update_check_errors', 0);
+            if ($errors === 0) {
+                $this->notificationManager->markProcessed($notification);
+                throw new \InvalidArgumentException();
+            }
+
+            $notification->setParsedSubject($l->t('The update server could not be reached since %d days to check for new updates.', [$errors]))
+                ->setParsedMessage($l->t('Please check the Nextcloud and server log files for errors.'));
+        } elseif ($notification->getObjectType() === 'core') {
+            $this->updateAlreadyInstalledCheck($notification, $this->getCoreVersions());
+
+            $parameters = $notification->getSubjectParameters();
+            $notification->setParsedSubject($l->t('Update to %1$s is available.', [$parameters['version']]));
+
+            if ($this->isAdmin()) {
+                $notification->setLink($this->url->linkToRouteAbsolute('settings.AdminSettings.index') . '#updater');
+            }
+        } else {
+            $appInfo = $this->getAppInfo($notification->getObjectType());
+            $appName = ($appInfo === null) ? $notification->getObjectType() : $appInfo['name'];
+
+            if (isset($this->appVersions[$notification->getObjectType()])) {
+                $this->updateAlreadyInstalledCheck($notification, $this->appVersions[$notification->getObjectType()]);
+            }
+
+            $notification->setParsedSubject($l->t('Update for %1$s to version %2$s is available.', [$appName, $notification->getObjectId()]))
+                ->setRichSubject($l->t('Update for {app} to version %s is available.', [$notification->getObjectId()]), [
+                    'app' => [
+                        'type' => 'app',
+                        'id' => $notification->getObjectType(),
+                        'name' => $appName,
+                    ]
+                ]);
+
+            if ($this->isAdmin()) {
+                $notification->setLink($this->url->linkToRouteAbsolute('settings.AppSettings.viewApps') . '#app-' . $notification->getObjectType());
+            }
+        }
+
+        $notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('updatenotification', 'notification.svg')));
+
+        return $notification;
+    }
+
+    /**
+     * Remove the notification and prevent rendering, when the update is installed
+     *
+     * @param INotification $notification
+     * @param string $installedVersion
+     * @throws \InvalidArgumentException When the update is already installed
+     */
+    protected function updateAlreadyInstalledCheck(INotification $notification, $installedVersion) {
+        if (version_compare($notification->getObjectId(), $installedVersion, '<=')) {
+            $this->notificationManager->markProcessed($notification);
+            throw new \InvalidArgumentException();
+        }
+    }
+
+    /**
+     * @return bool
+     */
+    protected function isAdmin() {
+        $user = $this->userSession->getUser();
+
+        if ($user instanceof IUser) {
+            return $this->groupManager->isAdmin($user->getUID());
+        }
+
+        return false;
+    }
+
+    protected function getCoreVersions() {
+        return implode('.', \OCP\Util::getVersion());
+    }
+
+    protected function getAppVersions() {
+        return \OC_App::getAppVersions();
+    }
+
+    protected function getAppInfo($appId) {
+        return \OC_App::getAppInfo($appId);
+    }
 }

apps/user_ldap/lib/Command/SetConfig.php

Doc Comments -2 removed lines

@@ -74,8 +74,6 @@
 	/**
 	 * save the configuration value as provided
 	 * @param string $configID
-	 * @param string $configKey
-	 * @param string $configValue
 	 */
 	protected function setValue($configID, $key, $value) {
 		$configHolder = new Configuration($configID);

Indentation +46 added lines, -46 removed lines

@@ -34,53 +34,53 @@
 
 class SetConfig extends Command {
 
-	protected function configure() {
-		$this
-			->setName('ldap:set-config')
-			->setDescription('modifies an LDAP configuration')
-			->addArgument(
-					'configID',
-					InputArgument::REQUIRED,
-					'the configuration ID'
-				     )
-			->addArgument(
-					'configKey',
-					InputArgument::REQUIRED,
-					'the configuration key'
-				     )
-			->addArgument(
-					'configValue',
-					InputArgument::REQUIRED,
-					'the new configuration value'
-				     )
-		;
-	}
+    protected function configure() {
+        $this
+            ->setName('ldap:set-config')
+            ->setDescription('modifies an LDAP configuration')
+            ->addArgument(
+                    'configID',
+                    InputArgument::REQUIRED,
+                    'the configuration ID'
+                        )
+            ->addArgument(
+                    'configKey',
+                    InputArgument::REQUIRED,
+                    'the configuration key'
+                        )
+            ->addArgument(
+                    'configValue',
+                    InputArgument::REQUIRED,
+                    'the new configuration value'
+                        )
+        ;
+    }
 
-	protected function execute(InputInterface $input, OutputInterface $output) {
-		$helper = new Helper(\OC::$server->getConfig());
-		$availableConfigs = $helper->getServerConfigurationPrefixes();
-		$configID = $input->getArgument('configID');
-		if(!in_array($configID, $availableConfigs)) {
-			$output->writeln("Invalid configID");
-			return;
-		}
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        $helper = new Helper(\OC::$server->getConfig());
+        $availableConfigs = $helper->getServerConfigurationPrefixes();
+        $configID = $input->getArgument('configID');
+        if(!in_array($configID, $availableConfigs)) {
+            $output->writeln("Invalid configID");
+            return;
+        }
 
-		$this->setValue(
-			$configID,
-			$input->getArgument('configKey'),
-			$input->getArgument('configValue')
-		);
-	}
+        $this->setValue(
+            $configID,
+            $input->getArgument('configKey'),
+            $input->getArgument('configValue')
+        );
+    }
 
-	/**
-	 * save the configuration value as provided
-	 * @param string $configID
-	 * @param string $configKey
-	 * @param string $configValue
-	 */
-	protected function setValue($configID, $key, $value) {
-		$configHolder = new Configuration($configID);
-		$configHolder->$key = $value;
-		$configHolder->saveConfiguration();
-	}
+    /**
+     * save the configuration value as provided
+     * @param string $configID
+     * @param string $configKey
+     * @param string $configValue
+     */
+    protected function setValue($configID, $key, $value) {
+        $configHolder = new Configuration($configID);
+        $configHolder->$key = $value;
+        $configHolder->saveConfiguration();
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
 		$helper = new Helper(\OC::$server->getConfig());
 		$availableConfigs = $helper->getServerConfigurationPrefixes();
 		$configID = $input->getArgument('configID');
-		if(!in_array($configID, $availableConfigs)) {
+		if (!in_array($configID, $availableConfigs)) {
 			$output->writeln("Invalid configID");
 			return;
 		}

apps/user_ldap/lib/Jobs/UpdateGroups.php

Doc Comments +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
 	}
 
 	/**
-	 * @return int
+	 * @return string
 	 */
 	static private function getRefreshInterval() {
 		//defaults to every hour

Spacing +13 added lines, -13 removed lines

@@ -45,14 +45,14 @@ 
 
 	static private $groupBE;
 
-	public function __construct(){
+	public function __construct() {
 		$this->interval = self::getRefreshInterval();
 	}
 
 	/**
 	 * @param mixed $argument
 	 */
-	public function run($argument){
+	public function run($argument) {
 		self::updateGroups();
 	}
 
@@ -62,7 +62,7 @@ 
 		$knownGroups = array_keys(self::getKnownGroups());
 		$actualGroups = self::getGroupBE()->getGroups();
 
-		if(empty($actualGroups) && empty($knownGroups)) {
+		if (empty($actualGroups) && empty($knownGroups)) {
 			\OCP\Util::writeLog('user_ldap',
 				'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.',
 				\OCP\Util::INFO);
@@ -94,26 +94,26 @@ 
 			SET `owncloudusers` = ?
 			WHERE `owncloudname` = ?
 		');
-		foreach($groups as $group) {
+		foreach ($groups as $group) {
 			//we assume, that self::$groupsFromDB has been retrieved already
 			$knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']);
 			$actualUsers = self::getGroupBE()->usersInGroup($group);
 			$hasChanged = false;
-			foreach(array_diff($knownUsers, $actualUsers) as $removedUser) {
+			foreach (array_diff($knownUsers, $actualUsers) as $removedUser) {
 				\OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group));
 				\OCP\Util::writeLog('user_ldap',
 				'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".',
 				\OCP\Util::INFO);
 				$hasChanged = true;
 			}
-			foreach(array_diff($actualUsers, $knownUsers) as $addedUser) {
+			foreach (array_diff($actualUsers, $knownUsers) as $addedUser) {
 				\OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group));
 				\OCP\Util::writeLog('user_ldap',
 				'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".',
 				\OCP\Util::INFO);
 				$hasChanged = true;
 			}
-			if($hasChanged) {
+			if ($hasChanged) {
 				$query->execute(array(serialize($actualUsers), $group));
 			}
 		}
@@ -132,7 +132,7 @@ 
 			INTO `*PREFIX*ldap_group_members` (`owncloudname`, `owncloudusers`)
 			VALUES (?, ?)
 		');
-		foreach($createdGroups as $createdGroup) {
+		foreach ($createdGroups as $createdGroup) {
 			\OCP\Util::writeLog('user_ldap',
 				'bgJ "updateGroups" – new group "'.$createdGroup.'" found.',
 				\OCP\Util::INFO);
@@ -154,7 +154,7 @@ 
 			FROM `*PREFIX*ldap_group_members`
 			WHERE `owncloudname` = ?
 		');
-		foreach($removedGroups as $removedGroup) {
+		foreach ($removedGroups as $removedGroup) {
 			\OCP\Util::writeLog('user_ldap',
 				'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.',
 				\OCP\Util::INFO);
@@ -169,13 +169,13 @@ 
 	 * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy
 	 */
 	static private function getGroupBE() {
-		if(!is_null(self::$groupBE)) {
+		if (!is_null(self::$groupBE)) {
 			return self::$groupBE;
 		}
 		$helper = new Helper(\OC::$server->getConfig());
 		$configPrefixes = $helper->getServerConfigurationPrefixes(true);
 		$ldapWrapper = new LDAP();
-		if(count($configPrefixes) === 1) {
+		if (count($configPrefixes) === 1) {
 			//avoid the proxy when there is only one LDAP server configured
 			$dbc = \OC::$server->getDatabaseConnection();
 			$userManager = new Manager(
@@ -204,7 +204,7 @@ 
 	 * @return array
 	 */
 	static private function getKnownGroups() {
-		if(is_array(self::$groupsFromDB)) {
+		if (is_array(self::$groupsFromDB)) {
 			return self::$groupsFromDB;
 		}
 		$query = \OCP\DB::prepare('
@@ -213,7 +213,7 @@ 
 		');
 		$result = $query->execute()->fetchAll();
 		self::$groupsFromDB = array();
-		foreach($result as $dataset) {
+		foreach ($result as $dataset) {
 			self::$groupsFromDB[$dataset['owncloudname']] = $dataset;
 		}
 

Indentation +164 added lines, -164 removed lines

@@ -45,183 +45,183 @@
 use OCA\User_LDAP\User\Manager;
 
 class UpdateGroups extends \OC\BackgroundJob\TimedJob {
-	static private $groupsFromDB;
-
-	static private $groupBE;
-
-	public function __construct(){
-		$this->interval = self::getRefreshInterval();
-	}
-
-	/**
-	 * @param mixed $argument
-	 */
-	public function run($argument){
-		self::updateGroups();
-	}
-
-	static public function updateGroups() {
-		\OCP\Util::writeLog('user_ldap', 'Run background job "updateGroups"', \OCP\Util::DEBUG);
-
-		$knownGroups = array_keys(self::getKnownGroups());
-		$actualGroups = self::getGroupBE()->getGroups();
-
-		if(empty($actualGroups) && empty($knownGroups)) {
-			\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.',
-				\OCP\Util::INFO);
-			return;
-		}
-
-		self::handleKnownGroups(array_intersect($actualGroups, $knownGroups));
-		self::handleCreatedGroups(array_diff($actualGroups, $knownGroups));
-		self::handleRemovedGroups(array_diff($knownGroups, $actualGroups));
-
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Finished.', \OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @return int
-	 */
-	static private function getRefreshInterval() {
-		//defaults to every hour
-		return \OCP\Config::getAppValue('user_ldap', 'bgjRefreshInterval', 3600);
-	}
-
-	/**
-	 * @param string[] $groups
-	 */
-	static private function handleKnownGroups($groups) {
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG);
-		$query = \OCP\DB::prepare('
+    static private $groupsFromDB;
+
+    static private $groupBE;
+
+    public function __construct(){
+        $this->interval = self::getRefreshInterval();
+    }
+
+    /**
+     * @param mixed $argument
+     */
+    public function run($argument){
+        self::updateGroups();
+    }
+
+    static public function updateGroups() {
+        \OCP\Util::writeLog('user_ldap', 'Run background job "updateGroups"', \OCP\Util::DEBUG);
+
+        $knownGroups = array_keys(self::getKnownGroups());
+        $actualGroups = self::getGroupBE()->getGroups();
+
+        if(empty($actualGroups) && empty($knownGroups)) {
+            \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.',
+                \OCP\Util::INFO);
+            return;
+        }
+
+        self::handleKnownGroups(array_intersect($actualGroups, $knownGroups));
+        self::handleCreatedGroups(array_diff($actualGroups, $knownGroups));
+        self::handleRemovedGroups(array_diff($knownGroups, $actualGroups));
+
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Finished.', \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @return int
+     */
+    static private function getRefreshInterval() {
+        //defaults to every hour
+        return \OCP\Config::getAppValue('user_ldap', 'bgjRefreshInterval', 3600);
+    }
+
+    /**
+     * @param string[] $groups
+     */
+    static private function handleKnownGroups($groups) {
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG);
+        $query = \OCP\DB::prepare('
 			UPDATE `*PREFIX*ldap_group_members`
 			SET `owncloudusers` = ?
 			WHERE `owncloudname` = ?
 		');
-		foreach($groups as $group) {
-			//we assume, that self::$groupsFromDB has been retrieved already
-			$knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']);
-			$actualUsers = self::getGroupBE()->usersInGroup($group);
-			$hasChanged = false;
-			foreach(array_diff($knownUsers, $actualUsers) as $removedUser) {
-				\OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group));
-				\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".',
-				\OCP\Util::INFO);
-				$hasChanged = true;
-			}
-			foreach(array_diff($actualUsers, $knownUsers) as $addedUser) {
-				\OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group));
-				\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".',
-				\OCP\Util::INFO);
-				$hasChanged = true;
-			}
-			if($hasChanged) {
-				$query->execute(array(serialize($actualUsers), $group));
-			}
-		}
-		\OCP\Util::writeLog('user_ldap',
-			'bgJ "updateGroups" – FINISHED dealing with known Groups.',
-			\OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @param string[] $createdGroups
-	 */
-	static private function handleCreatedGroups($createdGroups) {
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG);
-		$query = \OCP\DB::prepare('
+        foreach($groups as $group) {
+            //we assume, that self::$groupsFromDB has been retrieved already
+            $knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']);
+            $actualUsers = self::getGroupBE()->usersInGroup($group);
+            $hasChanged = false;
+            foreach(array_diff($knownUsers, $actualUsers) as $removedUser) {
+                \OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group));
+                \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".',
+                \OCP\Util::INFO);
+                $hasChanged = true;
+            }
+            foreach(array_diff($actualUsers, $knownUsers) as $addedUser) {
+                \OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group));
+                \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".',
+                \OCP\Util::INFO);
+                $hasChanged = true;
+            }
+            if($hasChanged) {
+                $query->execute(array(serialize($actualUsers), $group));
+            }
+        }
+        \OCP\Util::writeLog('user_ldap',
+            'bgJ "updateGroups" – FINISHED dealing with known Groups.',
+            \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @param string[] $createdGroups
+     */
+    static private function handleCreatedGroups($createdGroups) {
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG);
+        $query = \OCP\DB::prepare('
 			INSERT
 			INTO `*PREFIX*ldap_group_members` (`owncloudname`, `owncloudusers`)
 			VALUES (?, ?)
 		');
-		foreach($createdGroups as $createdGroup) {
-			\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – new group "'.$createdGroup.'" found.',
-				\OCP\Util::INFO);
-			$users = serialize(self::getGroupBE()->usersInGroup($createdGroup));
-			$query->execute(array($createdGroup, $users));
-		}
-		\OCP\Util::writeLog('user_ldap',
-			'bgJ "updateGroups" – FINISHED dealing with created Groups.',
-			\OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @param string[] $removedGroups
-	 */
-	static private function handleRemovedGroups($removedGroups) {
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG);
-		$query = \OCP\DB::prepare('
+        foreach($createdGroups as $createdGroup) {
+            \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – new group "'.$createdGroup.'" found.',
+                \OCP\Util::INFO);
+            $users = serialize(self::getGroupBE()->usersInGroup($createdGroup));
+            $query->execute(array($createdGroup, $users));
+        }
+        \OCP\Util::writeLog('user_ldap',
+            'bgJ "updateGroups" – FINISHED dealing with created Groups.',
+            \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @param string[] $removedGroups
+     */
+    static private function handleRemovedGroups($removedGroups) {
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG);
+        $query = \OCP\DB::prepare('
 			DELETE
 			FROM `*PREFIX*ldap_group_members`
 			WHERE `owncloudname` = ?
 		');
-		foreach($removedGroups as $removedGroup) {
-			\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.',
-				\OCP\Util::INFO);
-			$query->execute(array($removedGroup));
-		}
-		\OCP\Util::writeLog('user_ldap',
-			'bgJ "updateGroups" – FINISHED dealing with removed groups.',
-			\OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy
-	 */
-	static private function getGroupBE() {
-		if(!is_null(self::$groupBE)) {
-			return self::$groupBE;
-		}
-		$helper = new Helper(\OC::$server->getConfig());
-		$configPrefixes = $helper->getServerConfigurationPrefixes(true);
-		$ldapWrapper = new LDAP();
-		if(count($configPrefixes) === 1) {
-			//avoid the proxy when there is only one LDAP server configured
-			$dbc = \OC::$server->getDatabaseConnection();
-			$userManager = new Manager(
-				\OC::$server->getConfig(),
-				new FilesystemHelper(),
-				new LogWrapper(),
-				\OC::$server->getAvatarManager(),
-				new \OCP\Image(),
-				$dbc,
-				\OC::$server->getUserManager(),
-				\OC::$server->getNotificationManager());
-			$connector = new Connection($ldapWrapper, $configPrefixes[0]);
-			$ldapAccess = new Access($connector, $ldapWrapper, $userManager, $helper, \OC::$server->getConfig());
-			$groupMapper = new GroupMapping($dbc);
-			$userMapper  = new UserMapping($dbc);
-			$ldapAccess->setGroupMapper($groupMapper);
-			$ldapAccess->setUserMapper($userMapper);
-			self::$groupBE = new \OCA\User_LDAP\Group_LDAP($ldapAccess, \OC::$server->query('LDAPGroupPluginManager'));
-		} else {
-			self::$groupBE = new \OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper, \OC::$server->query('LDAPGroupPluginManager'));
-		}
-
-		return self::$groupBE;
-	}
-
-	/**
-	 * @return array
-	 */
-	static private function getKnownGroups() {
-		if(is_array(self::$groupsFromDB)) {
-			return self::$groupsFromDB;
-		}
-		$query = \OCP\DB::prepare('
+        foreach($removedGroups as $removedGroup) {
+            \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.',
+                \OCP\Util::INFO);
+            $query->execute(array($removedGroup));
+        }
+        \OCP\Util::writeLog('user_ldap',
+            'bgJ "updateGroups" – FINISHED dealing with removed groups.',
+            \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy
+     */
+    static private function getGroupBE() {
+        if(!is_null(self::$groupBE)) {
+            return self::$groupBE;
+        }
+        $helper = new Helper(\OC::$server->getConfig());
+        $configPrefixes = $helper->getServerConfigurationPrefixes(true);
+        $ldapWrapper = new LDAP();
+        if(count($configPrefixes) === 1) {
+            //avoid the proxy when there is only one LDAP server configured
+            $dbc = \OC::$server->getDatabaseConnection();
+            $userManager = new Manager(
+                \OC::$server->getConfig(),
+                new FilesystemHelper(),
+                new LogWrapper(),
+                \OC::$server->getAvatarManager(),
+                new \OCP\Image(),
+                $dbc,
+                \OC::$server->getUserManager(),
+                \OC::$server->getNotificationManager());
+            $connector = new Connection($ldapWrapper, $configPrefixes[0]);
+            $ldapAccess = new Access($connector, $ldapWrapper, $userManager, $helper, \OC::$server->getConfig());
+            $groupMapper = new GroupMapping($dbc);
+            $userMapper  = new UserMapping($dbc);
+            $ldapAccess->setGroupMapper($groupMapper);
+            $ldapAccess->setUserMapper($userMapper);
+            self::$groupBE = new \OCA\User_LDAP\Group_LDAP($ldapAccess, \OC::$server->query('LDAPGroupPluginManager'));
+        } else {
+            self::$groupBE = new \OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper, \OC::$server->query('LDAPGroupPluginManager'));
+        }
+
+        return self::$groupBE;
+    }
+
+    /**
+     * @return array
+     */
+    static private function getKnownGroups() {
+        if(is_array(self::$groupsFromDB)) {
+            return self::$groupsFromDB;
+        }
+        $query = \OCP\DB::prepare('
 			SELECT `owncloudname`, `owncloudusers`
 			FROM `*PREFIX*ldap_group_members`
 		');
-		$result = $query->execute()->fetchAll();
-		self::$groupsFromDB = array();
-		foreach($result as $dataset) {
-			self::$groupsFromDB[$dataset['owncloudname']] = $dataset;
-		}
-
-		return self::$groupsFromDB;
-	}
+        $result = $query->execute()->fetchAll();
+        self::$groupsFromDB = array();
+        foreach($result as $dataset) {
+            self::$groupsFromDB[$dataset['owncloudname']] = $dataset;
+        }
+
+        return self::$groupsFromDB;
+    }
 }

lib/private/AllConfig.php

Doc Comments +1 added lines, -1 removed lines

@@ -112,7 +112,7 @@
 	 * Looks up a system wide defined value
 	 *
 	 * @param string $key the key of the value, under which it was saved
-	 * @param mixed $default the default value to be returned if the value isn't set
+	 * @param string $default the default value to be returned if the value isn't set
 	 * @return mixed the value or $default
 	 */
 	public function getSystemValue($key, $default = '') {

Indentation +423 added lines, -423 removed lines

@@ -37,427 +37,427 @@
  * Class to combine all the configuration options ownCloud offers
  */
 class AllConfig implements \OCP\IConfig {
-	/** @var SystemConfig */
-	private $systemConfig;
-
-	/** @var IDBConnection */
-	private $connection;
-
-	/**
-	 * 3 dimensional array with the following structure:
-	 * [ $userId =>
-	 *     [ $appId =>
-	 *         [ $key => $value ]
-	 *     ]
-	 * ]
-	 *
-	 * database table: preferences
-	 *
-	 * methods that use this:
-	 *   - setUserValue
-	 *   - getUserValue
-	 *   - getUserKeys
-	 *   - deleteUserValue
-	 *   - deleteAllUserValues
-	 *   - deleteAppFromAllUsers
-	 *
-	 * @var CappedMemoryCache $userCache
-	 */
-	private $userCache;
-
-	/**
-	 * @param SystemConfig $systemConfig
-	 */
-	public function __construct(SystemConfig $systemConfig) {
-		$this->userCache = new CappedMemoryCache();
-		$this->systemConfig = $systemConfig;
-	}
-
-	/**
-	 * TODO - FIXME This fixes an issue with base.php that cause cyclic
-	 * dependencies, especially with autoconfig setup
-	 *
-	 * Replace this by properly injected database connection. Currently the
-	 * base.php triggers the getDatabaseConnection too early which causes in
-	 * autoconfig setup case a too early distributed database connection and
-	 * the autoconfig then needs to reinit all already initialized dependencies
-	 * that use the database connection.
-	 *
-	 * otherwise a SQLite database is created in the wrong directory
-	 * because the database connection was created with an uninitialized config
-	 */
-	private function fixDIInit() {
-		if($this->connection === null) {
-			$this->connection = \OC::$server->getDatabaseConnection();
-		}
-	}
-
-	/**
-	 * Sets and deletes system wide values
-	 *
-	 * @param array $configs Associative array with `key => value` pairs
-	 *                       If value is null, the config key will be deleted
-	 */
-	public function setSystemValues(array $configs) {
-		$this->systemConfig->setValues($configs);
-	}
-
-	/**
-	 * Sets a new system wide value
-	 *
-	 * @param string $key the key of the value, under which will be saved
-	 * @param mixed $value the value that should be stored
-	 */
-	public function setSystemValue($key, $value) {
-		$this->systemConfig->setValue($key, $value);
-	}
-
-	/**
-	 * Looks up a system wide defined value
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return mixed the value or $default
-	 */
-	public function getSystemValue($key, $default = '') {
-		return $this->systemConfig->getValue($key, $default);
-	}
-
-	/**
-	 * Looks up a system wide defined value and filters out sensitive data
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return mixed the value or $default
-	 */
-	public function getFilteredSystemValue($key, $default = '') {
-		return $this->systemConfig->getFilteredValue($key, $default);
-	}
-
-	/**
-	 * Delete a system wide defined value
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 */
-	public function deleteSystemValue($key) {
-		$this->systemConfig->deleteValue($key);
-	}
-
-	/**
-	 * Get all keys stored for an app
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @return string[] the keys stored for the app
-	 */
-	public function getAppKeys($appName) {
-		return \OC::$server->getAppConfig()->getKeys($appName);
-	}
-
-	/**
-	 * Writes a new app wide value
-	 *
-	 * @param string $appName the appName that we want to store the value under
-	 * @param string $key the key of the value, under which will be saved
-	 * @param string|float|int $value the value that should be stored
-	 */
-	public function setAppValue($appName, $key, $value) {
-		\OC::$server->getAppConfig()->setValue($appName, $key, $value);
-	}
-
-	/**
-	 * Looks up an app wide defined value
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key of the value, under which it was saved
-	 * @param string $default the default value to be returned if the value isn't set
-	 * @return string the saved value
-	 */
-	public function getAppValue($appName, $key, $default = '') {
-		return \OC::$server->getAppConfig()->getValue($appName, $key, $default);
-	}
-
-	/**
-	 * Delete an app wide defined value
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key of the value, under which it was saved
-	 */
-	public function deleteAppValue($appName, $key) {
-		\OC::$server->getAppConfig()->deleteKey($appName, $key);
-	}
-
-	/**
-	 * Removes all keys in appconfig belonging to the app
-	 *
-	 * @param string $appName the appName the configs are stored under
-	 */
-	public function deleteAppValues($appName) {
-		\OC::$server->getAppConfig()->deleteApp($appName);
-	}
-
-
-	/**
-	 * Set a user defined value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we want to store the value under
-	 * @param string $key the key under which the value is being stored
-	 * @param string|float|int $value the value that you want to store
-	 * @param string $preCondition only update if the config value was previously the value passed as $preCondition
-	 * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
-	 * @throws \UnexpectedValueException when trying to store an unexpected value
-	 */
-	public function setUserValue($userId, $appName, $key, $value, $preCondition = null) {
-		if (!is_int($value) && !is_float($value) && !is_string($value)) {
-			throw new \UnexpectedValueException('Only integers, floats and strings are allowed as value');
-		}
-
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$prevValue = $this->getUserValue($userId, $appName, $key, null);
-
-		if ($prevValue !== null) {
-			if ($prevValue === (string)$value) {
-				return;
-			} else if ($preCondition !== null && $prevValue !== (string)$preCondition) {
-				throw new PreConditionNotMetException();
-			} else {
-				$qb = $this->connection->getQueryBuilder();
-				$qb->update('preferences')
-					->set('configvalue', $qb->createNamedParameter($value))
-					->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId)))
-					->andWhere($qb->expr()->eq('appid', $qb->createNamedParameter($appName)))
-					->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key)));
-				$qb->execute();
-
-				$this->userCache[$userId][$appName][$key] = $value;
-				return;
-			}
-		}
-
-		$preconditionArray = [];
-		if (isset($preCondition)) {
-			$preconditionArray = [
-				'configvalue' => $preCondition,
-			];
-		}
-
-		$this->connection->setValues('preferences', [
-			'userid' => $userId,
-			'appid' => $appName,
-			'configkey' => $key,
-		], [
-			'configvalue' => $value,
-		], $preconditionArray);
-
-		// only add to the cache if we already loaded data for the user
-		if (isset($this->userCache[$userId])) {
-			if (!isset($this->userCache[$userId][$appName])) {
-				$this->userCache[$userId][$appName] = array();
-			}
-			$this->userCache[$userId][$appName][$key] = $value;
-		}
-	}
-
-	/**
-	 * Getting a user defined value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key under which the value is being stored
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return string
-	 */
-	public function getUserValue($userId, $appName, $key, $default = '') {
-		$data = $this->getUserValues($userId);
-		if (isset($data[$appName]) and isset($data[$appName][$key])) {
-			return $data[$appName][$key];
-		} else {
-			return $default;
-		}
-	}
-
-	/**
-	 * Get the keys of all stored by an app for the user
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @return string[]
-	 */
-	public function getUserKeys($userId, $appName) {
-		$data = $this->getUserValues($userId);
-		if (isset($data[$appName])) {
-			return array_keys($data[$appName]);
-		} else {
-			return array();
-		}
-	}
-
-	/**
-	 * Delete a user value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key under which the value is being stored
-	 */
-	public function deleteUserValue($userId, $appName, $key) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
-				'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
-		$this->connection->executeUpdate($sql, array($userId, $appName, $key));
-
-		if (isset($this->userCache[$userId]) and isset($this->userCache[$userId][$appName])) {
-			unset($this->userCache[$userId][$appName][$key]);
-		}
-	}
-
-	/**
-	 * Delete all user values
-	 *
-	 * @param string $userId the userId of the user that we want to remove all values from
-	 */
-	public function deleteAllUserValues($userId) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
-			'WHERE `userid` = ?';
-		$this->connection->executeUpdate($sql, array($userId));
-
-		unset($this->userCache[$userId]);
-	}
-
-	/**
-	 * Delete all user related values of one app
-	 *
-	 * @param string $appName the appName of the app that we want to remove all values from
-	 */
-	public function deleteAppFromAllUsers($appName) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
-				'WHERE `appid` = ?';
-		$this->connection->executeUpdate($sql, array($appName));
-
-		foreach ($this->userCache as &$userCache) {
-			unset($userCache[$appName]);
-		}
-	}
-
-	/**
-	 * Returns all user configs sorted by app of one user
-	 *
-	 * @param string $userId the user ID to get the app configs from
-	 * @return array[] - 2 dimensional array with the following structure:
-	 *     [ $appId =>
-	 *         [ $key => $value ]
-	 *     ]
-	 */
-	private function getUserValues($userId) {
-		if (isset($this->userCache[$userId])) {
-			return $this->userCache[$userId];
-		}
-		if ($userId === null || $userId === '') {
-			$this->userCache[$userId]=array();
-			return $this->userCache[$userId];
-		}
-
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$data = array();
-		$query = 'SELECT `appid`, `configkey`, `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?';
-		$result = $this->connection->executeQuery($query, array($userId));
-		while ($row = $result->fetch()) {
-			$appId = $row['appid'];
-			if (!isset($data[$appId])) {
-				$data[$appId] = array();
-			}
-			$data[$appId][$row['configkey']] = $row['configvalue'];
-		}
-		$this->userCache[$userId] = $data;
-		return $data;
-	}
-
-	/**
-	 * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs.
-	 *
-	 * @param string $appName app to get the value for
-	 * @param string $key the key to get the value for
-	 * @param array $userIds the user IDs to fetch the values for
-	 * @return array Mapped values: userId => value
-	 */
-	public function getUserValueForUsers($appName, $key, $userIds) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		if (empty($userIds) || !is_array($userIds)) {
-			return array();
-		}
-
-		$chunkedUsers = array_chunk($userIds, 50, true);
-		$placeholders50 = implode(',', array_fill(0, 50, '?'));
-
-		$userValues = array();
-		foreach ($chunkedUsers as $chunk) {
-			$queryParams = $chunk;
-			// create [$app, $key, $chunkedUsers]
-			array_unshift($queryParams, $key);
-			array_unshift($queryParams, $appName);
-
-			$placeholders = (count($chunk) === 50) ? $placeholders50 :  implode(',', array_fill(0, count($chunk), '?'));
-
-			$query    = 'SELECT `userid`, `configvalue` ' .
-						'FROM `*PREFIX*preferences` ' .
-						'WHERE `appid` = ? AND `configkey` = ? ' .
-						'AND `userid` IN (' . $placeholders . ')';
-			$result = $this->connection->executeQuery($query, $queryParams);
-
-			while ($row = $result->fetch()) {
-				$userValues[$row['userid']] = $row['configvalue'];
-			}
-		}
-
-		return $userValues;
-	}
-
-	/**
-	 * Determines the users that have the given value set for a specific app-key-pair
-	 *
-	 * @param string $appName the app to get the user for
-	 * @param string $key the key to get the user for
-	 * @param string $value the value to get the user for
-	 * @return array of user IDs
-	 */
-	public function getUsersForUserValue($appName, $key, $value) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$sql  = 'SELECT `userid` FROM `*PREFIX*preferences` ' .
-				'WHERE `appid` = ? AND `configkey` = ? ';
-
-		if($this->getSystemValue('dbtype', 'sqlite') === 'oci') {
-			//oracle hack: need to explicitly cast CLOB to CHAR for comparison
-			$sql .= 'AND to_char(`configvalue`) = ?';
-		} else {
-			$sql .= 'AND `configvalue` = ?';
-		}
-
-		$result = $this->connection->executeQuery($sql, array($appName, $key, $value));
-
-		$userIDs = array();
-		while ($row = $result->fetch()) {
-			$userIDs[] = $row['userid'];
-		}
-
-		return $userIDs;
-	}
-
-	public function getSystemConfig() {
-		return $this->systemConfig;
-	}
+    /** @var SystemConfig */
+    private $systemConfig;
+
+    /** @var IDBConnection */
+    private $connection;
+
+    /**
+     * 3 dimensional array with the following structure:
+     * [ $userId =>
+     *     [ $appId =>
+     *         [ $key => $value ]
+     *     ]
+     * ]
+     *
+     * database table: preferences
+     *
+     * methods that use this:
+     *   - setUserValue
+     *   - getUserValue
+     *   - getUserKeys
+     *   - deleteUserValue
+     *   - deleteAllUserValues
+     *   - deleteAppFromAllUsers
+     *
+     * @var CappedMemoryCache $userCache
+     */
+    private $userCache;
+
+    /**
+     * @param SystemConfig $systemConfig
+     */
+    public function __construct(SystemConfig $systemConfig) {
+        $this->userCache = new CappedMemoryCache();
+        $this->systemConfig = $systemConfig;
+    }
+
+    /**
+     * TODO - FIXME This fixes an issue with base.php that cause cyclic
+     * dependencies, especially with autoconfig setup
+     *
+     * Replace this by properly injected database connection. Currently the
+     * base.php triggers the getDatabaseConnection too early which causes in
+     * autoconfig setup case a too early distributed database connection and
+     * the autoconfig then needs to reinit all already initialized dependencies
+     * that use the database connection.
+     *
+     * otherwise a SQLite database is created in the wrong directory
+     * because the database connection was created with an uninitialized config
+     */
+    private function fixDIInit() {
+        if($this->connection === null) {
+            $this->connection = \OC::$server->getDatabaseConnection();
+        }
+    }
+
+    /**
+     * Sets and deletes system wide values
+     *
+     * @param array $configs Associative array with `key => value` pairs
+     *                       If value is null, the config key will be deleted
+     */
+    public function setSystemValues(array $configs) {
+        $this->systemConfig->setValues($configs);
+    }
+
+    /**
+     * Sets a new system wide value
+     *
+     * @param string $key the key of the value, under which will be saved
+     * @param mixed $value the value that should be stored
+     */
+    public function setSystemValue($key, $value) {
+        $this->systemConfig->setValue($key, $value);
+    }
+
+    /**
+     * Looks up a system wide defined value
+     *
+     * @param string $key the key of the value, under which it was saved
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return mixed the value or $default
+     */
+    public function getSystemValue($key, $default = '') {
+        return $this->systemConfig->getValue($key, $default);
+    }
+
+    /**
+     * Looks up a system wide defined value and filters out sensitive data
+     *
+     * @param string $key the key of the value, under which it was saved
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return mixed the value or $default
+     */
+    public function getFilteredSystemValue($key, $default = '') {
+        return $this->systemConfig->getFilteredValue($key, $default);
+    }
+
+    /**
+     * Delete a system wide defined value
+     *
+     * @param string $key the key of the value, under which it was saved
+     */
+    public function deleteSystemValue($key) {
+        $this->systemConfig->deleteValue($key);
+    }
+
+    /**
+     * Get all keys stored for an app
+     *
+     * @param string $appName the appName that we stored the value under
+     * @return string[] the keys stored for the app
+     */
+    public function getAppKeys($appName) {
+        return \OC::$server->getAppConfig()->getKeys($appName);
+    }
+
+    /**
+     * Writes a new app wide value
+     *
+     * @param string $appName the appName that we want to store the value under
+     * @param string $key the key of the value, under which will be saved
+     * @param string|float|int $value the value that should be stored
+     */
+    public function setAppValue($appName, $key, $value) {
+        \OC::$server->getAppConfig()->setValue($appName, $key, $value);
+    }
+
+    /**
+     * Looks up an app wide defined value
+     *
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key of the value, under which it was saved
+     * @param string $default the default value to be returned if the value isn't set
+     * @return string the saved value
+     */
+    public function getAppValue($appName, $key, $default = '') {
+        return \OC::$server->getAppConfig()->getValue($appName, $key, $default);
+    }
+
+    /**
+     * Delete an app wide defined value
+     *
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key of the value, under which it was saved
+     */
+    public function deleteAppValue($appName, $key) {
+        \OC::$server->getAppConfig()->deleteKey($appName, $key);
+    }
+
+    /**
+     * Removes all keys in appconfig belonging to the app
+     *
+     * @param string $appName the appName the configs are stored under
+     */
+    public function deleteAppValues($appName) {
+        \OC::$server->getAppConfig()->deleteApp($appName);
+    }
+
+
+    /**
+     * Set a user defined value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we want to store the value under
+     * @param string $key the key under which the value is being stored
+     * @param string|float|int $value the value that you want to store
+     * @param string $preCondition only update if the config value was previously the value passed as $preCondition
+     * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
+     * @throws \UnexpectedValueException when trying to store an unexpected value
+     */
+    public function setUserValue($userId, $appName, $key, $value, $preCondition = null) {
+        if (!is_int($value) && !is_float($value) && !is_string($value)) {
+            throw new \UnexpectedValueException('Only integers, floats and strings are allowed as value');
+        }
+
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $prevValue = $this->getUserValue($userId, $appName, $key, null);
+
+        if ($prevValue !== null) {
+            if ($prevValue === (string)$value) {
+                return;
+            } else if ($preCondition !== null && $prevValue !== (string)$preCondition) {
+                throw new PreConditionNotMetException();
+            } else {
+                $qb = $this->connection->getQueryBuilder();
+                $qb->update('preferences')
+                    ->set('configvalue', $qb->createNamedParameter($value))
+                    ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId)))
+                    ->andWhere($qb->expr()->eq('appid', $qb->createNamedParameter($appName)))
+                    ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key)));
+                $qb->execute();
+
+                $this->userCache[$userId][$appName][$key] = $value;
+                return;
+            }
+        }
+
+        $preconditionArray = [];
+        if (isset($preCondition)) {
+            $preconditionArray = [
+                'configvalue' => $preCondition,
+            ];
+        }
+
+        $this->connection->setValues('preferences', [
+            'userid' => $userId,
+            'appid' => $appName,
+            'configkey' => $key,
+        ], [
+            'configvalue' => $value,
+        ], $preconditionArray);
+
+        // only add to the cache if we already loaded data for the user
+        if (isset($this->userCache[$userId])) {
+            if (!isset($this->userCache[$userId][$appName])) {
+                $this->userCache[$userId][$appName] = array();
+            }
+            $this->userCache[$userId][$appName][$key] = $value;
+        }
+    }
+
+    /**
+     * Getting a user defined value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key under which the value is being stored
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return string
+     */
+    public function getUserValue($userId, $appName, $key, $default = '') {
+        $data = $this->getUserValues($userId);
+        if (isset($data[$appName]) and isset($data[$appName][$key])) {
+            return $data[$appName][$key];
+        } else {
+            return $default;
+        }
+    }
+
+    /**
+     * Get the keys of all stored by an app for the user
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @return string[]
+     */
+    public function getUserKeys($userId, $appName) {
+        $data = $this->getUserValues($userId);
+        if (isset($data[$appName])) {
+            return array_keys($data[$appName]);
+        } else {
+            return array();
+        }
+    }
+
+    /**
+     * Delete a user value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key under which the value is being stored
+     */
+    public function deleteUserValue($userId, $appName, $key) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $sql  = 'DELETE FROM `*PREFIX*preferences` '.
+                'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
+        $this->connection->executeUpdate($sql, array($userId, $appName, $key));
+
+        if (isset($this->userCache[$userId]) and isset($this->userCache[$userId][$appName])) {
+            unset($this->userCache[$userId][$appName][$key]);
+        }
+    }
+
+    /**
+     * Delete all user values
+     *
+     * @param string $userId the userId of the user that we want to remove all values from
+     */
+    public function deleteAllUserValues($userId) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $sql  = 'DELETE FROM `*PREFIX*preferences` '.
+            'WHERE `userid` = ?';
+        $this->connection->executeUpdate($sql, array($userId));
+
+        unset($this->userCache[$userId]);
+    }
+
+    /**
+     * Delete all user related values of one app
+     *
+     * @param string $appName the appName of the app that we want to remove all values from
+     */
+    public function deleteAppFromAllUsers($appName) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $sql  = 'DELETE FROM `*PREFIX*preferences` '.
+                'WHERE `appid` = ?';
+        $this->connection->executeUpdate($sql, array($appName));
+
+        foreach ($this->userCache as &$userCache) {
+            unset($userCache[$appName]);
+        }
+    }
+
+    /**
+     * Returns all user configs sorted by app of one user
+     *
+     * @param string $userId the user ID to get the app configs from
+     * @return array[] - 2 dimensional array with the following structure:
+     *     [ $appId =>
+     *         [ $key => $value ]
+     *     ]
+     */
+    private function getUserValues($userId) {
+        if (isset($this->userCache[$userId])) {
+            return $this->userCache[$userId];
+        }
+        if ($userId === null || $userId === '') {
+            $this->userCache[$userId]=array();
+            return $this->userCache[$userId];
+        }
+
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $data = array();
+        $query = 'SELECT `appid`, `configkey`, `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?';
+        $result = $this->connection->executeQuery($query, array($userId));
+        while ($row = $result->fetch()) {
+            $appId = $row['appid'];
+            if (!isset($data[$appId])) {
+                $data[$appId] = array();
+            }
+            $data[$appId][$row['configkey']] = $row['configvalue'];
+        }
+        $this->userCache[$userId] = $data;
+        return $data;
+    }
+
+    /**
+     * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs.
+     *
+     * @param string $appName app to get the value for
+     * @param string $key the key to get the value for
+     * @param array $userIds the user IDs to fetch the values for
+     * @return array Mapped values: userId => value
+     */
+    public function getUserValueForUsers($appName, $key, $userIds) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        if (empty($userIds) || !is_array($userIds)) {
+            return array();
+        }
+
+        $chunkedUsers = array_chunk($userIds, 50, true);
+        $placeholders50 = implode(',', array_fill(0, 50, '?'));
+
+        $userValues = array();
+        foreach ($chunkedUsers as $chunk) {
+            $queryParams = $chunk;
+            // create [$app, $key, $chunkedUsers]
+            array_unshift($queryParams, $key);
+            array_unshift($queryParams, $appName);
+
+            $placeholders = (count($chunk) === 50) ? $placeholders50 :  implode(',', array_fill(0, count($chunk), '?'));
+
+            $query    = 'SELECT `userid`, `configvalue` ' .
+                        'FROM `*PREFIX*preferences` ' .
+                        'WHERE `appid` = ? AND `configkey` = ? ' .
+                        'AND `userid` IN (' . $placeholders . ')';
+            $result = $this->connection->executeQuery($query, $queryParams);
+
+            while ($row = $result->fetch()) {
+                $userValues[$row['userid']] = $row['configvalue'];
+            }
+        }
+
+        return $userValues;
+    }
+
+    /**
+     * Determines the users that have the given value set for a specific app-key-pair
+     *
+     * @param string $appName the app to get the user for
+     * @param string $key the key to get the user for
+     * @param string $value the value to get the user for
+     * @return array of user IDs
+     */
+    public function getUsersForUserValue($appName, $key, $value) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $sql  = 'SELECT `userid` FROM `*PREFIX*preferences` ' .
+                'WHERE `appid` = ? AND `configkey` = ? ';
+
+        if($this->getSystemValue('dbtype', 'sqlite') === 'oci') {
+            //oracle hack: need to explicitly cast CLOB to CHAR for comparison
+            $sql .= 'AND to_char(`configvalue`) = ?';
+        } else {
+            $sql .= 'AND `configvalue` = ?';
+        }
+
+        $result = $this->connection->executeQuery($sql, array($appName, $key, $value));
+
+        $userIDs = array();
+        while ($row = $result->fetch()) {
+            $userIDs[] = $row['userid'];
+        }
+
+        return $userIDs;
+    }
+
+    public function getSystemConfig() {
+        return $this->systemConfig;
+    }
 }

Spacing +14 added lines, -14 removed lines

@@ -87,7 +87,7 @@ 
 	 * because the database connection was created with an uninitialized config
 	 */
 	private function fixDIInit() {
-		if($this->connection === null) {
+		if ($this->connection === null) {
 			$this->connection = \OC::$server->getDatabaseConnection();
 		}
 	}
@@ -218,9 +218,9 @@ 
 		$prevValue = $this->getUserValue($userId, $appName, $key, null);
 
 		if ($prevValue !== null) {
-			if ($prevValue === (string)$value) {
+			if ($prevValue === (string) $value) {
 				return;
-			} else if ($preCondition !== null && $prevValue !== (string)$preCondition) {
+			} else if ($preCondition !== null && $prevValue !== (string) $preCondition) {
 				throw new PreConditionNotMetException();
 			} else {
 				$qb = $this->connection->getQueryBuilder();
@@ -305,7 +305,7 @@ 
 		// TODO - FIXME
 		$this->fixDIInit();
 
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
+		$sql = 'DELETE FROM `*PREFIX*preferences` '.
 				'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
 		$this->connection->executeUpdate($sql, array($userId, $appName, $key));
 
@@ -323,7 +323,7 @@ 
 		// TODO - FIXME
 		$this->fixDIInit();
 
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
+		$sql = 'DELETE FROM `*PREFIX*preferences` '.
 			'WHERE `userid` = ?';
 		$this->connection->executeUpdate($sql, array($userId));
 
@@ -339,7 +339,7 @@ 
 		// TODO - FIXME
 		$this->fixDIInit();
 
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
+		$sql = 'DELETE FROM `*PREFIX*preferences` '.
 				'WHERE `appid` = ?';
 		$this->connection->executeUpdate($sql, array($appName));
 
@@ -362,7 +362,7 @@ 
 			return $this->userCache[$userId];
 		}
 		if ($userId === null || $userId === '') {
-			$this->userCache[$userId]=array();
+			$this->userCache[$userId] = array();
 			return $this->userCache[$userId];
 		}
 
@@ -409,12 +409,12 @@ 
 			array_unshift($queryParams, $key);
 			array_unshift($queryParams, $appName);
 
-			$placeholders = (count($chunk) === 50) ? $placeholders50 :  implode(',', array_fill(0, count($chunk), '?'));
+			$placeholders = (count($chunk) === 50) ? $placeholders50 : implode(',', array_fill(0, count($chunk), '?'));
 
-			$query    = 'SELECT `userid`, `configvalue` ' .
-						'FROM `*PREFIX*preferences` ' .
-						'WHERE `appid` = ? AND `configkey` = ? ' .
-						'AND `userid` IN (' . $placeholders . ')';
+			$query = 'SELECT `userid`, `configvalue` '.
+						'FROM `*PREFIX*preferences` '.
+						'WHERE `appid` = ? AND `configkey` = ? '.
+						'AND `userid` IN ('.$placeholders.')';
 			$result = $this->connection->executeQuery($query, $queryParams);
 
 			while ($row = $result->fetch()) {
@@ -437,10 +437,10 @@ 
 		// TODO - FIXME
 		$this->fixDIInit();
 
-		$sql  = 'SELECT `userid` FROM `*PREFIX*preferences` ' .
+		$sql = 'SELECT `userid` FROM `*PREFIX*preferences` '.
 				'WHERE `appid` = ? AND `configkey` = ? ';
 
-		if($this->getSystemValue('dbtype', 'sqlite') === 'oci') {
+		if ($this->getSystemValue('dbtype', 'sqlite') === 'oci') {
 			//oracle hack: need to explicitly cast CLOB to CHAR for comparison
 			$sql .= 'AND to_char(`configvalue`) = ?';
 		} else {

lib/private/App/CodeChecker/NodeVisitor.php

Doc Comments +3 added lines

@@ -296,6 +296,9 @@
 		}
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private function buildReason($name, $errorCode) {
 		if (isset($this->errorMessages[$errorCode])) {
 			$desc = $this->list->getDescription($errorCode, $name);

Indentation +276 added lines, -276 removed lines

@@ -29,280 +29,280 @@
 use PhpParser\NodeVisitorAbstract;
 
 class NodeVisitor extends NodeVisitorAbstract {
-	/** @var ICheck */
-	protected $list;
-
-	/** @var string */
-	protected $blackListDescription;
-	/** @var string[] */
-	protected $blackListedClassNames;
-	/** @var string[] */
-	protected $blackListedConstants;
-	/** @var string[] */
-	protected $blackListedFunctions;
-	/** @var string[] */
-	protected $blackListedMethods;
-	/** @var bool */
-	protected $checkEqualOperatorUsage;
-	/** @var string[] */
-	protected $errorMessages;
-
-	/**
-	 * @param ICheck $list
-	 */
-	public function __construct(ICheck $list) {
-		$this->list = $list;
-
-		$this->blackListedClassNames = [];
-		foreach ($list->getClasses() as $class => $blackListInfo) {
-			if (is_numeric($class) && is_string($blackListInfo)) {
-				$class = $blackListInfo;
-				$blackListInfo = null;
-			}
-
-			$class = strtolower($class);
-			$this->blackListedClassNames[$class] = $class;
-		}
-
-		$this->blackListedConstants = [];
-		foreach ($list->getConstants() as $constantName => $blackListInfo) {
-			$constantName = strtolower($constantName);
-			$this->blackListedConstants[$constantName] = $constantName;
-		}
-
-		$this->blackListedFunctions = [];
-		foreach ($list->getFunctions() as $functionName => $blackListInfo) {
-			$functionName = strtolower($functionName);
-			$this->blackListedFunctions[$functionName] = $functionName;
-		}
-
-		$this->blackListedMethods = [];
-		foreach ($list->getMethods() as $functionName => $blackListInfo) {
-			$functionName = strtolower($functionName);
-			$this->blackListedMethods[$functionName] = $functionName;
-		}
-
-		$this->checkEqualOperatorUsage = $list->checkStrongComparisons();
-
-		$this->errorMessages = [
-			CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended",
-			CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented",
-			CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called",
-			CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched",
-			CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated",
-			CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement",
-			CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called",
-
-			CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged",
-		];
-	}
-
-	/** @var array */
-	public $errors = [];
-
-	public function enterNode(Node $node) {
-		if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) {
-			$this->errors[]= [
-				'disallowedToken' => '==',
-				'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED)
-			];
-		}
-		if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) {
-			$this->errors[]= [
-				'disallowedToken' => '!=',
-				'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED)
-			];
-		}
-		if ($node instanceof Node\Stmt\Class_) {
-			if (!is_null($node->extends)) {
-				$this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node);
-			}
-			foreach ($node->implements as $implements) {
-				$this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node);
-			}
-		}
-		if ($node instanceof Node\Expr\StaticCall) {
-			if (!is_null($node->class)) {
-				if ($node->class instanceof Name) {
-					$this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node);
-
-					$this->checkBlackListFunction($node->class->toString(), $node->name, $node);
-					$this->checkBlackListMethod($node->class->toString(), $node->name, $node);
-				}
-
-				if ($node->class instanceof Node\Expr\Variable) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = "OC_API";
-					 *       $n = $c::call();
-					 */
-					// $this->checkBlackListMethod($node->class->..., $node->name, $node);
-				}
-			}
-		}
-		if ($node instanceof Node\Expr\MethodCall) {
-			if (!is_null($node->var)) {
-				if ($node->var instanceof Node\Expr\Variable) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = new OC_API();
-					 *       $n = $c::call();
-					 *       $n = $c->call();
-					 */
-					// $this->checkBlackListMethod($node->var->..., $node->name, $node);
-				}
-			}
-		}
-		if ($node instanceof Node\Expr\ClassConstFetch) {
-			if (!is_null($node->class)) {
-				if ($node->class instanceof Name) {
-					$this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node);
-				}
-				if ($node->class instanceof Node\Expr\Variable) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = "OC_API";
-					 *       $n = $i::ADMIN_AUTH;
-					 */
-				} else {
-					$this->checkBlackListConstant($node->class->toString(), $node->name, $node);
-				}
-			}
-		}
-		if ($node instanceof Node\Expr\New_) {
-			if (!is_null($node->class)) {
-				if ($node->class instanceof Name) {
-					$this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_NOT_ALLOWED, $node);
-				}
-				if ($node->class instanceof Node\Expr\Variable) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = "OC_API";
-					 *       $n = new $i;
-					 */
-				}
-			}
-		}
-		if ($node instanceof Node\Stmt\UseUse) {
-			$this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node);
-			if ($node->alias) {
-				$this->addUseNameToBlackList($node->name->toString(), $node->alias);
-			} else {
-				$this->addUseNameToBlackList($node->name->toString(), $node->name->getLast());
-			}
-		}
-	}
-
-	/**
-	 * Check whether an alias was introduced for a namespace of a blacklisted class
-	 *
-	 * Example:
-	 * - Blacklist entry:      OCP\AppFramework\IApi
-	 * - Name:                 OCP\AppFramework
-	 * - Alias:                OAF
-	 * =>  new blacklist entry:  OAF\IApi
-	 *
-	 * @param string $name
-	 * @param string $alias
-	 */
-	private function addUseNameToBlackList($name, $alias) {
-		$name = strtolower($name);
-		$alias = strtolower($alias);
-
-		foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) {
-			if (strpos($blackListedClassName, $name . '\\') === 0) {
-				$aliasedClassName = str_replace($name, $alias, $blackListedClassName);
-				$this->blackListedClassNames[$aliasedClassName] = $blackListedClassName;
-			}
-		}
-
-		foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) {
-			if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) {
-				$aliasedConstantName = str_replace($name, $alias, $blackListedConstant);
-				$this->blackListedConstants[$aliasedConstantName] = $blackListedConstant;
-			}
-		}
-
-		foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) {
-			if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) {
-				$aliasedFunctionName = str_replace($name, $alias, $blackListedFunction);
-				$this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction;
-			}
-		}
-
-		foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) {
-			if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) {
-				$aliasedMethodName = str_replace($name, $alias, $blackListedMethod);
-				$this->blackListedMethods[$aliasedMethodName] = $blackListedMethod;
-			}
-		}
-	}
-
-	private function checkBlackList($name, $errorCode, Node $node) {
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedClassNames[$lowerName])) {
-			$this->errors[]= [
-				'disallowedToken' => $name,
-				'errorCode' => $errorCode,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode)
-			];
-		}
-	}
-
-	private function checkBlackListConstant($class, $constantName, Node $node) {
-		$name = $class . '::' . $constantName;
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedConstants[$lowerName])) {
-			$this->errors[]= [
-				'disallowedToken' => $name,
-				'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED)
-			];
-		}
-	}
-
-	private function checkBlackListFunction($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedFunctions[$lowerName])) {
-			$this->errors[]= [
-				'disallowedToken' => $name,
-				'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED)
-			];
-		}
-	}
-
-	private function checkBlackListMethod($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedMethods[$lowerName])) {
-			$this->errors[]= [
-				'disallowedToken' => $name,
-				'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED)
-			];
-		}
-	}
-
-	private function buildReason($name, $errorCode) {
-		if (isset($this->errorMessages[$errorCode])) {
-			$desc = $this->list->getDescription($errorCode, $name);
-			return sprintf($this->errorMessages[$errorCode], $desc);
-		}
-
-		return "$name usage not allowed - error: $errorCode";
-	}
+    /** @var ICheck */
+    protected $list;
+
+    /** @var string */
+    protected $blackListDescription;
+    /** @var string[] */
+    protected $blackListedClassNames;
+    /** @var string[] */
+    protected $blackListedConstants;
+    /** @var string[] */
+    protected $blackListedFunctions;
+    /** @var string[] */
+    protected $blackListedMethods;
+    /** @var bool */
+    protected $checkEqualOperatorUsage;
+    /** @var string[] */
+    protected $errorMessages;
+
+    /**
+     * @param ICheck $list
+     */
+    public function __construct(ICheck $list) {
+        $this->list = $list;
+
+        $this->blackListedClassNames = [];
+        foreach ($list->getClasses() as $class => $blackListInfo) {
+            if (is_numeric($class) && is_string($blackListInfo)) {
+                $class = $blackListInfo;
+                $blackListInfo = null;
+            }
+
+            $class = strtolower($class);
+            $this->blackListedClassNames[$class] = $class;
+        }
+
+        $this->blackListedConstants = [];
+        foreach ($list->getConstants() as $constantName => $blackListInfo) {
+            $constantName = strtolower($constantName);
+            $this->blackListedConstants[$constantName] = $constantName;
+        }
+
+        $this->blackListedFunctions = [];
+        foreach ($list->getFunctions() as $functionName => $blackListInfo) {
+            $functionName = strtolower($functionName);
+            $this->blackListedFunctions[$functionName] = $functionName;
+        }
+
+        $this->blackListedMethods = [];
+        foreach ($list->getMethods() as $functionName => $blackListInfo) {
+            $functionName = strtolower($functionName);
+            $this->blackListedMethods[$functionName] = $functionName;
+        }
+
+        $this->checkEqualOperatorUsage = $list->checkStrongComparisons();
+
+        $this->errorMessages = [
+            CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended",
+            CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented",
+            CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called",
+            CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched",
+            CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated",
+            CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement",
+            CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called",
+
+            CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged",
+        ];
+    }
+
+    /** @var array */
+    public $errors = [];
+
+    public function enterNode(Node $node) {
+        if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) {
+            $this->errors[]= [
+                'disallowedToken' => '==',
+                'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED)
+            ];
+        }
+        if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) {
+            $this->errors[]= [
+                'disallowedToken' => '!=',
+                'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED)
+            ];
+        }
+        if ($node instanceof Node\Stmt\Class_) {
+            if (!is_null($node->extends)) {
+                $this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node);
+            }
+            foreach ($node->implements as $implements) {
+                $this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node);
+            }
+        }
+        if ($node instanceof Node\Expr\StaticCall) {
+            if (!is_null($node->class)) {
+                if ($node->class instanceof Name) {
+                    $this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node);
+
+                    $this->checkBlackListFunction($node->class->toString(), $node->name, $node);
+                    $this->checkBlackListMethod($node->class->toString(), $node->name, $node);
+                }
+
+                if ($node->class instanceof Node\Expr\Variable) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = "OC_API";
+                     *       $n = $c::call();
+                     */
+                    // $this->checkBlackListMethod($node->class->..., $node->name, $node);
+                }
+            }
+        }
+        if ($node instanceof Node\Expr\MethodCall) {
+            if (!is_null($node->var)) {
+                if ($node->var instanceof Node\Expr\Variable) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = new OC_API();
+                     *       $n = $c::call();
+                     *       $n = $c->call();
+                     */
+                    // $this->checkBlackListMethod($node->var->..., $node->name, $node);
+                }
+            }
+        }
+        if ($node instanceof Node\Expr\ClassConstFetch) {
+            if (!is_null($node->class)) {
+                if ($node->class instanceof Name) {
+                    $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node);
+                }
+                if ($node->class instanceof Node\Expr\Variable) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = "OC_API";
+                     *       $n = $i::ADMIN_AUTH;
+                     */
+                } else {
+                    $this->checkBlackListConstant($node->class->toString(), $node->name, $node);
+                }
+            }
+        }
+        if ($node instanceof Node\Expr\New_) {
+            if (!is_null($node->class)) {
+                if ($node->class instanceof Name) {
+                    $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_NOT_ALLOWED, $node);
+                }
+                if ($node->class instanceof Node\Expr\Variable) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = "OC_API";
+                     *       $n = new $i;
+                     */
+                }
+            }
+        }
+        if ($node instanceof Node\Stmt\UseUse) {
+            $this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node);
+            if ($node->alias) {
+                $this->addUseNameToBlackList($node->name->toString(), $node->alias);
+            } else {
+                $this->addUseNameToBlackList($node->name->toString(), $node->name->getLast());
+            }
+        }
+    }
+
+    /**
+     * Check whether an alias was introduced for a namespace of a blacklisted class
+     *
+     * Example:
+     * - Blacklist entry:      OCP\AppFramework\IApi
+     * - Name:                 OCP\AppFramework
+     * - Alias:                OAF
+     * =>  new blacklist entry:  OAF\IApi
+     *
+     * @param string $name
+     * @param string $alias
+     */
+    private function addUseNameToBlackList($name, $alias) {
+        $name = strtolower($name);
+        $alias = strtolower($alias);
+
+        foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) {
+            if (strpos($blackListedClassName, $name . '\\') === 0) {
+                $aliasedClassName = str_replace($name, $alias, $blackListedClassName);
+                $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName;
+            }
+        }
+
+        foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) {
+            if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) {
+                $aliasedConstantName = str_replace($name, $alias, $blackListedConstant);
+                $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant;
+            }
+        }
+
+        foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) {
+            if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) {
+                $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction);
+                $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction;
+            }
+        }
+
+        foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) {
+            if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) {
+                $aliasedMethodName = str_replace($name, $alias, $blackListedMethod);
+                $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod;
+            }
+        }
+    }
+
+    private function checkBlackList($name, $errorCode, Node $node) {
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedClassNames[$lowerName])) {
+            $this->errors[]= [
+                'disallowedToken' => $name,
+                'errorCode' => $errorCode,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode)
+            ];
+        }
+    }
+
+    private function checkBlackListConstant($class, $constantName, Node $node) {
+        $name = $class . '::' . $constantName;
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedConstants[$lowerName])) {
+            $this->errors[]= [
+                'disallowedToken' => $name,
+                'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED)
+            ];
+        }
+    }
+
+    private function checkBlackListFunction($class, $functionName, Node $node) {
+        $name = $class . '::' . $functionName;
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedFunctions[$lowerName])) {
+            $this->errors[]= [
+                'disallowedToken' => $name,
+                'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED)
+            ];
+        }
+    }
+
+    private function checkBlackListMethod($class, $functionName, Node $node) {
+        $name = $class . '::' . $functionName;
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedMethods[$lowerName])) {
+            $this->errors[]= [
+                'disallowedToken' => $name,
+                'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED)
+            ];
+        }
+    }
+
+    private function buildReason($name, $errorCode) {
+        if (isset($this->errorMessages[$errorCode])) {
+            $desc = $this->list->getDescription($errorCode, $name);
+            return sprintf($this->errorMessages[$errorCode], $desc);
+        }
+
+        return "$name usage not allowed - error: $errorCode";
+    }
 }

Spacing +13 added lines, -13 removed lines

@@ -102,7 +102,7 @@ 
 
 	public function enterNode(Node $node) {
 		if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => '==',
 				'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
 				'line' => $node->getLine(),
@@ -110,7 +110,7 @@ 
 			];
 		}
 		if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => '!=',
 				'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
 				'line' => $node->getLine(),
@@ -214,28 +214,28 @@ 
 		$alias = strtolower($alias);
 
 		foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) {
-			if (strpos($blackListedClassName, $name . '\\') === 0) {
+			if (strpos($blackListedClassName, $name.'\\') === 0) {
 				$aliasedClassName = str_replace($name, $alias, $blackListedClassName);
 				$this->blackListedClassNames[$aliasedClassName] = $blackListedClassName;
 			}
 		}
 
 		foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) {
-			if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) {
+			if (strpos($blackListedConstant, $name.'\\') === 0 || strpos($blackListedConstant, $name.'::') === 0) {
 				$aliasedConstantName = str_replace($name, $alias, $blackListedConstant);
 				$this->blackListedConstants[$aliasedConstantName] = $blackListedConstant;
 			}
 		}
 
 		foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) {
-			if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) {
+			if (strpos($blackListedFunction, $name.'\\') === 0 || strpos($blackListedFunction, $name.'::') === 0) {
 				$aliasedFunctionName = str_replace($name, $alias, $blackListedFunction);
 				$this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction;
 			}
 		}
 
 		foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) {
-			if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) {
+			if (strpos($blackListedMethod, $name.'\\') === 0 || strpos($blackListedMethod, $name.'::') === 0) {
 				$aliasedMethodName = str_replace($name, $alias, $blackListedMethod);
 				$this->blackListedMethods[$aliasedMethodName] = $blackListedMethod;
 			}
@@ -246,7 +246,7 @@ 
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedClassNames[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => $errorCode,
 				'line' => $node->getLine(),
@@ -256,11 +256,11 @@ 
 	}
 
 	private function checkBlackListConstant($class, $constantName, Node $node) {
-		$name = $class . '::' . $constantName;
+		$name = $class.'::'.$constantName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedConstants[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED,
 				'line' => $node->getLine(),
@@ -270,11 +270,11 @@ 
 	}
 
 	private function checkBlackListFunction($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
+		$name = $class.'::'.$functionName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedFunctions[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED,
 				'line' => $node->getLine(),
@@ -284,11 +284,11 @@ 
 	}
 
 	private function checkBlackListMethod($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
+		$name = $class.'::'.$functionName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedMethods[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED,
 				'line' => $node->getLine(),

lib/private/Comments/Manager.php

Doc Comments +1 added lines, -1 removed lines

@@ -205,7 +205,7 @@
 	/**
 	 * removes an entry from the comments run time cache
 	 *
-	 * @param mixed $id the comment's id
+	 * @param string $id the comment's id
 	 */
 	protected function uncache($id) {
 		$id = strval($id);

Indentation +846 added lines, -846 removed lines

@@ -38,850 +38,850 @@
 
 class Manager implements ICommentsManager {
 
-	/** @var  IDBConnection */
-	protected $dbConn;
-
-	/** @var  ILogger */
-	protected $logger;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IComment[] */
-	protected $commentsCache = [];
-
-	/** @var  \Closure[] */
-	protected $eventHandlerClosures = [];
-
-	/** @var  ICommentsEventHandler[] */
-	protected $eventHandlers = [];
-
-	/** @var \Closure[] */
-	protected $displayNameResolvers = [];
-
-	/**
-	 * Manager constructor.
-	 *
-	 * @param IDBConnection $dbConn
-	 * @param ILogger $logger
-	 * @param IConfig $config
-	 */
-	public function __construct(
-		IDBConnection $dbConn,
-		ILogger $logger,
-		IConfig $config
-	) {
-		$this->dbConn = $dbConn;
-		$this->logger = $logger;
-		$this->config = $config;
-	}
-
-	/**
-	 * converts data base data into PHP native, proper types as defined by
-	 * IComment interface.
-	 *
-	 * @param array $data
-	 * @return array
-	 */
-	protected function normalizeDatabaseData(array $data) {
-		$data['id'] = strval($data['id']);
-		$data['parent_id'] = strval($data['parent_id']);
-		$data['topmost_parent_id'] = strval($data['topmost_parent_id']);
-		$data['creation_timestamp'] = new \DateTime($data['creation_timestamp']);
-		if (!is_null($data['latest_child_timestamp'])) {
-			$data['latest_child_timestamp'] = new \DateTime($data['latest_child_timestamp']);
-		}
-		$data['children_count'] = intval($data['children_count']);
-		return $data;
-	}
-
-	/**
-	 * prepares a comment for an insert or update operation after making sure
-	 * all necessary fields have a value assigned.
-	 *
-	 * @param IComment $comment
-	 * @return IComment returns the same updated IComment instance as provided
-	 *                  by parameter for convenience
-	 * @throws \UnexpectedValueException
-	 */
-	protected function prepareCommentForDatabaseWrite(IComment $comment) {
-		if (!$comment->getActorType()
-			|| !$comment->getActorId()
-			|| !$comment->getObjectType()
-			|| !$comment->getObjectId()
-			|| !$comment->getVerb()
-		) {
-			throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
-		}
-
-		if ($comment->getId() === '') {
-			$comment->setChildrenCount(0);
-			$comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
-			$comment->setLatestChildDateTime(null);
-		}
-
-		if (is_null($comment->getCreationDateTime())) {
-			$comment->setCreationDateTime(new \DateTime());
-		}
-
-		if ($comment->getParentId() !== '0') {
-			$comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
-		} else {
-			$comment->setTopmostParentId('0');
-		}
-
-		$this->cache($comment);
-
-		return $comment;
-	}
-
-	/**
-	 * returns the topmost parent id of a given comment identified by ID
-	 *
-	 * @param string $id
-	 * @return string
-	 * @throws NotFoundException
-	 */
-	protected function determineTopmostParentId($id) {
-		$comment = $this->get($id);
-		if ($comment->getParentId() === '0') {
-			return $comment->getId();
-		} else {
-			return $this->determineTopmostParentId($comment->getId());
-		}
-	}
-
-	/**
-	 * updates child information of a comment
-	 *
-	 * @param string $id
-	 * @param \DateTime $cDateTime the date time of the most recent child
-	 * @throws NotFoundException
-	 */
-	protected function updateChildrenInformation($id, \DateTime $cDateTime) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select($qb->createFunction('COUNT(`id`)'))
-			->from('comments')
-			->where($qb->expr()->eq('parent_id', $qb->createParameter('id')))
-			->setParameter('id', $id);
-
-		$resultStatement = $query->execute();
-		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
-		$resultStatement->closeCursor();
-		$children = intval($data[0]);
-
-		$comment = $this->get($id);
-		$comment->setChildrenCount($children);
-		$comment->setLatestChildDateTime($cDateTime);
-		$this->save($comment);
-	}
-
-	/**
-	 * Tests whether actor or object type and id parameters are acceptable.
-	 * Throws exception if not.
-	 *
-	 * @param string $role
-	 * @param string $type
-	 * @param string $id
-	 * @throws \InvalidArgumentException
-	 */
-	protected function checkRoleParameters($role, $type, $id) {
-		if (
-			!is_string($type) || empty($type)
-			|| !is_string($id) || empty($id)
-		) {
-			throw new \InvalidArgumentException($role . ' parameters must be string and not empty');
-		}
-	}
-
-	/**
-	 * run-time caches a comment
-	 *
-	 * @param IComment $comment
-	 */
-	protected function cache(IComment $comment) {
-		$id = $comment->getId();
-		if (empty($id)) {
-			return;
-		}
-		$this->commentsCache[strval($id)] = $comment;
-	}
-
-	/**
-	 * removes an entry from the comments run time cache
-	 *
-	 * @param mixed $id the comment's id
-	 */
-	protected function uncache($id) {
-		$id = strval($id);
-		if (isset($this->commentsCache[$id])) {
-			unset($this->commentsCache[$id]);
-		}
-	}
-
-	/**
-	 * returns a comment instance
-	 *
-	 * @param string $id the ID of the comment
-	 * @return IComment
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException
-	 * @since 9.0.0
-	 */
-	public function get($id) {
-		if (intval($id) === 0) {
-			throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
-		}
-
-		if (isset($this->commentsCache[$id])) {
-			return $this->commentsCache[$id];
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$resultStatement = $qb->select('*')
-			->from('comments')
-			->where($qb->expr()->eq('id', $qb->createParameter('id')))
-			->setParameter('id', $id, IQueryBuilder::PARAM_INT)
-			->execute();
-
-		$data = $resultStatement->fetch();
-		$resultStatement->closeCursor();
-		if (!$data) {
-			throw new NotFoundException();
-		}
-
-		$comment = new Comment($this->normalizeDatabaseData($data));
-		$this->cache($comment);
-		return $comment;
-	}
-
-	/**
-	 * returns the comment specified by the id and all it's child comments.
-	 * At this point of time, we do only support one level depth.
-	 *
-	 * @param string $id
-	 * @param int $limit max number of entries to return, 0 returns all
-	 * @param int $offset the start entry
-	 * @return array
-	 * @since 9.0.0
-	 *
-	 * The return array looks like this
-	 * [
-	 *   'comment' => IComment, // root comment
-	 *   'replies' =>
-	 *   [
-	 *     0 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies' => []
-	 *     ]
-	 *     1 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies'=> []
-	 *     ],
-	 *     …
-	 *   ]
-	 * ]
-	 */
-	public function getTree($id, $limit = 0, $offset = 0) {
-		$tree = [];
-		$tree['comment'] = $this->get($id);
-		$tree['replies'] = [];
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select('*')
-			->from('comments')
-			->where($qb->expr()->eq('topmost_parent_id', $qb->createParameter('id')))
-			->orderBy('creation_timestamp', 'DESC')
-			->setParameter('id', $id);
-
-		if ($limit > 0) {
-			$query->setMaxResults($limit);
-		}
-		if ($offset > 0) {
-			$query->setFirstResult($offset);
-		}
-
-		$resultStatement = $query->execute();
-		while ($data = $resultStatement->fetch()) {
-			$comment = new Comment($this->normalizeDatabaseData($data));
-			$this->cache($comment);
-			$tree['replies'][] = [
-				'comment' => $comment,
-				'replies' => []
-			];
-		}
-		$resultStatement->closeCursor();
-
-		return $tree;
-	}
-
-	/**
-	 * returns comments for a specific object (e.g. a file).
-	 *
-	 * The sort order is always newest to oldest.
-	 *
-	 * @param string $objectType the object type, e.g. 'files'
-	 * @param string $objectId the id of the object
-	 * @param int $limit optional, number of maximum comments to be returned. if
-	 * not specified, all comments are returned.
-	 * @param int $offset optional, starting point
-	 * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
-	 * that may be returned
-	 * @return IComment[]
-	 * @since 9.0.0
-	 */
-	public function getForObject(
-		$objectType,
-		$objectId,
-		$limit = 0,
-		$offset = 0,
-		\DateTime $notOlderThan = null
-	) {
-		$comments = [];
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select('*')
-			->from('comments')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-			->orderBy('creation_timestamp', 'DESC')
-			->setParameter('type', $objectType)
-			->setParameter('id', $objectId);
-
-		if ($limit > 0) {
-			$query->setMaxResults($limit);
-		}
-		if ($offset > 0) {
-			$query->setFirstResult($offset);
-		}
-		if (!is_null($notOlderThan)) {
-			$query
-				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
-				->setParameter('notOlderThan', $notOlderThan, 'datetime');
-		}
-
-		$resultStatement = $query->execute();
-		while ($data = $resultStatement->fetch()) {
-			$comment = new Comment($this->normalizeDatabaseData($data));
-			$this->cache($comment);
-			$comments[] = $comment;
-		}
-		$resultStatement->closeCursor();
-
-		return $comments;
-	}
-
-	/**
-	 * @param $objectType string the object type, e.g. 'files'
-	 * @param $objectId string the id of the object
-	 * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
-	 * that may be returned
-	 * @return Int
-	 * @since 9.0.0
-	 */
-	public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select($qb->createFunction('COUNT(`id`)'))
-			->from('comments')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-			->setParameter('type', $objectType)
-			->setParameter('id', $objectId);
-
-		if (!is_null($notOlderThan)) {
-			$query
-				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
-				->setParameter('notOlderThan', $notOlderThan, 'datetime');
-		}
-
-		$resultStatement = $query->execute();
-		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
-		$resultStatement->closeCursor();
-		return intval($data[0]);
-	}
-
-	/**
-	 * Get the number of unread comments for all files in a folder
-	 *
-	 * @param int $folderId
-	 * @param IUser $user
-	 * @return array [$fileId => $unreadCount]
-	 */
-	public function getNumberOfUnreadCommentsForFolder($folderId, IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select('f.fileid')
-			->selectAlias(
-				$qb->createFunction('COUNT(' . $qb->getColumnName('c.id') . ')'),
-				'num_ids'
-			)
-			->from('comments', 'c')
-			->innerJoin('c', 'filecache', 'f', $qb->expr()->andX(
-				$qb->expr()->eq('c.object_type', $qb->createNamedParameter('files')),
-				$qb->expr()->eq('f.fileid', $qb->expr()->castColumn('c.object_id', IQueryBuilder::PARAM_INT))
-			))
-			->leftJoin('c', 'comments_read_markers', 'm', $qb->expr()->andX(
-				$qb->expr()->eq('m.object_type', $qb->createNamedParameter('files')),
-				$qb->expr()->eq('m.object_id', 'c.object_id'),
-				$qb->expr()->eq('m.user_id', $qb->createNamedParameter($user->getUID()))
-			))
-			->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($folderId)))
-			->andWhere($qb->expr()->orX(
-				$qb->expr()->gt('c.creation_timestamp', 'marker_datetime'),
-				$qb->expr()->isNull('marker_datetime')
-			))
-			->groupBy('f.fileid');
-
-		$resultStatement = $query->execute();
-
-		$results = [];
-		while ($row = $resultStatement->fetch()) {
-			$results[$row['fileid']] = (int) $row['num_ids'];
-		}
-		$resultStatement->closeCursor();
-		return $results;
-	}
-
-	/**
-	 * creates a new comment and returns it. At this point of time, it is not
-	 * saved in the used data storage. Use save() after setting other fields
-	 * of the comment (e.g. message or verb).
-	 *
-	 * @param string $actorType the actor type (e.g. 'users')
-	 * @param string $actorId a user id
-	 * @param string $objectType the object type the comment is attached to
-	 * @param string $objectId the object id the comment is attached to
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function create($actorType, $actorId, $objectType, $objectId) {
-		$comment = new Comment();
-		$comment
-			->setActor($actorType, $actorId)
-			->setObject($objectType, $objectId);
-		return $comment;
-	}
-
-	/**
-	 * permanently deletes the comment specified by the ID
-	 *
-	 * When the comment has child comments, their parent ID will be changed to
-	 * the parent ID of the item that is to be deleted.
-	 *
-	 * @param string $id
-	 * @return bool
-	 * @throws \InvalidArgumentException
-	 * @since 9.0.0
-	 */
-	public function delete($id) {
-		if (!is_string($id)) {
-			throw new \InvalidArgumentException('Parameter must be string');
-		}
-
-		try {
-			$comment = $this->get($id);
-		} catch (\Exception $e) {
-			// Ignore exceptions, we just don't fire a hook then
-			$comment = null;
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->delete('comments')
-			->where($qb->expr()->eq('id', $qb->createParameter('id')))
-			->setParameter('id', $id);
-
-		try {
-			$affectedRows = $query->execute();
-			$this->uncache($id);
-		} catch (DriverException $e) {
-			$this->logger->logException($e, ['app' => 'core_comments']);
-			return false;
-		}
-
-		if ($affectedRows > 0 && $comment instanceof IComment) {
-			$this->sendEvent(CommentsEvent::EVENT_DELETE, $comment);
-		}
-
-		return ($affectedRows > 0);
-	}
-
-	/**
-	 * saves the comment permanently
-	 *
-	 * if the supplied comment has an empty ID, a new entry comment will be
-	 * saved and the instance updated with the new ID.
-	 *
-	 * Otherwise, an existing comment will be updated.
-	 *
-	 * Throws NotFoundException when a comment that is to be updated does not
-	 * exist anymore at this point of time.
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 * @throws NotFoundException
-	 * @since 9.0.0
-	 */
-	public function save(IComment $comment) {
-		if ($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
-			$result = $this->insert($comment);
-		} else {
-			$result = $this->update($comment);
-		}
-
-		if ($result && !!$comment->getParentId()) {
-			$this->updateChildrenInformation(
-				$comment->getParentId(),
-				$comment->getCreationDateTime()
-			);
-			$this->cache($comment);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * inserts the provided comment in the database
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 */
-	protected function insert(IComment &$comment) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->insert('comments')
-			->values([
-				'parent_id' => $qb->createNamedParameter($comment->getParentId()),
-				'topmost_parent_id' => $qb->createNamedParameter($comment->getTopmostParentId()),
-				'children_count' => $qb->createNamedParameter($comment->getChildrenCount()),
-				'actor_type' => $qb->createNamedParameter($comment->getActorType()),
-				'actor_id' => $qb->createNamedParameter($comment->getActorId()),
-				'message' => $qb->createNamedParameter($comment->getMessage()),
-				'verb' => $qb->createNamedParameter($comment->getVerb()),
-				'creation_timestamp' => $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'),
-				'latest_child_timestamp' => $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'),
-				'object_type' => $qb->createNamedParameter($comment->getObjectType()),
-				'object_id' => $qb->createNamedParameter($comment->getObjectId()),
-			])
-			->execute();
-
-		if ($affectedRows > 0) {
-			$comment->setId(strval($qb->getLastInsertId()));
-			$this->sendEvent(CommentsEvent::EVENT_ADD, $comment);
-		}
-
-		return $affectedRows > 0;
-	}
-
-	/**
-	 * updates a Comment data row
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 * @throws NotFoundException
-	 */
-	protected function update(IComment $comment) {
-		// for properly working preUpdate Events we need the old comments as is
-		// in the DB and overcome caching. Also avoid that outdated information stays.
-		$this->uncache($comment->getId());
-		$this->sendEvent(CommentsEvent::EVENT_PRE_UPDATE, $this->get($comment->getId()));
-		$this->uncache($comment->getId());
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->update('comments')
-			->set('parent_id', $qb->createNamedParameter($comment->getParentId()))
-			->set('topmost_parent_id', $qb->createNamedParameter($comment->getTopmostParentId()))
-			->set('children_count', $qb->createNamedParameter($comment->getChildrenCount()))
-			->set('actor_type', $qb->createNamedParameter($comment->getActorType()))
-			->set('actor_id', $qb->createNamedParameter($comment->getActorId()))
-			->set('message', $qb->createNamedParameter($comment->getMessage()))
-			->set('verb', $qb->createNamedParameter($comment->getVerb()))
-			->set('creation_timestamp', $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
-			->set('latest_child_timestamp', $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
-			->set('object_type', $qb->createNamedParameter($comment->getObjectType()))
-			->set('object_id', $qb->createNamedParameter($comment->getObjectId()))
-			->where($qb->expr()->eq('id', $qb->createParameter('id')))
-			->setParameter('id', $comment->getId())
-			->execute();
-
-		if ($affectedRows === 0) {
-			throw new NotFoundException('Comment to update does ceased to exist');
-		}
-
-		$this->sendEvent(CommentsEvent::EVENT_UPDATE, $comment);
-
-		return $affectedRows > 0;
-	}
-
-	/**
-	 * removes references to specific actor (e.g. on user delete) of a comment.
-	 * The comment itself must not get lost/deleted.
-	 *
-	 * @param string $actorType the actor type (e.g. 'users')
-	 * @param string $actorId a user id
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public function deleteReferencesOfActor($actorType, $actorId) {
-		$this->checkRoleParameters('Actor', $actorType, $actorId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->update('comments')
-			->set('actor_type', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
-			->set('actor_id', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
-			->where($qb->expr()->eq('actor_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id')))
-			->setParameter('type', $actorType)
-			->setParameter('id', $actorId)
-			->execute();
-
-		$this->commentsCache = [];
-
-		return is_int($affectedRows);
-	}
-
-	/**
-	 * deletes all comments made of a specific object (e.g. on file delete)
-	 *
-	 * @param string $objectType the object type (e.g. 'files')
-	 * @param string $objectId e.g. the file id
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public function deleteCommentsAtObject($objectType, $objectId) {
-		$this->checkRoleParameters('Object', $objectType, $objectId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->delete('comments')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-			->setParameter('type', $objectType)
-			->setParameter('id', $objectId)
-			->execute();
-
-		$this->commentsCache = [];
-
-		return is_int($affectedRows);
-	}
-
-	/**
-	 * deletes the read markers for the specified user
-	 *
-	 * @param \OCP\IUser $user
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function deleteReadMarksFromUser(IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->delete('comments_read_markers')
-			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
-			->setParameter('user_id', $user->getUID());
-
-		try {
-			$affectedRows = $query->execute();
-		} catch (DriverException $e) {
-			$this->logger->logException($e, ['app' => 'core_comments']);
-			return false;
-		}
-		return ($affectedRows > 0);
-	}
-
-	/**
-	 * sets the read marker for a given file to the specified date for the
-	 * provided user
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param \DateTime $dateTime
-	 * @param IUser $user
-	 * @since 9.0.0
-	 * @suppress SqlInjectionChecker
-	 */
-	public function setReadMark($objectType, $objectId, \DateTime $dateTime, IUser $user) {
-		$this->checkRoleParameters('Object', $objectType, $objectId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$values = [
-			'user_id' => $qb->createNamedParameter($user->getUID()),
-			'marker_datetime' => $qb->createNamedParameter($dateTime, 'datetime'),
-			'object_type' => $qb->createNamedParameter($objectType),
-			'object_id' => $qb->createNamedParameter($objectId),
-		];
-
-		// Strategy: try to update, if this does not return affected rows, do an insert.
-		$affectedRows = $qb
-			->update('comments_read_markers')
-			->set('user_id', $values['user_id'])
-			->set('marker_datetime', $values['marker_datetime'])
-			->set('object_type', $values['object_type'])
-			->set('object_id', $values['object_id'])
-			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
-			->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
-			->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
-			->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
-			->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
-			->execute();
-
-		if ($affectedRows > 0) {
-			return;
-		}
-
-		$qb->insert('comments_read_markers')
-			->values($values)
-			->execute();
-	}
-
-	/**
-	 * returns the read marker for a given file to the specified date for the
-	 * provided user. It returns null, when the marker is not present, i.e.
-	 * no comments were marked as read.
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param IUser $user
-	 * @return \DateTime|null
-	 * @since 9.0.0
-	 */
-	public function getReadMark($objectType, $objectId, IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$resultStatement = $qb->select('marker_datetime')
-			->from('comments_read_markers')
-			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
-			->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
-			->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
-			->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
-			->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
-			->execute();
-
-		$data = $resultStatement->fetch();
-		$resultStatement->closeCursor();
-		if (!$data || is_null($data['marker_datetime'])) {
-			return null;
-		}
-
-		return new \DateTime($data['marker_datetime']);
-	}
-
-	/**
-	 * deletes the read markers on the specified object
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function deleteReadMarksOnObject($objectType, $objectId) {
-		$this->checkRoleParameters('Object', $objectType, $objectId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->delete('comments_read_markers')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
-			->setParameter('object_type', $objectType)
-			->setParameter('object_id', $objectId);
-
-		try {
-			$affectedRows = $query->execute();
-		} catch (DriverException $e) {
-			$this->logger->logException($e, ['app' => 'core_comments']);
-			return false;
-		}
-		return ($affectedRows > 0);
-	}
-
-	/**
-	 * registers an Entity to the manager, so event notifications can be send
-	 * to consumers of the comments infrastructure
-	 *
-	 * @param \Closure $closure
-	 */
-	public function registerEventHandler(\Closure $closure) {
-		$this->eventHandlerClosures[] = $closure;
-		$this->eventHandlers = [];
-	}
-
-	/**
-	 * registers a method that resolves an ID to a display name for a given type
-	 *
-	 * @param string $type
-	 * @param \Closure $closure
-	 * @throws \OutOfBoundsException
-	 * @since 11.0.0
-	 *
-	 * Only one resolver shall be registered per type. Otherwise a
-	 * \OutOfBoundsException has to thrown.
-	 */
-	public function registerDisplayNameResolver($type, \Closure $closure) {
-		if (!is_string($type)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		if (isset($this->displayNameResolvers[$type])) {
-			throw new \OutOfBoundsException('Displayname resolver for this type already registered');
-		}
-		$this->displayNameResolvers[$type] = $closure;
-	}
-
-	/**
-	 * resolves a given ID of a given Type to a display name.
-	 *
-	 * @param string $type
-	 * @param string $id
-	 * @return string
-	 * @throws \OutOfBoundsException
-	 * @since 11.0.0
-	 *
-	 * If a provided type was not registered, an \OutOfBoundsException shall
-	 * be thrown. It is upon the resolver discretion what to return of the
-	 * provided ID is unknown. It must be ensured that a string is returned.
-	 */
-	public function resolveDisplayName($type, $id) {
-		if (!is_string($type)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		if (!isset($this->displayNameResolvers[$type])) {
-			throw new \OutOfBoundsException('No Displayname resolver for this type registered');
-		}
-		return (string)$this->displayNameResolvers[$type]($id);
-	}
-
-	/**
-	 * returns valid, registered entities
-	 *
-	 * @return \OCP\Comments\ICommentsEventHandler[]
-	 */
-	private function getEventHandlers() {
-		if (!empty($this->eventHandlers)) {
-			return $this->eventHandlers;
-		}
-
-		$this->eventHandlers = [];
-		foreach ($this->eventHandlerClosures as $name => $closure) {
-			$entity = $closure();
-			if (!($entity instanceof ICommentsEventHandler)) {
-				throw new \InvalidArgumentException('The given entity does not implement the ICommentsEntity interface');
-			}
-			$this->eventHandlers[$name] = $entity;
-		}
-
-		return $this->eventHandlers;
-	}
-
-	/**
-	 * sends notifications to the registered entities
-	 *
-	 * @param $eventType
-	 * @param IComment $comment
-	 */
-	private function sendEvent($eventType, IComment $comment) {
-		$entities = $this->getEventHandlers();
-		$event = new CommentsEvent($eventType, $comment);
-		foreach ($entities as $entity) {
-			$entity->handle($event);
-		}
-	}
+    /** @var  IDBConnection */
+    protected $dbConn;
+
+    /** @var  ILogger */
+    protected $logger;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IComment[] */
+    protected $commentsCache = [];
+
+    /** @var  \Closure[] */
+    protected $eventHandlerClosures = [];
+
+    /** @var  ICommentsEventHandler[] */
+    protected $eventHandlers = [];
+
+    /** @var \Closure[] */
+    protected $displayNameResolvers = [];
+
+    /**
+     * Manager constructor.
+     *
+     * @param IDBConnection $dbConn
+     * @param ILogger $logger
+     * @param IConfig $config
+     */
+    public function __construct(
+        IDBConnection $dbConn,
+        ILogger $logger,
+        IConfig $config
+    ) {
+        $this->dbConn = $dbConn;
+        $this->logger = $logger;
+        $this->config = $config;
+    }
+
+    /**
+     * converts data base data into PHP native, proper types as defined by
+     * IComment interface.
+     *
+     * @param array $data
+     * @return array
+     */
+    protected function normalizeDatabaseData(array $data) {
+        $data['id'] = strval($data['id']);
+        $data['parent_id'] = strval($data['parent_id']);
+        $data['topmost_parent_id'] = strval($data['topmost_parent_id']);
+        $data['creation_timestamp'] = new \DateTime($data['creation_timestamp']);
+        if (!is_null($data['latest_child_timestamp'])) {
+            $data['latest_child_timestamp'] = new \DateTime($data['latest_child_timestamp']);
+        }
+        $data['children_count'] = intval($data['children_count']);
+        return $data;
+    }
+
+    /**
+     * prepares a comment for an insert or update operation after making sure
+     * all necessary fields have a value assigned.
+     *
+     * @param IComment $comment
+     * @return IComment returns the same updated IComment instance as provided
+     *                  by parameter for convenience
+     * @throws \UnexpectedValueException
+     */
+    protected function prepareCommentForDatabaseWrite(IComment $comment) {
+        if (!$comment->getActorType()
+            || !$comment->getActorId()
+            || !$comment->getObjectType()
+            || !$comment->getObjectId()
+            || !$comment->getVerb()
+        ) {
+            throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
+        }
+
+        if ($comment->getId() === '') {
+            $comment->setChildrenCount(0);
+            $comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
+            $comment->setLatestChildDateTime(null);
+        }
+
+        if (is_null($comment->getCreationDateTime())) {
+            $comment->setCreationDateTime(new \DateTime());
+        }
+
+        if ($comment->getParentId() !== '0') {
+            $comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
+        } else {
+            $comment->setTopmostParentId('0');
+        }
+
+        $this->cache($comment);
+
+        return $comment;
+    }
+
+    /**
+     * returns the topmost parent id of a given comment identified by ID
+     *
+     * @param string $id
+     * @return string
+     * @throws NotFoundException
+     */
+    protected function determineTopmostParentId($id) {
+        $comment = $this->get($id);
+        if ($comment->getParentId() === '0') {
+            return $comment->getId();
+        } else {
+            return $this->determineTopmostParentId($comment->getId());
+        }
+    }
+
+    /**
+     * updates child information of a comment
+     *
+     * @param string $id
+     * @param \DateTime $cDateTime the date time of the most recent child
+     * @throws NotFoundException
+     */
+    protected function updateChildrenInformation($id, \DateTime $cDateTime) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select($qb->createFunction('COUNT(`id`)'))
+            ->from('comments')
+            ->where($qb->expr()->eq('parent_id', $qb->createParameter('id')))
+            ->setParameter('id', $id);
+
+        $resultStatement = $query->execute();
+        $data = $resultStatement->fetch(\PDO::FETCH_NUM);
+        $resultStatement->closeCursor();
+        $children = intval($data[0]);
+
+        $comment = $this->get($id);
+        $comment->setChildrenCount($children);
+        $comment->setLatestChildDateTime($cDateTime);
+        $this->save($comment);
+    }
+
+    /**
+     * Tests whether actor or object type and id parameters are acceptable.
+     * Throws exception if not.
+     *
+     * @param string $role
+     * @param string $type
+     * @param string $id
+     * @throws \InvalidArgumentException
+     */
+    protected function checkRoleParameters($role, $type, $id) {
+        if (
+            !is_string($type) || empty($type)
+            || !is_string($id) || empty($id)
+        ) {
+            throw new \InvalidArgumentException($role . ' parameters must be string and not empty');
+        }
+    }
+
+    /**
+     * run-time caches a comment
+     *
+     * @param IComment $comment
+     */
+    protected function cache(IComment $comment) {
+        $id = $comment->getId();
+        if (empty($id)) {
+            return;
+        }
+        $this->commentsCache[strval($id)] = $comment;
+    }
+
+    /**
+     * removes an entry from the comments run time cache
+     *
+     * @param mixed $id the comment's id
+     */
+    protected function uncache($id) {
+        $id = strval($id);
+        if (isset($this->commentsCache[$id])) {
+            unset($this->commentsCache[$id]);
+        }
+    }
+
+    /**
+     * returns a comment instance
+     *
+     * @param string $id the ID of the comment
+     * @return IComment
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException
+     * @since 9.0.0
+     */
+    public function get($id) {
+        if (intval($id) === 0) {
+            throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
+        }
+
+        if (isset($this->commentsCache[$id])) {
+            return $this->commentsCache[$id];
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $resultStatement = $qb->select('*')
+            ->from('comments')
+            ->where($qb->expr()->eq('id', $qb->createParameter('id')))
+            ->setParameter('id', $id, IQueryBuilder::PARAM_INT)
+            ->execute();
+
+        $data = $resultStatement->fetch();
+        $resultStatement->closeCursor();
+        if (!$data) {
+            throw new NotFoundException();
+        }
+
+        $comment = new Comment($this->normalizeDatabaseData($data));
+        $this->cache($comment);
+        return $comment;
+    }
+
+    /**
+     * returns the comment specified by the id and all it's child comments.
+     * At this point of time, we do only support one level depth.
+     *
+     * @param string $id
+     * @param int $limit max number of entries to return, 0 returns all
+     * @param int $offset the start entry
+     * @return array
+     * @since 9.0.0
+     *
+     * The return array looks like this
+     * [
+     *   'comment' => IComment, // root comment
+     *   'replies' =>
+     *   [
+     *     0 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies' => []
+     *     ]
+     *     1 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies'=> []
+     *     ],
+     *     …
+     *   ]
+     * ]
+     */
+    public function getTree($id, $limit = 0, $offset = 0) {
+        $tree = [];
+        $tree['comment'] = $this->get($id);
+        $tree['replies'] = [];
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select('*')
+            ->from('comments')
+            ->where($qb->expr()->eq('topmost_parent_id', $qb->createParameter('id')))
+            ->orderBy('creation_timestamp', 'DESC')
+            ->setParameter('id', $id);
+
+        if ($limit > 0) {
+            $query->setMaxResults($limit);
+        }
+        if ($offset > 0) {
+            $query->setFirstResult($offset);
+        }
+
+        $resultStatement = $query->execute();
+        while ($data = $resultStatement->fetch()) {
+            $comment = new Comment($this->normalizeDatabaseData($data));
+            $this->cache($comment);
+            $tree['replies'][] = [
+                'comment' => $comment,
+                'replies' => []
+            ];
+        }
+        $resultStatement->closeCursor();
+
+        return $tree;
+    }
+
+    /**
+     * returns comments for a specific object (e.g. a file).
+     *
+     * The sort order is always newest to oldest.
+     *
+     * @param string $objectType the object type, e.g. 'files'
+     * @param string $objectId the id of the object
+     * @param int $limit optional, number of maximum comments to be returned. if
+     * not specified, all comments are returned.
+     * @param int $offset optional, starting point
+     * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
+     * that may be returned
+     * @return IComment[]
+     * @since 9.0.0
+     */
+    public function getForObject(
+        $objectType,
+        $objectId,
+        $limit = 0,
+        $offset = 0,
+        \DateTime $notOlderThan = null
+    ) {
+        $comments = [];
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select('*')
+            ->from('comments')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+            ->orderBy('creation_timestamp', 'DESC')
+            ->setParameter('type', $objectType)
+            ->setParameter('id', $objectId);
+
+        if ($limit > 0) {
+            $query->setMaxResults($limit);
+        }
+        if ($offset > 0) {
+            $query->setFirstResult($offset);
+        }
+        if (!is_null($notOlderThan)) {
+            $query
+                ->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
+                ->setParameter('notOlderThan', $notOlderThan, 'datetime');
+        }
+
+        $resultStatement = $query->execute();
+        while ($data = $resultStatement->fetch()) {
+            $comment = new Comment($this->normalizeDatabaseData($data));
+            $this->cache($comment);
+            $comments[] = $comment;
+        }
+        $resultStatement->closeCursor();
+
+        return $comments;
+    }
+
+    /**
+     * @param $objectType string the object type, e.g. 'files'
+     * @param $objectId string the id of the object
+     * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
+     * that may be returned
+     * @return Int
+     * @since 9.0.0
+     */
+    public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select($qb->createFunction('COUNT(`id`)'))
+            ->from('comments')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+            ->setParameter('type', $objectType)
+            ->setParameter('id', $objectId);
+
+        if (!is_null($notOlderThan)) {
+            $query
+                ->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
+                ->setParameter('notOlderThan', $notOlderThan, 'datetime');
+        }
+
+        $resultStatement = $query->execute();
+        $data = $resultStatement->fetch(\PDO::FETCH_NUM);
+        $resultStatement->closeCursor();
+        return intval($data[0]);
+    }
+
+    /**
+     * Get the number of unread comments for all files in a folder
+     *
+     * @param int $folderId
+     * @param IUser $user
+     * @return array [$fileId => $unreadCount]
+     */
+    public function getNumberOfUnreadCommentsForFolder($folderId, IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select('f.fileid')
+            ->selectAlias(
+                $qb->createFunction('COUNT(' . $qb->getColumnName('c.id') . ')'),
+                'num_ids'
+            )
+            ->from('comments', 'c')
+            ->innerJoin('c', 'filecache', 'f', $qb->expr()->andX(
+                $qb->expr()->eq('c.object_type', $qb->createNamedParameter('files')),
+                $qb->expr()->eq('f.fileid', $qb->expr()->castColumn('c.object_id', IQueryBuilder::PARAM_INT))
+            ))
+            ->leftJoin('c', 'comments_read_markers', 'm', $qb->expr()->andX(
+                $qb->expr()->eq('m.object_type', $qb->createNamedParameter('files')),
+                $qb->expr()->eq('m.object_id', 'c.object_id'),
+                $qb->expr()->eq('m.user_id', $qb->createNamedParameter($user->getUID()))
+            ))
+            ->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($folderId)))
+            ->andWhere($qb->expr()->orX(
+                $qb->expr()->gt('c.creation_timestamp', 'marker_datetime'),
+                $qb->expr()->isNull('marker_datetime')
+            ))
+            ->groupBy('f.fileid');
+
+        $resultStatement = $query->execute();
+
+        $results = [];
+        while ($row = $resultStatement->fetch()) {
+            $results[$row['fileid']] = (int) $row['num_ids'];
+        }
+        $resultStatement->closeCursor();
+        return $results;
+    }
+
+    /**
+     * creates a new comment and returns it. At this point of time, it is not
+     * saved in the used data storage. Use save() after setting other fields
+     * of the comment (e.g. message or verb).
+     *
+     * @param string $actorType the actor type (e.g. 'users')
+     * @param string $actorId a user id
+     * @param string $objectType the object type the comment is attached to
+     * @param string $objectId the object id the comment is attached to
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function create($actorType, $actorId, $objectType, $objectId) {
+        $comment = new Comment();
+        $comment
+            ->setActor($actorType, $actorId)
+            ->setObject($objectType, $objectId);
+        return $comment;
+    }
+
+    /**
+     * permanently deletes the comment specified by the ID
+     *
+     * When the comment has child comments, their parent ID will be changed to
+     * the parent ID of the item that is to be deleted.
+     *
+     * @param string $id
+     * @return bool
+     * @throws \InvalidArgumentException
+     * @since 9.0.0
+     */
+    public function delete($id) {
+        if (!is_string($id)) {
+            throw new \InvalidArgumentException('Parameter must be string');
+        }
+
+        try {
+            $comment = $this->get($id);
+        } catch (\Exception $e) {
+            // Ignore exceptions, we just don't fire a hook then
+            $comment = null;
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->delete('comments')
+            ->where($qb->expr()->eq('id', $qb->createParameter('id')))
+            ->setParameter('id', $id);
+
+        try {
+            $affectedRows = $query->execute();
+            $this->uncache($id);
+        } catch (DriverException $e) {
+            $this->logger->logException($e, ['app' => 'core_comments']);
+            return false;
+        }
+
+        if ($affectedRows > 0 && $comment instanceof IComment) {
+            $this->sendEvent(CommentsEvent::EVENT_DELETE, $comment);
+        }
+
+        return ($affectedRows > 0);
+    }
+
+    /**
+     * saves the comment permanently
+     *
+     * if the supplied comment has an empty ID, a new entry comment will be
+     * saved and the instance updated with the new ID.
+     *
+     * Otherwise, an existing comment will be updated.
+     *
+     * Throws NotFoundException when a comment that is to be updated does not
+     * exist anymore at this point of time.
+     *
+     * @param IComment $comment
+     * @return bool
+     * @throws NotFoundException
+     * @since 9.0.0
+     */
+    public function save(IComment $comment) {
+        if ($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
+            $result = $this->insert($comment);
+        } else {
+            $result = $this->update($comment);
+        }
+
+        if ($result && !!$comment->getParentId()) {
+            $this->updateChildrenInformation(
+                $comment->getParentId(),
+                $comment->getCreationDateTime()
+            );
+            $this->cache($comment);
+        }
+
+        return $result;
+    }
+
+    /**
+     * inserts the provided comment in the database
+     *
+     * @param IComment $comment
+     * @return bool
+     */
+    protected function insert(IComment &$comment) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->insert('comments')
+            ->values([
+                'parent_id' => $qb->createNamedParameter($comment->getParentId()),
+                'topmost_parent_id' => $qb->createNamedParameter($comment->getTopmostParentId()),
+                'children_count' => $qb->createNamedParameter($comment->getChildrenCount()),
+                'actor_type' => $qb->createNamedParameter($comment->getActorType()),
+                'actor_id' => $qb->createNamedParameter($comment->getActorId()),
+                'message' => $qb->createNamedParameter($comment->getMessage()),
+                'verb' => $qb->createNamedParameter($comment->getVerb()),
+                'creation_timestamp' => $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'),
+                'latest_child_timestamp' => $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'),
+                'object_type' => $qb->createNamedParameter($comment->getObjectType()),
+                'object_id' => $qb->createNamedParameter($comment->getObjectId()),
+            ])
+            ->execute();
+
+        if ($affectedRows > 0) {
+            $comment->setId(strval($qb->getLastInsertId()));
+            $this->sendEvent(CommentsEvent::EVENT_ADD, $comment);
+        }
+
+        return $affectedRows > 0;
+    }
+
+    /**
+     * updates a Comment data row
+     *
+     * @param IComment $comment
+     * @return bool
+     * @throws NotFoundException
+     */
+    protected function update(IComment $comment) {
+        // for properly working preUpdate Events we need the old comments as is
+        // in the DB and overcome caching. Also avoid that outdated information stays.
+        $this->uncache($comment->getId());
+        $this->sendEvent(CommentsEvent::EVENT_PRE_UPDATE, $this->get($comment->getId()));
+        $this->uncache($comment->getId());
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->update('comments')
+            ->set('parent_id', $qb->createNamedParameter($comment->getParentId()))
+            ->set('topmost_parent_id', $qb->createNamedParameter($comment->getTopmostParentId()))
+            ->set('children_count', $qb->createNamedParameter($comment->getChildrenCount()))
+            ->set('actor_type', $qb->createNamedParameter($comment->getActorType()))
+            ->set('actor_id', $qb->createNamedParameter($comment->getActorId()))
+            ->set('message', $qb->createNamedParameter($comment->getMessage()))
+            ->set('verb', $qb->createNamedParameter($comment->getVerb()))
+            ->set('creation_timestamp', $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
+            ->set('latest_child_timestamp', $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
+            ->set('object_type', $qb->createNamedParameter($comment->getObjectType()))
+            ->set('object_id', $qb->createNamedParameter($comment->getObjectId()))
+            ->where($qb->expr()->eq('id', $qb->createParameter('id')))
+            ->setParameter('id', $comment->getId())
+            ->execute();
+
+        if ($affectedRows === 0) {
+            throw new NotFoundException('Comment to update does ceased to exist');
+        }
+
+        $this->sendEvent(CommentsEvent::EVENT_UPDATE, $comment);
+
+        return $affectedRows > 0;
+    }
+
+    /**
+     * removes references to specific actor (e.g. on user delete) of a comment.
+     * The comment itself must not get lost/deleted.
+     *
+     * @param string $actorType the actor type (e.g. 'users')
+     * @param string $actorId a user id
+     * @return boolean
+     * @since 9.0.0
+     */
+    public function deleteReferencesOfActor($actorType, $actorId) {
+        $this->checkRoleParameters('Actor', $actorType, $actorId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->update('comments')
+            ->set('actor_type', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
+            ->set('actor_id', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
+            ->where($qb->expr()->eq('actor_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id')))
+            ->setParameter('type', $actorType)
+            ->setParameter('id', $actorId)
+            ->execute();
+
+        $this->commentsCache = [];
+
+        return is_int($affectedRows);
+    }
+
+    /**
+     * deletes all comments made of a specific object (e.g. on file delete)
+     *
+     * @param string $objectType the object type (e.g. 'files')
+     * @param string $objectId e.g. the file id
+     * @return boolean
+     * @since 9.0.0
+     */
+    public function deleteCommentsAtObject($objectType, $objectId) {
+        $this->checkRoleParameters('Object', $objectType, $objectId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->delete('comments')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+            ->setParameter('type', $objectType)
+            ->setParameter('id', $objectId)
+            ->execute();
+
+        $this->commentsCache = [];
+
+        return is_int($affectedRows);
+    }
+
+    /**
+     * deletes the read markers for the specified user
+     *
+     * @param \OCP\IUser $user
+     * @return bool
+     * @since 9.0.0
+     */
+    public function deleteReadMarksFromUser(IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->delete('comments_read_markers')
+            ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
+            ->setParameter('user_id', $user->getUID());
+
+        try {
+            $affectedRows = $query->execute();
+        } catch (DriverException $e) {
+            $this->logger->logException($e, ['app' => 'core_comments']);
+            return false;
+        }
+        return ($affectedRows > 0);
+    }
+
+    /**
+     * sets the read marker for a given file to the specified date for the
+     * provided user
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @param \DateTime $dateTime
+     * @param IUser $user
+     * @since 9.0.0
+     * @suppress SqlInjectionChecker
+     */
+    public function setReadMark($objectType, $objectId, \DateTime $dateTime, IUser $user) {
+        $this->checkRoleParameters('Object', $objectType, $objectId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $values = [
+            'user_id' => $qb->createNamedParameter($user->getUID()),
+            'marker_datetime' => $qb->createNamedParameter($dateTime, 'datetime'),
+            'object_type' => $qb->createNamedParameter($objectType),
+            'object_id' => $qb->createNamedParameter($objectId),
+        ];
+
+        // Strategy: try to update, if this does not return affected rows, do an insert.
+        $affectedRows = $qb
+            ->update('comments_read_markers')
+            ->set('user_id', $values['user_id'])
+            ->set('marker_datetime', $values['marker_datetime'])
+            ->set('object_type', $values['object_type'])
+            ->set('object_id', $values['object_id'])
+            ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
+            ->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
+            ->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
+            ->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
+            ->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
+            ->execute();
+
+        if ($affectedRows > 0) {
+            return;
+        }
+
+        $qb->insert('comments_read_markers')
+            ->values($values)
+            ->execute();
+    }
+
+    /**
+     * returns the read marker for a given file to the specified date for the
+     * provided user. It returns null, when the marker is not present, i.e.
+     * no comments were marked as read.
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @param IUser $user
+     * @return \DateTime|null
+     * @since 9.0.0
+     */
+    public function getReadMark($objectType, $objectId, IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $resultStatement = $qb->select('marker_datetime')
+            ->from('comments_read_markers')
+            ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
+            ->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
+            ->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
+            ->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
+            ->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
+            ->execute();
+
+        $data = $resultStatement->fetch();
+        $resultStatement->closeCursor();
+        if (!$data || is_null($data['marker_datetime'])) {
+            return null;
+        }
+
+        return new \DateTime($data['marker_datetime']);
+    }
+
+    /**
+     * deletes the read markers on the specified object
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @return bool
+     * @since 9.0.0
+     */
+    public function deleteReadMarksOnObject($objectType, $objectId) {
+        $this->checkRoleParameters('Object', $objectType, $objectId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->delete('comments_read_markers')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
+            ->setParameter('object_type', $objectType)
+            ->setParameter('object_id', $objectId);
+
+        try {
+            $affectedRows = $query->execute();
+        } catch (DriverException $e) {
+            $this->logger->logException($e, ['app' => 'core_comments']);
+            return false;
+        }
+        return ($affectedRows > 0);
+    }
+
+    /**
+     * registers an Entity to the manager, so event notifications can be send
+     * to consumers of the comments infrastructure
+     *
+     * @param \Closure $closure
+     */
+    public function registerEventHandler(\Closure $closure) {
+        $this->eventHandlerClosures[] = $closure;
+        $this->eventHandlers = [];
+    }
+
+    /**
+     * registers a method that resolves an ID to a display name for a given type
+     *
+     * @param string $type
+     * @param \Closure $closure
+     * @throws \OutOfBoundsException
+     * @since 11.0.0
+     *
+     * Only one resolver shall be registered per type. Otherwise a
+     * \OutOfBoundsException has to thrown.
+     */
+    public function registerDisplayNameResolver($type, \Closure $closure) {
+        if (!is_string($type)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        if (isset($this->displayNameResolvers[$type])) {
+            throw new \OutOfBoundsException('Displayname resolver for this type already registered');
+        }
+        $this->displayNameResolvers[$type] = $closure;
+    }
+
+    /**
+     * resolves a given ID of a given Type to a display name.
+     *
+     * @param string $type
+     * @param string $id
+     * @return string
+     * @throws \OutOfBoundsException
+     * @since 11.0.0
+     *
+     * If a provided type was not registered, an \OutOfBoundsException shall
+     * be thrown. It is upon the resolver discretion what to return of the
+     * provided ID is unknown. It must be ensured that a string is returned.
+     */
+    public function resolveDisplayName($type, $id) {
+        if (!is_string($type)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        if (!isset($this->displayNameResolvers[$type])) {
+            throw new \OutOfBoundsException('No Displayname resolver for this type registered');
+        }
+        return (string)$this->displayNameResolvers[$type]($id);
+    }
+
+    /**
+     * returns valid, registered entities
+     *
+     * @return \OCP\Comments\ICommentsEventHandler[]
+     */
+    private function getEventHandlers() {
+        if (!empty($this->eventHandlers)) {
+            return $this->eventHandlers;
+        }
+
+        $this->eventHandlers = [];
+        foreach ($this->eventHandlerClosures as $name => $closure) {
+            $entity = $closure();
+            if (!($entity instanceof ICommentsEventHandler)) {
+                throw new \InvalidArgumentException('The given entity does not implement the ICommentsEntity interface');
+            }
+            $this->eventHandlers[$name] = $entity;
+        }
+
+        return $this->eventHandlers;
+    }
+
+    /**
+     * sends notifications to the registered entities
+     *
+     * @param $eventType
+     * @param IComment $comment
+     */
+    private function sendEvent($eventType, IComment $comment) {
+        $entities = $this->getEventHandlers();
+        $event = new CommentsEvent($eventType, $comment);
+        foreach ($entities as $entity) {
+            $entity->handle($event);
+        }
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -190,7 +190,7 @@ 
 			!is_string($type) || empty($type)
 			|| !is_string($id) || empty($id)
 		) {
-			throw new \InvalidArgumentException($role . ' parameters must be string and not empty');
+			throw new \InvalidArgumentException($role.' parameters must be string and not empty');
 		}
 	}
 
@@ -413,7 +413,7 @@ 
 		$qb = $this->dbConn->getQueryBuilder();
 		$query = $qb->select('f.fileid')
 			->selectAlias(
-				$qb->createFunction('COUNT(' . $qb->getColumnName('c.id') . ')'),
+				$qb->createFunction('COUNT('.$qb->getColumnName('c.id').')'),
 				'num_ids'
 			)
 			->from('comments', 'c')
@@ -546,7 +546,7 @@ 
 	 * @param IComment $comment
 	 * @return bool
 	 */
-	protected function insert(IComment &$comment) {
+	protected function insert(IComment & $comment) {
 		$qb = $this->dbConn->getQueryBuilder();
 		$affectedRows = $qb
 			->insert('comments')
@@ -846,7 +846,7 @@ 
 		if (!isset($this->displayNameResolvers[$type])) {
 			throw new \OutOfBoundsException('No Displayname resolver for this type registered');
 		}
-		return (string)$this->displayNameResolvers[$type]($id);
+		return (string) $this->displayNameResolvers[$type]($id);
 	}
 
 	/**

lib/private/DateTimeFormatter.php

Doc Comments +3 added lines, -3 removed lines

@@ -93,7 +93,7 @@ 
 	/**
 	 * Formats the date of the given timestamp
 	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+	 * @param integer	$timestamp	Either a Unix timestamp or DateTime object
 	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
 	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
 	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
@@ -192,7 +192,7 @@ 
 	/**
 	 * Gives the relative past time of the timestamp
 	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+	 * @param integer	$timestamp	Either a Unix timestamp or DateTime object
 	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
 	 * @return string	Dates returned are:
 	 * 				< 60 sec	=> seconds ago
@@ -228,7 +228,7 @@ 
 	/**
 	 * Formats the date and time of the given timestamp
 	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+	 * @param integer $timestamp	Either a Unix timestamp or DateTime object
 	 * @param string		$formatDate		See formatDate() for description
 	 * @param string		$formatTime		See formatTime() for description
 	 * @param \DateTimeZone	$timeZone	The timezone to use

Spacing +2 added lines, -2 removed lines

@@ -237,7 +237,7 @@ 
 	 * @return string Formatted date and time string
 	 */
 	public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
+		return $this->format($timestamp, 'datetime', $formatDate.'|'.$formatTime, $timeZone, $l);
 	}
 
 	/**
@@ -256,7 +256,7 @@ 
 			$formatDate .= '^';
 		}
 
-		return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
+		return $this->format($timestamp, 'datetime', $formatDate.'|'.$formatTime, $timeZone, $l);
 	}
 
 	/**

Indentation +268 added lines, -268 removed lines

@@ -25,294 +25,294 @@
 namespace OC;
 
 class DateTimeFormatter implements \OCP\IDateTimeFormatter {
-	/** @var \DateTimeZone */
-	protected $defaultTimeZone;
+    /** @var \DateTimeZone */
+    protected $defaultTimeZone;
 
-	/** @var \OCP\IL10N */
-	protected $defaultL10N;
+    /** @var \OCP\IL10N */
+    protected $defaultL10N;
 
-	/**
-	 * Constructor
-	 *
-	 * @param \DateTimeZone $defaultTimeZone Set the timezone for the format
-	 * @param \OCP\IL10N $defaultL10N Set the language for the format
-	 */
-	public function __construct(\DateTimeZone $defaultTimeZone, \OCP\IL10N $defaultL10N) {
-		$this->defaultTimeZone = $defaultTimeZone;
-		$this->defaultL10N = $defaultL10N;
-	}
+    /**
+     * Constructor
+     *
+     * @param \DateTimeZone $defaultTimeZone Set the timezone for the format
+     * @param \OCP\IL10N $defaultL10N Set the language for the format
+     */
+    public function __construct(\DateTimeZone $defaultTimeZone, \OCP\IL10N $defaultL10N) {
+        $this->defaultTimeZone = $defaultTimeZone;
+        $this->defaultL10N = $defaultL10N;
+    }
 
-	/**
-	 * Get TimeZone to use
-	 *
-	 * @param \DateTimeZone $timeZone	The timezone to use
-	 * @return \DateTimeZone		The timezone to use, falling back to the current user's timezone
-	 */
-	protected function getTimeZone($timeZone = null) {
-		if ($timeZone === null) {
-			$timeZone = $this->defaultTimeZone;
-		}
+    /**
+     * Get TimeZone to use
+     *
+     * @param \DateTimeZone $timeZone	The timezone to use
+     * @return \DateTimeZone		The timezone to use, falling back to the current user's timezone
+     */
+    protected function getTimeZone($timeZone = null) {
+        if ($timeZone === null) {
+            $timeZone = $this->defaultTimeZone;
+        }
 
-		return $timeZone;
-	}
+        return $timeZone;
+    }
 
-	/**
-	 * Get \OCP\IL10N to use
-	 *
-	 * @param \OCP\IL10N $l	The locale to use
-	 * @return \OCP\IL10N		The locale to use, falling back to the current user's locale
-	 */
-	protected function getLocale($l = null) {
-		if ($l === null) {
-			$l = $this->defaultL10N;
-		}
+    /**
+     * Get \OCP\IL10N to use
+     *
+     * @param \OCP\IL10N $l	The locale to use
+     * @return \OCP\IL10N		The locale to use, falling back to the current user's locale
+     */
+    protected function getLocale($l = null) {
+        if ($l === null) {
+            $l = $this->defaultL10N;
+        }
 
-		return $l;
-	}
+        return $l;
+    }
 
-	/**
-	 * Generates a DateTime object with the given timestamp and TimeZone
-	 *
-	 * @param mixed $timestamp
-	 * @param \DateTimeZone $timeZone	The timezone to use
-	 * @return \DateTime
-	 */
-	protected function getDateTime($timestamp, \DateTimeZone $timeZone = null) {
-		if ($timestamp === null) {
-			return new \DateTime('now', $timeZone);
-		} else if (!$timestamp instanceof \DateTime) {
-			$dateTime = new \DateTime('now', $timeZone);
-			$dateTime->setTimestamp($timestamp);
-			return $dateTime;
-		}
-		if ($timeZone) {
-			$timestamp->setTimezone($timeZone);
-		}
-		return $timestamp;
-	}
+    /**
+     * Generates a DateTime object with the given timestamp and TimeZone
+     *
+     * @param mixed $timestamp
+     * @param \DateTimeZone $timeZone	The timezone to use
+     * @return \DateTime
+     */
+    protected function getDateTime($timestamp, \DateTimeZone $timeZone = null) {
+        if ($timestamp === null) {
+            return new \DateTime('now', $timeZone);
+        } else if (!$timestamp instanceof \DateTime) {
+            $dateTime = new \DateTime('now', $timeZone);
+            $dateTime->setTimestamp($timestamp);
+            return $dateTime;
+        }
+        if ($timeZone) {
+            $timestamp->setTimezone($timeZone);
+        }
+        return $timestamp;
+    }
 
-	/**
-	 * Formats the date of the given timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
-	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
-	 * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
-	 * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
-	 * 				The exact format is dependent on the language
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date string
-	 */
-	public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'date', $format, $timeZone, $l);
-	}
+    /**
+     * Formats the date of the given timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
+     * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
+     * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
+     * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
+     * 				The exact format is dependent on the language
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date string
+     */
+    public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        return $this->format($timestamp, 'date', $format, $timeZone, $l);
+    }
 
-	/**
-	 * Formats the date of the given timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
-	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
-	 * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
-	 * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
-	 * 				The exact format is dependent on the language
-	 * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted relative date string
-	 */
-	public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		if (substr($format, -1) !== '*' && substr($format, -1) !== '*') {
-			$format .= '^';
-		}
+    /**
+     * Formats the date of the given timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
+     * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
+     * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
+     * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
+     * 				The exact format is dependent on the language
+     * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted relative date string
+     */
+    public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        if (substr($format, -1) !== '*' && substr($format, -1) !== '*') {
+            $format .= '^';
+        }
 
-		return $this->format($timestamp, 'date', $format, $timeZone, $l);
-	}
+        return $this->format($timestamp, 'date', $format, $timeZone, $l);
+    }
 
-	/**
-	 * Gives the relative date of the timestamp
-	 * Only works for past dates
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
-	 * @return string	Dates returned are:
-	 * 				<  1 month	=> Today, Yesterday, n days ago
-	 * 				< 13 month	=> last month, n months ago
-	 * 				>= 13 month	=> last year, n years ago
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date span
-	 */
-	public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
-		$l = $this->getLocale($l);
-		$timestamp = $this->getDateTime($timestamp);
-		$timestamp->setTime(0, 0, 0);
+    /**
+     * Gives the relative date of the timestamp
+     * Only works for past dates
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
+     * @return string	Dates returned are:
+     * 				<  1 month	=> Today, Yesterday, n days ago
+     * 				< 13 month	=> last month, n months ago
+     * 				>= 13 month	=> last year, n years ago
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date span
+     */
+    public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
+        $l = $this->getLocale($l);
+        $timestamp = $this->getDateTime($timestamp);
+        $timestamp->setTime(0, 0, 0);
 
-		if ($baseTimestamp === null) {
-			$baseTimestamp = time();
-		}
-		$baseTimestamp = $this->getDateTime($baseTimestamp);
-		$baseTimestamp->setTime(0, 0, 0);
-		$dateInterval = $timestamp->diff($baseTimestamp);
+        if ($baseTimestamp === null) {
+            $baseTimestamp = time();
+        }
+        $baseTimestamp = $this->getDateTime($baseTimestamp);
+        $baseTimestamp->setTime(0, 0, 0);
+        $dateInterval = $timestamp->diff($baseTimestamp);
 
-		if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 0) {
-			return $l->t('today');
-		} else if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 1) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->t('tomorrow');
-			} else {
-				return $l->t('yesterday');
-			}
-		} else if ($dateInterval->y == 0 && $dateInterval->m == 0) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->n('in %n day', 'in %n days', $dateInterval->d);
-			} else {
-				return $l->n('%n day ago', '%n days ago', $dateInterval->d);
-			}
-		} else if ($dateInterval->y == 0 && $dateInterval->m == 1) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->t('next month');
-			} else {
-				return $l->t('last month');
-			}
-		} else if ($dateInterval->y == 0) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->n('in %n month', 'in %n months', $dateInterval->m);
-			} else {
-				return $l->n('%n month ago', '%n months ago', $dateInterval->m);
-			}
-		} else if ($dateInterval->y == 1) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->t('next year');
-			} else {
-				return $l->t('last year');
-			}
-		}
-		if ($timestamp > $baseTimestamp) {
-			return $l->n('in %n year', 'in %n years', $dateInterval->y);
-		} else {
-			return $l->n('%n year ago', '%n years ago', $dateInterval->y);
-		}
-	}
+        if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 0) {
+            return $l->t('today');
+        } else if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 1) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->t('tomorrow');
+            } else {
+                return $l->t('yesterday');
+            }
+        } else if ($dateInterval->y == 0 && $dateInterval->m == 0) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->n('in %n day', 'in %n days', $dateInterval->d);
+            } else {
+                return $l->n('%n day ago', '%n days ago', $dateInterval->d);
+            }
+        } else if ($dateInterval->y == 0 && $dateInterval->m == 1) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->t('next month');
+            } else {
+                return $l->t('last month');
+            }
+        } else if ($dateInterval->y == 0) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->n('in %n month', 'in %n months', $dateInterval->m);
+            } else {
+                return $l->n('%n month ago', '%n months ago', $dateInterval->m);
+            }
+        } else if ($dateInterval->y == 1) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->t('next year');
+            } else {
+                return $l->t('last year');
+            }
+        }
+        if ($timestamp > $baseTimestamp) {
+            return $l->n('in %n year', 'in %n years', $dateInterval->y);
+        } else {
+            return $l->n('%n year ago', '%n years ago', $dateInterval->y);
+        }
+    }
 
-	/**
-	 * Formats the time of the given timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'h:mm:ss a zzzz'	=> '11:42:13 AM GMT+0:00'
-	 * 				long:	e.g. 'h:mm:ss a z'		=> '11:42:13 AM GMT'
-	 * 				medium:	e.g. 'h:mm:ss a'		=> '11:42:13 AM'
-	 * 				short:	e.g. 'h:mm a'			=> '11:42 AM'
-	 * 				The exact format is dependent on the language
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted time string
-	 */
-	public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'time', $format, $timeZone, $l);
-	}
+    /**
+     * Formats the time of the given timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'h:mm:ss a zzzz'	=> '11:42:13 AM GMT+0:00'
+     * 				long:	e.g. 'h:mm:ss a z'		=> '11:42:13 AM GMT'
+     * 				medium:	e.g. 'h:mm:ss a'		=> '11:42:13 AM'
+     * 				short:	e.g. 'h:mm a'			=> '11:42 AM'
+     * 				The exact format is dependent on the language
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted time string
+     */
+    public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        return $this->format($timestamp, 'time', $format, $timeZone, $l);
+    }
 
-	/**
-	 * Gives the relative past time of the timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
-	 * @return string	Dates returned are:
-	 * 				< 60 sec	=> seconds ago
-	 * 				<  1 hour	=> n minutes ago
-	 * 				<  1 day	=> n hours ago
-	 * 				<  1 month	=> Yesterday, n days ago
-	 * 				< 13 month	=> last month, n months ago
-	 * 				>= 13 month	=> last year, n years ago
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted time span
-	 */
-	public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
-		$l = $this->getLocale($l);
-		$timestamp = $this->getDateTime($timestamp);
-		if ($baseTimestamp === null) {
-			$baseTimestamp = time();
-		}
-		$baseTimestamp = $this->getDateTime($baseTimestamp);
+    /**
+     * Gives the relative past time of the timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
+     * @return string	Dates returned are:
+     * 				< 60 sec	=> seconds ago
+     * 				<  1 hour	=> n minutes ago
+     * 				<  1 day	=> n hours ago
+     * 				<  1 month	=> Yesterday, n days ago
+     * 				< 13 month	=> last month, n months ago
+     * 				>= 13 month	=> last year, n years ago
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted time span
+     */
+    public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
+        $l = $this->getLocale($l);
+        $timestamp = $this->getDateTime($timestamp);
+        if ($baseTimestamp === null) {
+            $baseTimestamp = time();
+        }
+        $baseTimestamp = $this->getDateTime($baseTimestamp);
 
-		$diff = $timestamp->diff($baseTimestamp);
-		if ($diff->y > 0 || $diff->m > 0 || $diff->d > 0) {
-			return $this->formatDateSpan($timestamp, $baseTimestamp, $l);
-		}
+        $diff = $timestamp->diff($baseTimestamp);
+        if ($diff->y > 0 || $diff->m > 0 || $diff->d > 0) {
+            return $this->formatDateSpan($timestamp, $baseTimestamp, $l);
+        }
 
-		if ($diff->h > 0) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->n('in %n hour', 'in %n hours', $diff->h);
-			} else {
-				return $l->n('%n hour ago', '%n hours ago', $diff->h);
-			}
-		} else if ($diff->i > 0) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->n('in %n minute', 'in %n minutes', $diff->i);
-			} else {
-				return $l->n('%n minute ago', '%n minutes ago', $diff->i);
-			}
-		}
-		if ($timestamp > $baseTimestamp) {
-			return $l->t('in a few seconds');
-		} else {
-			return $l->t('seconds ago');
-		}
-	}
+        if ($diff->h > 0) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->n('in %n hour', 'in %n hours', $diff->h);
+            } else {
+                return $l->n('%n hour ago', '%n hours ago', $diff->h);
+            }
+        } else if ($diff->i > 0) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->n('in %n minute', 'in %n minutes', $diff->i);
+            } else {
+                return $l->n('%n minute ago', '%n minutes ago', $diff->i);
+            }
+        }
+        if ($timestamp > $baseTimestamp) {
+            return $l->t('in a few seconds');
+        } else {
+            return $l->t('seconds ago');
+        }
+    }
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
-	 * @param string		$formatDate		See formatDate() for description
-	 * @param string		$formatTime		See formatTime() for description
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date and time string
-	 */
-	public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
-	}
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+     * @param string		$formatDate		See formatDate() for description
+     * @param string		$formatTime		See formatTime() for description
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date and time string
+     */
+    public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
+    }
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$formatDate		See formatDate() for description
-	 * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
-	 * @param string	$formatTime		See formatTime() for description
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted relative date and time string
-	 */
-	public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		if (substr($formatDate, -1) !== '^' && substr($formatDate, -1) !== '*') {
-			$formatDate .= '^';
-		}
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$formatDate		See formatDate() for description
+     * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
+     * @param string	$formatTime		See formatTime() for description
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted relative date and time string
+     */
+    public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        if (substr($formatDate, -1) !== '^' && substr($formatDate, -1) !== '*') {
+            $formatDate .= '^';
+        }
 
-		return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
-	}
+        return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
+    }
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
-	 * @param string		$type		One of 'date', 'datetime' or 'time'
-	 * @param string		$format		Format string
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date and time string
-	 */
-	protected function format($timestamp, $type, $format, \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		$l = $this->getLocale($l);
-		$timeZone = $this->getTimeZone($timeZone);
-		$timestamp = $this->getDateTime($timestamp, $timeZone);
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+     * @param string		$type		One of 'date', 'datetime' or 'time'
+     * @param string		$format		Format string
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date and time string
+     */
+    protected function format($timestamp, $type, $format, \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        $l = $this->getLocale($l);
+        $timeZone = $this->getTimeZone($timeZone);
+        $timestamp = $this->getDateTime($timestamp, $timeZone);
 
-		return $l->l($type, $timestamp, array(
-			'width' => $format,
-		));
-	}
+        return $l->l($type, $timestamp, array(
+            'width' => $format,
+        ));
+    }
 }

lib/private/DB/Connection.php

Doc Comments +2 added lines, -2 removed lines

@@ -173,7 +173,7 @@ 
 	 * If an SQLLogger is configured, the execution is logged.
 	 *
 	 * @param string                                      $query  The SQL query to execute.
-	 * @param array                                       $params The parameters to bind to the query, if any.
+	 * @param string[]                                       $params The parameters to bind to the query, if any.
 	 * @param array                                       $types  The types the previous parameters are in.
 	 * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
 	 *
@@ -218,7 +218,7 @@ 
 	 * columns or sequences.
 	 *
 	 * @param string $seqName Name of the sequence object from which the ID should be returned.
-	 * @return string A string representation of the last inserted ID.
+	 * @return integer A string representation of the last inserted ID.
 	 */
 	public function lastInsertId($seqName = null) {
 		if ($seqName) {

Spacing +12 added lines, -12 removed lines

@@ -58,7 +58,7 @@ 
 			return parent::connect();
 		} catch (DBALException $e) {
 			// throw a new exception to prevent leaking info from the stacktrace
-			throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
+			throw new DBALException('Failed to connect to the database: '.$e->getMessage(), $e->getCode());
 		}
 	}
 
@@ -110,7 +110,7 @@ 
 		// 0 is the method where we use `getCallerBacktrace`
 		// 1 is the target method which uses the method we want to log
 		if (isset($traces[1])) {
-			return $traces[1]['file'] . ':' . $traces[1]['line'];
+			return $traces[1]['file'].':'.$traces[1]['line'];
 		}
 
 		return '';
@@ -156,7 +156,7 @@ 
 	 * @param int $offset
 	 * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
 	 */
-	public function prepare( $statement, $limit=null, $offset=null ) {
+	public function prepare($statement, $limit = null, $offset = null) {
 		if ($limit === -1) {
 			$limit = null;
 		}
@@ -321,7 +321,7 @@ 
 			throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
 		}
 
-		$tableName = $this->tablePrefix . $tableName;
+		$tableName = $this->tablePrefix.$tableName;
 		$this->lockedTable = $tableName;
 		$this->adapter->lockTable($tableName);
 	}
@@ -342,11 +342,11 @@ 
 	 * @return string
 	 */
 	public function getError() {
-		$msg = $this->errorCode() . ': ';
+		$msg = $this->errorCode().': ';
 		$errorInfo = $this->errorInfo();
 		if (is_array($errorInfo)) {
-			$msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
-			$msg .= 'Driver Code = '.$errorInfo[1] . ', ';
+			$msg .= 'SQLSTATE = '.$errorInfo[0].', ';
+			$msg .= 'Driver Code = '.$errorInfo[1].', ';
 			$msg .= 'Driver Message = '.$errorInfo[2];
 		}
 		return $msg;
@@ -358,9 +358,9 @@ 
 	 * @param string $table table name without the prefix
 	 */
 	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
+		$table = $this->tablePrefix.trim($table);
 		$schema = $this->getSchemaManager();
-		if($schema->tablesExist(array($table))) {
+		if ($schema->tablesExist(array($table))) {
 			$schema->dropTable($table);
 		}
 	}
@@ -371,8 +371,8 @@ 
 	 * @param string $table table name without the prefix
 	 * @return bool
 	 */
-	public function tableExists($table){
-		$table = $this->tablePrefix . trim($table);
+	public function tableExists($table) {
+		$table = $this->tablePrefix.trim($table);
 		$schema = $this->getSchemaManager();
 		return $schema->tablesExist(array($table));
 	}
@@ -383,7 +383,7 @@ 
 	 * @return string
 	 */
 	protected function replaceTablePrefix($statement) {
-		return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
+		return str_replace('*PREFIX*', $this->tablePrefix, $statement);
 	}
 
 	/**

Indentation +401 added lines, -401 removed lines

@@ -42,405 +42,405 @@
 use OCP\PreConditionNotMetException;
 
 class Connection extends \Doctrine\DBAL\Connection implements IDBConnection {
-	/**
-	 * @var string $tablePrefix
-	 */
-	protected $tablePrefix;
-
-	/**
-	 * @var \OC\DB\Adapter $adapter
-	 */
-	protected $adapter;
-
-	protected $lockedTable = null;
-
-	public function connect() {
-		try {
-			return parent::connect();
-		} catch (DBALException $e) {
-			// throw a new exception to prevent leaking info from the stacktrace
-			throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
-		}
-	}
-
-	/**
-	 * Returns a QueryBuilder for the connection.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
-	 */
-	public function getQueryBuilder() {
-		return new QueryBuilder(
-			$this,
-			\OC::$server->getSystemConfig(),
-			\OC::$server->getLogger()
-		);
-	}
-
-	/**
-	 * Gets the QueryBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\QueryBuilder
-	 * @deprecated please use $this->getQueryBuilder() instead
-	 */
-	public function createQueryBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
-		return parent::createQueryBuilder();
-	}
-
-	/**
-	 * Gets the ExpressionBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
-	 * @deprecated please use $this->getQueryBuilder()->expr() instead
-	 */
-	public function getExpressionBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
-		return parent::getExpressionBuilder();
-	}
-
-	/**
-	 * Get the file and line that called the method where `getCallerBacktrace()` was used
-	 *
-	 * @return string
-	 */
-	protected function getCallerBacktrace() {
-		$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
-
-		// 0 is the method where we use `getCallerBacktrace`
-		// 1 is the target method which uses the method we want to log
-		if (isset($traces[1])) {
-			return $traces[1]['file'] . ':' . $traces[1]['line'];
-		}
-
-		return '';
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getPrefix() {
-		return $this->tablePrefix;
-	}
-
-	/**
-	 * Initializes a new instance of the Connection class.
-	 *
-	 * @param array $params  The connection parameters.
-	 * @param \Doctrine\DBAL\Driver $driver
-	 * @param \Doctrine\DBAL\Configuration $config
-	 * @param \Doctrine\Common\EventManager $eventManager
-	 * @throws \Exception
-	 */
-	public function __construct(array $params, Driver $driver, Configuration $config = null,
-		EventManager $eventManager = null)
-	{
-		if (!isset($params['adapter'])) {
-			throw new \Exception('adapter not set');
-		}
-		if (!isset($params['tablePrefix'])) {
-			throw new \Exception('tablePrefix not set');
-		}
-		parent::__construct($params, $driver, $config, $eventManager);
-		$this->adapter = new $params['adapter']($this);
-		$this->tablePrefix = $params['tablePrefix'];
-
-		parent::setTransactionIsolation(parent::TRANSACTION_READ_COMMITTED);
-	}
-
-	/**
-	 * Prepares an SQL statement.
-	 *
-	 * @param string $statement The SQL statement to prepare.
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
-	 */
-	public function prepare( $statement, $limit=null, $offset=null ) {
-		if ($limit === -1) {
-			$limit = null;
-		}
-		if (!is_null($limit)) {
-			$platform = $this->getDatabasePlatform();
-			$statement = $platform->modifyLimitQuery($statement, $limit, $offset);
-		}
-		$statement = $this->replaceTablePrefix($statement);
-		$statement = $this->adapter->fixupStatement($statement);
-
-		return parent::prepare($statement);
-	}
-
-	/**
-	 * Executes an, optionally parametrized, SQL query.
-	 *
-	 * If the query is parametrized, a prepared statement is used.
-	 * If an SQLLogger is configured, the execution is logged.
-	 *
-	 * @param string                                      $query  The SQL query to execute.
-	 * @param array                                       $params The parameters to bind to the query, if any.
-	 * @param array                                       $types  The types the previous parameters are in.
-	 * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
-	 *
-	 * @return \Doctrine\DBAL\Driver\Statement The executed statement.
-	 *
-	 * @throws \Doctrine\DBAL\DBALException
-	 */
-	public function executeQuery($query, array $params = array(), $types = array(), QueryCacheProfile $qcp = null)
-	{
-		$query = $this->replaceTablePrefix($query);
-		$query = $this->adapter->fixupStatement($query);
-		return parent::executeQuery($query, $params, $types, $qcp);
-	}
-
-	/**
-	 * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
-	 * and returns the number of affected rows.
-	 *
-	 * This method supports PDO binding types as well as DBAL mapping types.
-	 *
-	 * @param string $query  The SQL query.
-	 * @param array  $params The query parameters.
-	 * @param array  $types  The parameter types.
-	 *
-	 * @return integer The number of affected rows.
-	 *
-	 * @throws \Doctrine\DBAL\DBALException
-	 */
-	public function executeUpdate($query, array $params = array(), array $types = array())
-	{
-		$query = $this->replaceTablePrefix($query);
-		$query = $this->adapter->fixupStatement($query);
-		return parent::executeUpdate($query, $params, $types);
-	}
-
-	/**
-	 * Returns the ID of the last inserted row, or the last value from a sequence object,
-	 * depending on the underlying driver.
-	 *
-	 * Note: This method may not return a meaningful or consistent result across different drivers,
-	 * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
-	 * columns or sequences.
-	 *
-	 * @param string $seqName Name of the sequence object from which the ID should be returned.
-	 * @return string A string representation of the last inserted ID.
-	 */
-	public function lastInsertId($seqName = null) {
-		if ($seqName) {
-			$seqName = $this->replaceTablePrefix($seqName);
-		}
-		return $this->adapter->lastInsertId($seqName);
-	}
-
-	// internal use
-	public function realLastInsertId($seqName = null) {
-		return parent::lastInsertId($seqName);
-	}
-
-	/**
-	 * Insert a row if the matching row does not exists.
-	 *
-	 * @param string $table The table name (will replace *PREFIX* with the actual prefix)
-	 * @param array $input data that should be inserted into the table  (column name => value)
-	 * @param array|null $compare List of values that should be checked for "if not exists"
-	 *				If this is null or an empty array, all keys of $input will be compared
-	 *				Please note: text fields (clob) must not be used in the compare array
-	 * @return int number of inserted rows
-	 * @throws \Doctrine\DBAL\DBALException
-	 */
-	public function insertIfNotExist($table, $input, array $compare = null) {
-		return $this->adapter->insertIfNotExist($table, $input, $compare);
-	}
-
-	private function getType($value) {
-		if (is_bool($value)) {
-			return IQueryBuilder::PARAM_BOOL;
-		} else if (is_int($value)) {
-			return IQueryBuilder::PARAM_INT;
-		} else {
-			return IQueryBuilder::PARAM_STR;
-		}
-	}
-
-	/**
-	 * Insert or update a row value
-	 *
-	 * @param string $table
-	 * @param array $keys (column name => value)
-	 * @param array $values (column name => value)
-	 * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
-	 * @return int number of new rows
-	 * @throws \Doctrine\DBAL\DBALException
-	 * @throws PreConditionNotMetException
-	 * @suppress SqlInjectionChecker
-	 */
-	public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []) {
-		try {
-			$insertQb = $this->getQueryBuilder();
-			$insertQb->insert($table)
-				->values(
-					array_map(function($value) use ($insertQb) {
-						return $insertQb->createNamedParameter($value, $this->getType($value));
-					}, array_merge($keys, $values))
-				);
-			return $insertQb->execute();
-		} catch (ConstraintViolationException $e) {
-			// value already exists, try update
-			$updateQb = $this->getQueryBuilder();
-			$updateQb->update($table);
-			foreach ($values as $name => $value) {
-				$updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
-			}
-			$where = $updateQb->expr()->andX();
-			$whereValues = array_merge($keys, $updatePreconditionValues);
-			foreach ($whereValues as $name => $value) {
-				$where->add($updateQb->expr()->eq(
-					$name,
-					$updateQb->createNamedParameter($value, $this->getType($value)),
-					$this->getType($value)
-				));
-			}
-			$updateQb->where($where);
-			$affected = $updateQb->execute();
-
-			if ($affected === 0 && !empty($updatePreconditionValues)) {
-				throw new PreConditionNotMetException();
-			}
-
-			return 0;
-		}
-	}
-
-	/**
-	 * Create an exclusive read+write lock on a table
-	 *
-	 * @param string $tableName
-	 * @throws \BadMethodCallException When trying to acquire a second lock
-	 * @since 9.1.0
-	 */
-	public function lockTable($tableName) {
-		if ($this->lockedTable !== null) {
-			throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
-		}
-
-		$tableName = $this->tablePrefix . $tableName;
-		$this->lockedTable = $tableName;
-		$this->adapter->lockTable($tableName);
-	}
-
-	/**
-	 * Release a previous acquired lock again
-	 *
-	 * @since 9.1.0
-	 */
-	public function unlockTable() {
-		$this->adapter->unlockTable();
-		$this->lockedTable = null;
-	}
-
-	/**
-	 * returns the error code and message as a string for logging
-	 * works with DoctrineException
-	 * @return string
-	 */
-	public function getError() {
-		$msg = $this->errorCode() . ': ';
-		$errorInfo = $this->errorInfo();
-		if (is_array($errorInfo)) {
-			$msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
-			$msg .= 'Driver Code = '.$errorInfo[1] . ', ';
-			$msg .= 'Driver Message = '.$errorInfo[2];
-		}
-		return $msg;
-	}
-
-	/**
-	 * Drop a table from the database if it exists
-	 *
-	 * @param string $table table name without the prefix
-	 */
-	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
-		$schema = $this->getSchemaManager();
-		if($schema->tablesExist(array($table))) {
-			$schema->dropTable($table);
-		}
-	}
-
-	/**
-	 * Check if a table exists
-	 *
-	 * @param string $table table name without the prefix
-	 * @return bool
-	 */
-	public function tableExists($table){
-		$table = $this->tablePrefix . trim($table);
-		$schema = $this->getSchemaManager();
-		return $schema->tablesExist(array($table));
-	}
-
-	// internal use
-	/**
-	 * @param string $statement
-	 * @return string
-	 */
-	protected function replaceTablePrefix($statement) {
-		return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
-	}
-
-	/**
-	 * Check if a transaction is active
-	 *
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function inTransaction() {
-		return $this->getTransactionNestingLevel() > 0;
-	}
-
-	/**
-	 * Espace a parameter to be used in a LIKE query
-	 *
-	 * @param string $param
-	 * @return string
-	 */
-	public function escapeLikeParameter($param) {
-		return addcslashes($param, '\\_%');
-	}
-
-	/**
-	 * Check whether or not the current database support 4byte wide unicode
-	 *
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function supports4ByteText() {
-		if (!$this->getDatabasePlatform() instanceof MySqlPlatform) {
-			return true;
-		}
-		return $this->getParams()['charset'] === 'utf8mb4';
-	}
-
-
-	/**
-	 * Create the schema of the connected database
-	 *
-	 * @return Schema
-	 */
-	public function createSchema() {
-		$schemaManager = new MDB2SchemaManager($this);
-		$migrator = $schemaManager->getMigrator();
-		return $migrator->createSchema();
-	}
-
-	/**
-	 * Migrate the database to the given schema
-	 *
-	 * @param Schema $toSchema
-	 */
-	public function migrateToSchema(Schema $toSchema) {
-		$schemaManager = new MDB2SchemaManager($this);
-		$migrator = $schemaManager->getMigrator();
-		$migrator->migrate($toSchema);
-	}
+    /**
+     * @var string $tablePrefix
+     */
+    protected $tablePrefix;
+
+    /**
+     * @var \OC\DB\Adapter $adapter
+     */
+    protected $adapter;
+
+    protected $lockedTable = null;
+
+    public function connect() {
+        try {
+            return parent::connect();
+        } catch (DBALException $e) {
+            // throw a new exception to prevent leaking info from the stacktrace
+            throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
+        }
+    }
+
+    /**
+     * Returns a QueryBuilder for the connection.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder
+     */
+    public function getQueryBuilder() {
+        return new QueryBuilder(
+            $this,
+            \OC::$server->getSystemConfig(),
+            \OC::$server->getLogger()
+        );
+    }
+
+    /**
+     * Gets the QueryBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\QueryBuilder
+     * @deprecated please use $this->getQueryBuilder() instead
+     */
+    public function createQueryBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
+        return parent::createQueryBuilder();
+    }
+
+    /**
+     * Gets the ExpressionBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
+     * @deprecated please use $this->getQueryBuilder()->expr() instead
+     */
+    public function getExpressionBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
+        return parent::getExpressionBuilder();
+    }
+
+    /**
+     * Get the file and line that called the method where `getCallerBacktrace()` was used
+     *
+     * @return string
+     */
+    protected function getCallerBacktrace() {
+        $traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
+
+        // 0 is the method where we use `getCallerBacktrace`
+        // 1 is the target method which uses the method we want to log
+        if (isset($traces[1])) {
+            return $traces[1]['file'] . ':' . $traces[1]['line'];
+        }
+
+        return '';
+    }
+
+    /**
+     * @return string
+     */
+    public function getPrefix() {
+        return $this->tablePrefix;
+    }
+
+    /**
+     * Initializes a new instance of the Connection class.
+     *
+     * @param array $params  The connection parameters.
+     * @param \Doctrine\DBAL\Driver $driver
+     * @param \Doctrine\DBAL\Configuration $config
+     * @param \Doctrine\Common\EventManager $eventManager
+     * @throws \Exception
+     */
+    public function __construct(array $params, Driver $driver, Configuration $config = null,
+        EventManager $eventManager = null)
+    {
+        if (!isset($params['adapter'])) {
+            throw new \Exception('adapter not set');
+        }
+        if (!isset($params['tablePrefix'])) {
+            throw new \Exception('tablePrefix not set');
+        }
+        parent::__construct($params, $driver, $config, $eventManager);
+        $this->adapter = new $params['adapter']($this);
+        $this->tablePrefix = $params['tablePrefix'];
+
+        parent::setTransactionIsolation(parent::TRANSACTION_READ_COMMITTED);
+    }
+
+    /**
+     * Prepares an SQL statement.
+     *
+     * @param string $statement The SQL statement to prepare.
+     * @param int $limit
+     * @param int $offset
+     * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
+     */
+    public function prepare( $statement, $limit=null, $offset=null ) {
+        if ($limit === -1) {
+            $limit = null;
+        }
+        if (!is_null($limit)) {
+            $platform = $this->getDatabasePlatform();
+            $statement = $platform->modifyLimitQuery($statement, $limit, $offset);
+        }
+        $statement = $this->replaceTablePrefix($statement);
+        $statement = $this->adapter->fixupStatement($statement);
+
+        return parent::prepare($statement);
+    }
+
+    /**
+     * Executes an, optionally parametrized, SQL query.
+     *
+     * If the query is parametrized, a prepared statement is used.
+     * If an SQLLogger is configured, the execution is logged.
+     *
+     * @param string                                      $query  The SQL query to execute.
+     * @param array                                       $params The parameters to bind to the query, if any.
+     * @param array                                       $types  The types the previous parameters are in.
+     * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
+     *
+     * @return \Doctrine\DBAL\Driver\Statement The executed statement.
+     *
+     * @throws \Doctrine\DBAL\DBALException
+     */
+    public function executeQuery($query, array $params = array(), $types = array(), QueryCacheProfile $qcp = null)
+    {
+        $query = $this->replaceTablePrefix($query);
+        $query = $this->adapter->fixupStatement($query);
+        return parent::executeQuery($query, $params, $types, $qcp);
+    }
+
+    /**
+     * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
+     * and returns the number of affected rows.
+     *
+     * This method supports PDO binding types as well as DBAL mapping types.
+     *
+     * @param string $query  The SQL query.
+     * @param array  $params The query parameters.
+     * @param array  $types  The parameter types.
+     *
+     * @return integer The number of affected rows.
+     *
+     * @throws \Doctrine\DBAL\DBALException
+     */
+    public function executeUpdate($query, array $params = array(), array $types = array())
+    {
+        $query = $this->replaceTablePrefix($query);
+        $query = $this->adapter->fixupStatement($query);
+        return parent::executeUpdate($query, $params, $types);
+    }
+
+    /**
+     * Returns the ID of the last inserted row, or the last value from a sequence object,
+     * depending on the underlying driver.
+     *
+     * Note: This method may not return a meaningful or consistent result across different drivers,
+     * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
+     * columns or sequences.
+     *
+     * @param string $seqName Name of the sequence object from which the ID should be returned.
+     * @return string A string representation of the last inserted ID.
+     */
+    public function lastInsertId($seqName = null) {
+        if ($seqName) {
+            $seqName = $this->replaceTablePrefix($seqName);
+        }
+        return $this->adapter->lastInsertId($seqName);
+    }
+
+    // internal use
+    public function realLastInsertId($seqName = null) {
+        return parent::lastInsertId($seqName);
+    }
+
+    /**
+     * Insert a row if the matching row does not exists.
+     *
+     * @param string $table The table name (will replace *PREFIX* with the actual prefix)
+     * @param array $input data that should be inserted into the table  (column name => value)
+     * @param array|null $compare List of values that should be checked for "if not exists"
+     *				If this is null or an empty array, all keys of $input will be compared
+     *				Please note: text fields (clob) must not be used in the compare array
+     * @return int number of inserted rows
+     * @throws \Doctrine\DBAL\DBALException
+     */
+    public function insertIfNotExist($table, $input, array $compare = null) {
+        return $this->adapter->insertIfNotExist($table, $input, $compare);
+    }
+
+    private function getType($value) {
+        if (is_bool($value)) {
+            return IQueryBuilder::PARAM_BOOL;
+        } else if (is_int($value)) {
+            return IQueryBuilder::PARAM_INT;
+        } else {
+            return IQueryBuilder::PARAM_STR;
+        }
+    }
+
+    /**
+     * Insert or update a row value
+     *
+     * @param string $table
+     * @param array $keys (column name => value)
+     * @param array $values (column name => value)
+     * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
+     * @return int number of new rows
+     * @throws \Doctrine\DBAL\DBALException
+     * @throws PreConditionNotMetException
+     * @suppress SqlInjectionChecker
+     */
+    public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []) {
+        try {
+            $insertQb = $this->getQueryBuilder();
+            $insertQb->insert($table)
+                ->values(
+                    array_map(function($value) use ($insertQb) {
+                        return $insertQb->createNamedParameter($value, $this->getType($value));
+                    }, array_merge($keys, $values))
+                );
+            return $insertQb->execute();
+        } catch (ConstraintViolationException $e) {
+            // value already exists, try update
+            $updateQb = $this->getQueryBuilder();
+            $updateQb->update($table);
+            foreach ($values as $name => $value) {
+                $updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
+            }
+            $where = $updateQb->expr()->andX();
+            $whereValues = array_merge($keys, $updatePreconditionValues);
+            foreach ($whereValues as $name => $value) {
+                $where->add($updateQb->expr()->eq(
+                    $name,
+                    $updateQb->createNamedParameter($value, $this->getType($value)),
+                    $this->getType($value)
+                ));
+            }
+            $updateQb->where($where);
+            $affected = $updateQb->execute();
+
+            if ($affected === 0 && !empty($updatePreconditionValues)) {
+                throw new PreConditionNotMetException();
+            }
+
+            return 0;
+        }
+    }
+
+    /**
+     * Create an exclusive read+write lock on a table
+     *
+     * @param string $tableName
+     * @throws \BadMethodCallException When trying to acquire a second lock
+     * @since 9.1.0
+     */
+    public function lockTable($tableName) {
+        if ($this->lockedTable !== null) {
+            throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
+        }
+
+        $tableName = $this->tablePrefix . $tableName;
+        $this->lockedTable = $tableName;
+        $this->adapter->lockTable($tableName);
+    }
+
+    /**
+     * Release a previous acquired lock again
+     *
+     * @since 9.1.0
+     */
+    public function unlockTable() {
+        $this->adapter->unlockTable();
+        $this->lockedTable = null;
+    }
+
+    /**
+     * returns the error code and message as a string for logging
+     * works with DoctrineException
+     * @return string
+     */
+    public function getError() {
+        $msg = $this->errorCode() . ': ';
+        $errorInfo = $this->errorInfo();
+        if (is_array($errorInfo)) {
+            $msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
+            $msg .= 'Driver Code = '.$errorInfo[1] . ', ';
+            $msg .= 'Driver Message = '.$errorInfo[2];
+        }
+        return $msg;
+    }
+
+    /**
+     * Drop a table from the database if it exists
+     *
+     * @param string $table table name without the prefix
+     */
+    public function dropTable($table) {
+        $table = $this->tablePrefix . trim($table);
+        $schema = $this->getSchemaManager();
+        if($schema->tablesExist(array($table))) {
+            $schema->dropTable($table);
+        }
+    }
+
+    /**
+     * Check if a table exists
+     *
+     * @param string $table table name without the prefix
+     * @return bool
+     */
+    public function tableExists($table){
+        $table = $this->tablePrefix . trim($table);
+        $schema = $this->getSchemaManager();
+        return $schema->tablesExist(array($table));
+    }
+
+    // internal use
+    /**
+     * @param string $statement
+     * @return string
+     */
+    protected function replaceTablePrefix($statement) {
+        return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
+    }
+
+    /**
+     * Check if a transaction is active
+     *
+     * @return bool
+     * @since 8.2.0
+     */
+    public function inTransaction() {
+        return $this->getTransactionNestingLevel() > 0;
+    }
+
+    /**
+     * Espace a parameter to be used in a LIKE query
+     *
+     * @param string $param
+     * @return string
+     */
+    public function escapeLikeParameter($param) {
+        return addcslashes($param, '\\_%');
+    }
+
+    /**
+     * Check whether or not the current database support 4byte wide unicode
+     *
+     * @return bool
+     * @since 11.0.0
+     */
+    public function supports4ByteText() {
+        if (!$this->getDatabasePlatform() instanceof MySqlPlatform) {
+            return true;
+        }
+        return $this->getParams()['charset'] === 'utf8mb4';
+    }
+
+
+    /**
+     * Create the schema of the connected database
+     *
+     * @return Schema
+     */
+    public function createSchema() {
+        $schemaManager = new MDB2SchemaManager($this);
+        $migrator = $schemaManager->getMigrator();
+        return $migrator->createSchema();
+    }
+
+    /**
+     * Migrate the database to the given schema
+     *
+     * @param Schema $toSchema
+     */
+    public function migrateToSchema(Schema $toSchema) {
+        $schemaManager = new MDB2SchemaManager($this);
+        $migrator = $schemaManager->getMigrator();
+        $migrator->migrate($toSchema);
+    }
 }