nextcloud / server

lib/private/AppFramework/App.php

Indentation +157 added lines, -157 removed lines

@@ -47,167 +47,167 @@
  */
 class App {
 
-	/** @var string[] */
-	private static $nameSpaceCache = [];
-
-	/**
-	 * Turns an app id into a namespace by either reading the appinfo.xml's
-	 * namespace tag or uppercasing the appid's first letter
-	 * @param string $appId the app id
-	 * @param string $topNamespace the namespace which should be prepended to
-	 * the transformed app id, defaults to OCA\
-	 * @return string the starting namespace for the app
-	 */
-	public static function buildAppNamespace(string $appId, string $topNamespace='OCA\\'): string {
-		// Hit the cache!
-		if (isset(self::$nameSpaceCache[$appId])) {
-			return $topNamespace . self::$nameSpaceCache[$appId];
-		}
-
-		$appInfo = \OC_App::getAppInfo($appId);
-		if (isset($appInfo['namespace'])) {
-			self::$nameSpaceCache[$appId] = trim($appInfo['namespace']);
-		} else {
-			if ($appId !== 'spreed') {
-				// if the tag is not found, fall back to uppercasing the first letter
-				self::$nameSpaceCache[$appId] = ucfirst($appId);
-			} else {
-				// For the Talk app (appid spreed) the above fallback doesn't work.
-				// This leads to a problem when trying to install it freshly,
-				// because the apps namespace is already registered before the
-				// app is downloaded from the appstore, because of the hackish
-				// global route index.php/call/{token} which is registered via
-				// the core/routes.php so it does not have the app namespace.
-				// @ref https://github.com/nextcloud/server/pull/19433
-				self::$nameSpaceCache[$appId] = 'Talk';
-			}
-		}
-
-		return $topNamespace . self::$nameSpaceCache[$appId];
-	}
-
-
-	/**
-	 * Shortcut for calling a controller method and printing the result
-	 * @param string $controllerName the name of the controller under which it is
-	 *                               stored in the DI container
-	 * @param string $methodName the method that you want to call
-	 * @param DIContainer $container an instance of a pimple container.
-	 * @param array $urlParams list of URL parameters (optional)
-	 * @throws HintException
-	 */
-	public static function main(string $controllerName, string $methodName, DIContainer $container, array $urlParams = null) {
-		if (!is_null($urlParams)) {
-			$container->query(IRequest::class)->setUrlParameters($urlParams);
-		} else if (isset($container['urlParams']) && !is_null($container['urlParams'])) {
-			$container->query(IRequest::class)->setUrlParameters($container['urlParams']);
-		}
-		$appName = $container['AppName'];
-
-		// first try $controllerName then go for \OCA\AppName\Controller\$controllerName
-		try {
-			$controller = $container->query($controllerName);
-		} catch(QueryException $e) {
-			if (strpos($controllerName, '\\Controller\\') !== false) {
-				// This is from a global registered app route that is not enabled.
-				[/*OC(A)*/, $app, /* Controller/Name*/] = explode('\\', $controllerName, 3);
-				throw new HintException('App ' . strtolower($app) . ' is not enabled');
-			}
-
-			if ($appName === 'core') {
-				$appNameSpace = 'OC\\Core';
-			} else {
-				$appNameSpace = self::buildAppNamespace($appName);
-			}
-			$controllerName = $appNameSpace . '\\Controller\\' . $controllerName;
-			$controller = $container->query($controllerName);
-		}
-
-		// initialize the dispatcher and run all the middleware before the controller
-		/** @var Dispatcher $dispatcher */
-		$dispatcher = $container['Dispatcher'];
-
-		list(
-			$httpHeaders,
-			$responseHeaders,
-			$responseCookies,
-			$output,
-			$response
-		) = $dispatcher->dispatch($controller, $methodName);
-
-		$io = $container[IOutput::class];
-
-		if(!is_null($httpHeaders)) {
-			$io->setHeader($httpHeaders);
-		}
-
-		foreach($responseHeaders as $name => $value) {
-			$io->setHeader($name . ': ' . $value);
-		}
-
-		foreach($responseCookies as $name => $value) {
-			$expireDate = null;
-			if($value['expireDate'] instanceof \DateTime) {
-				$expireDate = $value['expireDate']->getTimestamp();
-			}
-			$io->setCookie(
-				$name,
-				$value['value'],
-				$expireDate,
-				$container->getServer()->getWebRoot(),
-				null,
-				$container->getServer()->getRequest()->getServerProtocol() === 'https',
-				true
-			);
-		}
-
-		/*
+    /** @var string[] */
+    private static $nameSpaceCache = [];
+
+    /**
+     * Turns an app id into a namespace by either reading the appinfo.xml's
+     * namespace tag or uppercasing the appid's first letter
+     * @param string $appId the app id
+     * @param string $topNamespace the namespace which should be prepended to
+     * the transformed app id, defaults to OCA\
+     * @return string the starting namespace for the app
+     */
+    public static function buildAppNamespace(string $appId, string $topNamespace='OCA\\'): string {
+        // Hit the cache!
+        if (isset(self::$nameSpaceCache[$appId])) {
+            return $topNamespace . self::$nameSpaceCache[$appId];
+        }
+
+        $appInfo = \OC_App::getAppInfo($appId);
+        if (isset($appInfo['namespace'])) {
+            self::$nameSpaceCache[$appId] = trim($appInfo['namespace']);
+        } else {
+            if ($appId !== 'spreed') {
+                // if the tag is not found, fall back to uppercasing the first letter
+                self::$nameSpaceCache[$appId] = ucfirst($appId);
+            } else {
+                // For the Talk app (appid spreed) the above fallback doesn't work.
+                // This leads to a problem when trying to install it freshly,
+                // because the apps namespace is already registered before the
+                // app is downloaded from the appstore, because of the hackish
+                // global route index.php/call/{token} which is registered via
+                // the core/routes.php so it does not have the app namespace.
+                // @ref https://github.com/nextcloud/server/pull/19433
+                self::$nameSpaceCache[$appId] = 'Talk';
+            }
+        }
+
+        return $topNamespace . self::$nameSpaceCache[$appId];
+    }
+
+
+    /**
+     * Shortcut for calling a controller method and printing the result
+     * @param string $controllerName the name of the controller under which it is
+     *                               stored in the DI container
+     * @param string $methodName the method that you want to call
+     * @param DIContainer $container an instance of a pimple container.
+     * @param array $urlParams list of URL parameters (optional)
+     * @throws HintException
+     */
+    public static function main(string $controllerName, string $methodName, DIContainer $container, array $urlParams = null) {
+        if (!is_null($urlParams)) {
+            $container->query(IRequest::class)->setUrlParameters($urlParams);
+        } else if (isset($container['urlParams']) && !is_null($container['urlParams'])) {
+            $container->query(IRequest::class)->setUrlParameters($container['urlParams']);
+        }
+        $appName = $container['AppName'];
+
+        // first try $controllerName then go for \OCA\AppName\Controller\$controllerName
+        try {
+            $controller = $container->query($controllerName);
+        } catch(QueryException $e) {
+            if (strpos($controllerName, '\\Controller\\') !== false) {
+                // This is from a global registered app route that is not enabled.
+                [/*OC(A)*/, $app, /* Controller/Name*/] = explode('\\', $controllerName, 3);
+                throw new HintException('App ' . strtolower($app) . ' is not enabled');
+            }
+
+            if ($appName === 'core') {
+                $appNameSpace = 'OC\\Core';
+            } else {
+                $appNameSpace = self::buildAppNamespace($appName);
+            }
+            $controllerName = $appNameSpace . '\\Controller\\' . $controllerName;
+            $controller = $container->query($controllerName);
+        }
+
+        // initialize the dispatcher and run all the middleware before the controller
+        /** @var Dispatcher $dispatcher */
+        $dispatcher = $container['Dispatcher'];
+
+        list(
+            $httpHeaders,
+            $responseHeaders,
+            $responseCookies,
+            $output,
+            $response
+        ) = $dispatcher->dispatch($controller, $methodName);
+
+        $io = $container[IOutput::class];
+
+        if(!is_null($httpHeaders)) {
+            $io->setHeader($httpHeaders);
+        }
+
+        foreach($responseHeaders as $name => $value) {
+            $io->setHeader($name . ': ' . $value);
+        }
+
+        foreach($responseCookies as $name => $value) {
+            $expireDate = null;
+            if($value['expireDate'] instanceof \DateTime) {
+                $expireDate = $value['expireDate']->getTimestamp();
+            }
+            $io->setCookie(
+                $name,
+                $value['value'],
+                $expireDate,
+                $container->getServer()->getWebRoot(),
+                null,
+                $container->getServer()->getRequest()->getServerProtocol() === 'https',
+                true
+            );
+        }
+
+        /*
 		 * Status 204 does not have a body and no Content Length
 		 * Status 304 does not have a body and does not need a Content Length
 		 * https://tools.ietf.org/html/rfc7230#section-3.3
 		 * https://tools.ietf.org/html/rfc7230#section-3.3.2
 		 */
-		$emptyResponse = false;
-		if (preg_match('/^HTTP\/\d\.\d (\d{3}) .*$/', $httpHeaders, $matches)) {
-			$status = (int)$matches[1];
-			if ($status === Http::STATUS_NO_CONTENT || $status === Http::STATUS_NOT_MODIFIED) {
-				$emptyResponse = true;
-			}
-		}
-
-		if (!$emptyResponse) {
-			if ($response instanceof ICallbackResponse) {
-				$response->callback($io);
-			} else if (!is_null($output)) {
-				$io->setHeader('Content-Length: ' . strlen($output));
-				$io->setOutput($output);
-			}
-		}
-
-	}
-
-	/**
-	 * Shortcut for calling a controller method and printing the result.
-	 * Similar to App:main except that no headers will be sent.
-	 * This should be used for example when registering sections via
-	 * \OC\AppFramework\Core\API::registerAdmin()
-	 *
-	 * @param string $controllerName the name of the controller under which it is
-	 *                               stored in the DI container
-	 * @param string $methodName the method that you want to call
-	 * @param array $urlParams an array with variables extracted from the routes
-	 * @param DIContainer $container an instance of a pimple container.
-	 */
-	public static function part(string $controllerName, string $methodName, array $urlParams,
-								DIContainer $container) {
-
-		$container['urlParams'] = $urlParams;
-		$controller = $container[$controllerName];
-
-		$dispatcher = $container['Dispatcher'];
-
-		list(, , $output) =  $dispatcher->dispatch($controller, $methodName);
-		return $output;
-	}
+        $emptyResponse = false;
+        if (preg_match('/^HTTP\/\d\.\d (\d{3}) .*$/', $httpHeaders, $matches)) {
+            $status = (int)$matches[1];
+            if ($status === Http::STATUS_NO_CONTENT || $status === Http::STATUS_NOT_MODIFIED) {
+                $emptyResponse = true;
+            }
+        }
+
+        if (!$emptyResponse) {
+            if ($response instanceof ICallbackResponse) {
+                $response->callback($io);
+            } else if (!is_null($output)) {
+                $io->setHeader('Content-Length: ' . strlen($output));
+                $io->setOutput($output);
+            }
+        }
+
+    }
+
+    /**
+     * Shortcut for calling a controller method and printing the result.
+     * Similar to App:main except that no headers will be sent.
+     * This should be used for example when registering sections via
+     * \OC\AppFramework\Core\API::registerAdmin()
+     *
+     * @param string $controllerName the name of the controller under which it is
+     *                               stored in the DI container
+     * @param string $methodName the method that you want to call
+     * @param array $urlParams an array with variables extracted from the routes
+     * @param DIContainer $container an instance of a pimple container.
+     */
+    public static function part(string $controllerName, string $methodName, array $urlParams,
+                                DIContainer $container) {
+
+        $container['urlParams'] = $urlParams;
+        $controller = $container[$controllerName];
+
+        $dispatcher = $container['Dispatcher'];
+
+        list(, , $output) =  $dispatcher->dispatch($controller, $methodName);
+        return $output;
+    }
 
 }

Spacing +14 added lines, -14 removed lines

@@ -58,10 +58,10 @@ 
 	 * the transformed app id, defaults to OCA\
 	 * @return string the starting namespace for the app
 	 */
-	public static function buildAppNamespace(string $appId, string $topNamespace='OCA\\'): string {
+	public static function buildAppNamespace(string $appId, string $topNamespace = 'OCA\\'): string {
 		// Hit the cache!
 		if (isset(self::$nameSpaceCache[$appId])) {
-			return $topNamespace . self::$nameSpaceCache[$appId];
+			return $topNamespace.self::$nameSpaceCache[$appId];
 		}
 
 		$appInfo = \OC_App::getAppInfo($appId);
@@ -83,7 +83,7 @@ 
 			}
 		}
 
-		return $topNamespace . self::$nameSpaceCache[$appId];
+		return $topNamespace.self::$nameSpaceCache[$appId];
 	}
 
 
@@ -107,11 +107,11 @@ 
 		// first try $controllerName then go for \OCA\AppName\Controller\$controllerName
 		try {
 			$controller = $container->query($controllerName);
-		} catch(QueryException $e) {
+		} catch (QueryException $e) {
 			if (strpos($controllerName, '\\Controller\\') !== false) {
 				// This is from a global registered app route that is not enabled.
 				[/*OC(A)*/, $app, /* Controller/Name*/] = explode('\\', $controllerName, 3);
-				throw new HintException('App ' . strtolower($app) . ' is not enabled');
+				throw new HintException('App '.strtolower($app).' is not enabled');
 			}
 
 			if ($appName === 'core') {
@@ -119,7 +119,7 @@ 
 			} else {
 				$appNameSpace = self::buildAppNamespace($appName);
 			}
-			$controllerName = $appNameSpace . '\\Controller\\' . $controllerName;
+			$controllerName = $appNameSpace.'\\Controller\\'.$controllerName;
 			$controller = $container->query($controllerName);
 		}
 
@@ -137,17 +137,17 @@ 
 
 		$io = $container[IOutput::class];
 
-		if(!is_null($httpHeaders)) {
+		if (!is_null($httpHeaders)) {
 			$io->setHeader($httpHeaders);
 		}
 
-		foreach($responseHeaders as $name => $value) {
-			$io->setHeader($name . ': ' . $value);
+		foreach ($responseHeaders as $name => $value) {
+			$io->setHeader($name.': '.$value);
 		}
 
-		foreach($responseCookies as $name => $value) {
+		foreach ($responseCookies as $name => $value) {
 			$expireDate = null;
-			if($value['expireDate'] instanceof \DateTime) {
+			if ($value['expireDate'] instanceof \DateTime) {
 				$expireDate = $value['expireDate']->getTimestamp();
 			}
 			$io->setCookie(
@@ -169,7 +169,7 @@ 
 		 */
 		$emptyResponse = false;
 		if (preg_match('/^HTTP\/\d\.\d (\d{3}) .*$/', $httpHeaders, $matches)) {
-			$status = (int)$matches[1];
+			$status = (int) $matches[1];
 			if ($status === Http::STATUS_NO_CONTENT || $status === Http::STATUS_NOT_MODIFIED) {
 				$emptyResponse = true;
 			}
@@ -179,7 +179,7 @@ 
 			if ($response instanceof ICallbackResponse) {
 				$response->callback($io);
 			} else if (!is_null($output)) {
-				$io->setHeader('Content-Length: ' . strlen($output));
+				$io->setHeader('Content-Length: '.strlen($output));
 				$io->setOutput($output);
 			}
 		}
@@ -206,7 +206,7 @@ 
 
 		$dispatcher = $container['Dispatcher'];
 
-		list(, , $output) =  $dispatcher->dispatch($controller, $methodName);
+		list(,, $output) = $dispatcher->dispatch($controller, $methodName);
 		return $output;
 	}
 

lib/private/DB/Connection.php

Indentation +406 added lines, -406 removed lines

@@ -47,410 +47,410 @@
 use OCP\PreConditionNotMetException;
 
 class Connection extends ReconnectWrapper 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'];
-	}
-
-	/**
-	 * 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 = [], $types = [], 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 $types = [])
-	{
-		$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. To accomplish proper race condition avoidance
-	 * it is needed that there is also a unique constraint on the values. Then this method will
-	 * catch the exception and return 0.
-	 *
-	 * @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
-	 * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
-	 */
-	public function insertIfNotExist($table, $input, array $compare = null) {
-		return $this->adapter->insertIfNotExist($table, $input, $compare);
-	}
-
-	public function insertIgnoreConflict(string $table, array $values) : int {
-		return $this->adapter->insertIgnoreConflict($table, $values);
-	}
-
-	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([$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([$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;
-	}
-
-	/**
-	 * Escape 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'];
+    }
+
+    /**
+     * 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 = [], $types = [], 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 $types = [])
+    {
+        $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. To accomplish proper race condition avoidance
+     * it is needed that there is also a unique constraint on the values. Then this method will
+     * catch the exception and return 0.
+     *
+     * @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
+     * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
+     */
+    public function insertIfNotExist($table, $input, array $compare = null) {
+        return $this->adapter->insertIfNotExist($table, $input, $compare);
+    }
+
+    public function insertIgnoreConflict(string $table, array $values) : int {
+        return $this->adapter->insertIgnoreConflict($table, $values);
+    }
+
+    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([$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([$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;
+    }
+
+    /**
+     * Escape 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);
+    }
 }

Spacing +12 added lines, -12 removed lines

@@ -64,7 +64,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());
 		}
 	}
 
@@ -116,7 +116,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 '';
@@ -160,7 +160,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;
 		}
@@ -289,7 +289,7 @@ 
 			$insertQb = $this->getQueryBuilder();
 			$insertQb->insert($table)
 				->values(
-					array_map(function ($value) use ($insertQb) {
+					array_map(function($value) use ($insertQb) {
 						return $insertQb->createNamedParameter($value, $this->getType($value));
 					}, array_merge($keys, $values))
 				);
@@ -333,7 +333,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);
 	}
@@ -354,11 +354,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;
@@ -370,9 +370,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([$table])) {
+		if ($schema->tablesExist([$table])) {
 			$schema->dropTable($table);
 		}
 	}
@@ -384,7 +384,7 @@ 
 	 * @return bool
 	 */
 	public function tableExists($table) {
-		$table = $this->tablePrefix . trim($table);
+		$table = $this->tablePrefix.trim($table);
 		$schema = $this->getSchemaManager();
 		return $schema->tablesExist([$table]);
 	}
@@ -395,7 +395,7 @@ 
 	 * @return string
 	 */
 	protected function replaceTablePrefix($statement) {
-		return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
+		return str_replace('*PREFIX*', $this->tablePrefix, $statement);
 	}
 
 	/**

lib/private/DB/MigrationService.php

Indentation +523 added lines, -523 removed lines

@@ -45,527 +45,527 @@
 
 class MigrationService {
 
-	/** @var boolean */
-	private $migrationTableCreated;
-	/** @var array */
-	private $migrations;
-	/** @var IOutput */
-	private $output;
-	/** @var Connection */
-	private $connection;
-	/** @var string */
-	private $appName;
-	/** @var bool */
-	private $checkOracle;
-
-	/**
-	 * MigrationService constructor.
-	 *
-	 * @param $appName
-	 * @param IDBConnection $connection
-	 * @param AppLocator $appLocator
-	 * @param IOutput|null $output
-	 * @throws \Exception
-	 */
-	public function __construct($appName, IDBConnection $connection, IOutput $output = null, AppLocator $appLocator = null) {
-		$this->appName = $appName;
-		$this->connection = $connection;
-		$this->output = $output;
-		if (null === $this->output) {
-			$this->output = new SimpleOutput(\OC::$server->getLogger(), $appName);
-		}
-
-		if ($appName === 'core') {
-			$this->migrationsPath = \OC::$SERVERROOT . '/core/Migrations';
-			$this->migrationsNamespace = 'OC\\Core\\Migrations';
-			$this->checkOracle = true;
-		} else {
-			if (null === $appLocator) {
-				$appLocator = new AppLocator();
-			}
-			$appPath = $appLocator->getAppPath($appName);
-			$namespace = App::buildAppNamespace($appName);
-			$this->migrationsPath = "$appPath/lib/Migration";
-			$this->migrationsNamespace = $namespace . '\\Migration';
-
-			$infoParser = new InfoParser();
-			$info = $infoParser->parse($appPath . '/appinfo/info.xml');
-			if (!isset($info['dependencies']['database'])) {
-				$this->checkOracle = true;
-			} else {
-				$this->checkOracle = false;
-				foreach ($info['dependencies']['database'] as $database) {
-					if (\is_string($database) && $database === 'oci') {
-						$this->checkOracle = true;
-					} else if (\is_array($database) && isset($database['@value']) && $database['@value'] === 'oci') {
-						$this->checkOracle = true;
-					}
-				}
-			}
-		}
-	}
-
-	/**
-	 * Returns the name of the app for which this migration is executed
-	 *
-	 * @return string
-	 */
-	public function getApp() {
-		return $this->appName;
-	}
-
-	/**
-	 * @return bool
-	 * @codeCoverageIgnore - this will implicitly tested on installation
-	 */
-	private function createMigrationTable() {
-		if ($this->migrationTableCreated) {
-			return false;
-		}
-
-		$schema = new SchemaWrapper($this->connection);
-
-		/**
-		 * We drop the table when it has different columns or the definition does not
-		 * match. E.g. ownCloud uses a length of 177 for app and 14 for version.
-		 */
-		try {
-			$table = $schema->getTable('migrations');
-			$columns = $table->getColumns();
-
-			if (count($columns) === 2) {
-				try {
-					$column = $table->getColumn('app');
-					$schemaMismatch = $column->getLength() !== 255;
-
-					if (!$schemaMismatch) {
-						$column = $table->getColumn('version');
-						$schemaMismatch = $column->getLength() !== 255;
-					}
-				} catch (SchemaException $e) {
-					// One of the columns is missing
-					$schemaMismatch = true;
-				}
-
-				if (!$schemaMismatch) {
-					// Table exists and schema matches: return back!
-					$this->migrationTableCreated = true;
-					return false;
-				}
-			}
-
-			// Drop the table, when it didn't match our expectations.
-			$this->connection->dropTable('migrations');
-
-			// Recreate the schema after the table was dropped.
-			$schema = new SchemaWrapper($this->connection);
-
-		} catch (SchemaException $e) {
-			// Table not found, no need to panic, we will create it.
-		}
-
-		$table = $schema->createTable('migrations');
-		$table->addColumn('app', Type::STRING, ['length' => 255]);
-		$table->addColumn('version', Type::STRING, ['length' => 255]);
-		$table->setPrimaryKey(['app', 'version']);
-
-		$this->connection->migrateToSchema($schema->getWrappedSchema());
-
-		$this->migrationTableCreated = true;
-
-		return true;
-	}
-
-	/**
-	 * Returns all versions which have already been applied
-	 *
-	 * @return string[]
-	 * @codeCoverageIgnore - no need to test this
-	 */
-	public function getMigratedVersions() {
-		$this->createMigrationTable();
-		$qb = $this->connection->getQueryBuilder();
-
-		$qb->select('version')
-			->from('migrations')
-			->where($qb->expr()->eq('app', $qb->createNamedParameter($this->getApp())))
-			->orderBy('version');
-
-		$result = $qb->execute();
-		$rows = $result->fetchAll(\PDO::FETCH_COLUMN);
-		$result->closeCursor();
-
-		return $rows;
-	}
-
-	/**
-	 * Returns all versions which are available in the migration folder
-	 *
-	 * @return array
-	 */
-	public function getAvailableVersions() {
-		$this->ensureMigrationsAreLoaded();
-		return array_map('strval', array_keys($this->migrations));
-	}
-
-	protected function findMigrations() {
-		$directory = realpath($this->migrationsPath);
-		if ($directory === false || !file_exists($directory) || !is_dir($directory)) {
-			return [];
-		}
-
-		$iterator = new \RegexIterator(
-			new \RecursiveIteratorIterator(
-				new \RecursiveDirectoryIterator($directory, \FilesystemIterator::SKIP_DOTS),
-				\RecursiveIteratorIterator::LEAVES_ONLY
-			),
-			'#^.+\\/Version[^\\/]{1,255}\\.php$#i',
-			\RegexIterator::GET_MATCH);
-
-		$files = array_keys(iterator_to_array($iterator));
-		uasort($files, function ($a, $b) {
-			preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($a), $matchA);
-			preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($b), $matchB);
-			if (!empty($matchA) && !empty($matchB)) {
-				if ($matchA[1] !== $matchB[1]) {
-					return ($matchA[1] < $matchB[1]) ? -1 : 1;
-				}
-				return ($matchA[2] < $matchB[2]) ? -1 : 1;
-			}
-			return (basename($a) < basename($b)) ? -1 : 1;
-		});
-
-		$migrations = [];
-
-		foreach ($files as $file) {
-			$className = basename($file, '.php');
-			$version = (string) substr($className, 7);
-			if ($version === '0') {
-				throw new \InvalidArgumentException(
-					"Cannot load a migrations with the name '$version' because it is a reserved number"
-				);
-			}
-			$migrations[$version] = sprintf('%s\\%s', $this->migrationsNamespace, $className);
-		}
-
-		return $migrations;
-	}
-
-	/**
-	 * @param string $to
-	 * @return string[]
-	 */
-	private function getMigrationsToExecute($to) {
-		$knownMigrations = $this->getMigratedVersions();
-		$availableMigrations = $this->getAvailableVersions();
-
-		$toBeExecuted = [];
-		foreach ($availableMigrations as $v) {
-			if ($to !== 'latest' && $v > $to) {
-				continue;
-			}
-			if ($this->shallBeExecuted($v, $knownMigrations)) {
-				$toBeExecuted[] = $v;
-			}
-		}
-
-		return $toBeExecuted;
-	}
-
-	/**
-	 * @param string $m
-	 * @param string[] $knownMigrations
-	 * @return bool
-	 */
-	private function shallBeExecuted($m, $knownMigrations) {
-		if (in_array($m, $knownMigrations)) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * @param string $version
-	 */
-	private function markAsExecuted($version) {
-		$this->connection->insertIfNotExist('*PREFIX*migrations', [
-			'app' => $this->appName,
-			'version' => $version
-		]);
-	}
-
-	/**
-	 * Returns the name of the table which holds the already applied versions
-	 *
-	 * @return string
-	 */
-	public function getMigrationsTableName() {
-		return $this->connection->getPrefix() . 'migrations';
-	}
-
-	/**
-	 * Returns the namespace of the version classes
-	 *
-	 * @return string
-	 */
-	public function getMigrationsNamespace() {
-		return $this->migrationsNamespace;
-	}
-
-	/**
-	 * Returns the directory which holds the versions
-	 *
-	 * @return string
-	 */
-	public function getMigrationsDirectory() {
-		return $this->migrationsPath;
-	}
-
-	/**
-	 * Return the explicit version for the aliases; current, next, prev, latest
-	 *
-	 * @param string $alias
-	 * @return mixed|null|string
-	 */
-	public function getMigration($alias) {
-		switch($alias) {
-			case 'current':
-				return $this->getCurrentVersion();
-			case 'next':
-				return $this->getRelativeVersion($this->getCurrentVersion(), 1);
-			case 'prev':
-				return $this->getRelativeVersion($this->getCurrentVersion(), -1);
-			case 'latest':
-				$this->ensureMigrationsAreLoaded();
-
-				$migrations = $this->getAvailableVersions();
-				return @end($migrations);
-		}
-		return '0';
-	}
-
-	/**
-	 * @param string $version
-	 * @param int $delta
-	 * @return null|string
-	 */
-	private function getRelativeVersion($version, $delta) {
-		$this->ensureMigrationsAreLoaded();
-
-		$versions = $this->getAvailableVersions();
-		array_unshift($versions, 0);
-		$offset = array_search($version, $versions, true);
-		if ($offset === false || !isset($versions[$offset + $delta])) {
-			// Unknown version or delta out of bounds.
-			return null;
-		}
-
-		return (string) $versions[$offset + $delta];
-	}
-
-	/**
-	 * @return string
-	 */
-	private function getCurrentVersion() {
-		$m = $this->getMigratedVersions();
-		if (count($m) === 0) {
-			return '0';
-		}
-		$migrations = array_values($m);
-		return @end($migrations);
-	}
-
-	/**
-	 * @param string $version
-	 * @return string
-	 * @throws \InvalidArgumentException
-	 */
-	private function getClass($version) {
-		$this->ensureMigrationsAreLoaded();
-
-		if (isset($this->migrations[$version])) {
-			return $this->migrations[$version];
-		}
-
-		throw new \InvalidArgumentException("Version $version is unknown.");
-	}
-
-	/**
-	 * Allows to set an IOutput implementation which is used for logging progress and messages
-	 *
-	 * @param IOutput $output
-	 */
-	public function setOutput(IOutput $output) {
-		$this->output = $output;
-	}
-
-	/**
-	 * Applies all not yet applied versions up to $to
-	 *
-	 * @param string $to
-	 * @param bool $schemaOnly
-	 * @throws \InvalidArgumentException
-	 */
-	public function migrate($to = 'latest', $schemaOnly = false) {
-		// read known migrations
-		$toBeExecuted = $this->getMigrationsToExecute($to);
-		foreach ($toBeExecuted as $version) {
-			$this->executeStep($version, $schemaOnly);
-		}
-	}
-
-	/**
-	 * Get the human readable descriptions for the migration steps to run
-	 *
-	 * @param string $to
-	 * @return string[] [$name => $description]
-	 */
-	public function describeMigrationStep($to = 'latest') {
-		$toBeExecuted = $this->getMigrationsToExecute($to);
-		$description = [];
-		foreach ($toBeExecuted as $version) {
-			$migration = $this->createInstance($version);
-			if ($migration->name()) {
-				$description[$migration->name()] = $migration->description();
-			}
-		}
-		return $description;
-	}
-
-	/**
-	 * @param string $version
-	 * @return IMigrationStep
-	 * @throws \InvalidArgumentException
-	 */
-	protected function createInstance($version) {
-		$class = $this->getClass($version);
-		try {
-			$s = \OC::$server->query($class);
-
-			if (!$s instanceof IMigrationStep) {
-				throw new \InvalidArgumentException('Not a valid migration');
-			}
-		} catch (QueryException $e) {
-			if (class_exists($class)) {
-				$s = new $class();
-			} else {
-				throw new \InvalidArgumentException("Migration step '$class' is unknown");
-			}
-		}
-
-		return $s;
-	}
-
-	/**
-	 * Executes one explicit version
-	 *
-	 * @param string $version
-	 * @param bool $schemaOnly
-	 * @throws \InvalidArgumentException
-	 */
-	public function executeStep($version, $schemaOnly = false) {
-		$instance = $this->createInstance($version);
-
-		if (!$schemaOnly) {
-			$instance->preSchemaChange($this->output, function () {
-				return new SchemaWrapper($this->connection);
-			}, ['tablePrefix' => $this->connection->getPrefix()]);
-		}
-
-		$toSchema = $instance->changeSchema($this->output, function () {
-			return new SchemaWrapper($this->connection);
-		}, ['tablePrefix' => $this->connection->getPrefix()]);
-
-		if ($toSchema instanceof SchemaWrapper) {
-			$targetSchema = $toSchema->getWrappedSchema();
-			if ($this->checkOracle) {
-				$sourceSchema = $this->connection->createSchema();
-				$this->ensureOracleIdentifierLengthLimit($sourceSchema, $targetSchema, strlen($this->connection->getPrefix()));
-			}
-			$this->connection->migrateToSchema($targetSchema);
-			$toSchema->performDropTableCalls();
-		}
-
-		if (!$schemaOnly) {
-			$instance->postSchemaChange($this->output, function () {
-				return new SchemaWrapper($this->connection);
-			}, ['tablePrefix' => $this->connection->getPrefix()]);
-		}
-
-		$this->markAsExecuted($version);
-	}
-
-	public function ensureOracleIdentifierLengthLimit(Schema $sourceSchema, Schema $targetSchema, int $prefixLength) {
-		$sequences = $targetSchema->getSequences();
-
-		foreach ($targetSchema->getTables() as $table) {
-			try {
-				$sourceTable = $sourceSchema->getTable($table->getName());
-			} catch (SchemaException $e) {
-				if (\strlen($table->getName()) - $prefixLength > 27) {
-					throw new \InvalidArgumentException('Table name "'  . $table->getName() . '" is too long.');
-				}
-				$sourceTable = null;
-			}
-
-			foreach ($table->getColumns() as $thing) {
-				if ((!$sourceTable instanceof Table || !$sourceTable->hasColumn($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Column name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
-				}
-			}
-
-			foreach ($table->getIndexes() as $thing) {
-				if ((!$sourceTable instanceof Table || !$sourceTable->hasIndex($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Index name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
-				}
-			}
-
-			foreach ($table->getForeignKeys() as $thing) {
-				if ((!$sourceTable instanceof Table || !$sourceTable->hasForeignKey($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Foreign key name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
-				}
-			}
-
-			$primaryKey = $table->getPrimaryKey();
-			if ($primaryKey instanceof Index && (!$sourceTable instanceof Table || !$sourceTable->hasPrimaryKey())) {
-				$indexName = strtolower($primaryKey->getName());
-				$isUsingDefaultName = $indexName === 'primary';
-
-				if ($this->connection->getDatabasePlatform() instanceof PostgreSqlPlatform) {
-					$defaultName = $table->getName() . '_pkey';
-					$isUsingDefaultName = strtolower($defaultName) === $indexName;
-
-					if ($isUsingDefaultName) {
-						$sequenceName = $table->getName() . '_' . implode('_', $primaryKey->getColumns()) . '_seq';
-						$sequences = array_filter($sequences, function (Sequence $sequence) use ($sequenceName) {
-							return $sequence->getName() !== $sequenceName;
-						});
-					}
-				} else if ($this->connection->getDatabasePlatform() instanceof OraclePlatform) {
-					$defaultName = $table->getName() . '_seq';
-					$isUsingDefaultName = strtolower($defaultName) === $indexName;
-				}
-
-				if (!$isUsingDefaultName && \strlen($indexName) > 30) {
-					throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
-				}
-				if ($isUsingDefaultName && \strlen($table->getName()) - $prefixLength >= 23) {
-					throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
-				}
-			}
-		}
-
-		foreach ($sequences as $sequence) {
-			if (!$sourceSchema->hasSequence($sequence->getName()) && \strlen($sequence->getName()) > 30) {
-				throw new \InvalidArgumentException('Sequence name "'  . $sequence->getName() . '" is too long.');
-			}
-		}
-	}
-
-	private function ensureMigrationsAreLoaded() {
-		if (empty($this->migrations)) {
-			$this->migrations = $this->findMigrations();
-		}
-	}
+    /** @var boolean */
+    private $migrationTableCreated;
+    /** @var array */
+    private $migrations;
+    /** @var IOutput */
+    private $output;
+    /** @var Connection */
+    private $connection;
+    /** @var string */
+    private $appName;
+    /** @var bool */
+    private $checkOracle;
+
+    /**
+     * MigrationService constructor.
+     *
+     * @param $appName
+     * @param IDBConnection $connection
+     * @param AppLocator $appLocator
+     * @param IOutput|null $output
+     * @throws \Exception
+     */
+    public function __construct($appName, IDBConnection $connection, IOutput $output = null, AppLocator $appLocator = null) {
+        $this->appName = $appName;
+        $this->connection = $connection;
+        $this->output = $output;
+        if (null === $this->output) {
+            $this->output = new SimpleOutput(\OC::$server->getLogger(), $appName);
+        }
+
+        if ($appName === 'core') {
+            $this->migrationsPath = \OC::$SERVERROOT . '/core/Migrations';
+            $this->migrationsNamespace = 'OC\\Core\\Migrations';
+            $this->checkOracle = true;
+        } else {
+            if (null === $appLocator) {
+                $appLocator = new AppLocator();
+            }
+            $appPath = $appLocator->getAppPath($appName);
+            $namespace = App::buildAppNamespace($appName);
+            $this->migrationsPath = "$appPath/lib/Migration";
+            $this->migrationsNamespace = $namespace . '\\Migration';
+
+            $infoParser = new InfoParser();
+            $info = $infoParser->parse($appPath . '/appinfo/info.xml');
+            if (!isset($info['dependencies']['database'])) {
+                $this->checkOracle = true;
+            } else {
+                $this->checkOracle = false;
+                foreach ($info['dependencies']['database'] as $database) {
+                    if (\is_string($database) && $database === 'oci') {
+                        $this->checkOracle = true;
+                    } else if (\is_array($database) && isset($database['@value']) && $database['@value'] === 'oci') {
+                        $this->checkOracle = true;
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Returns the name of the app for which this migration is executed
+     *
+     * @return string
+     */
+    public function getApp() {
+        return $this->appName;
+    }
+
+    /**
+     * @return bool
+     * @codeCoverageIgnore - this will implicitly tested on installation
+     */
+    private function createMigrationTable() {
+        if ($this->migrationTableCreated) {
+            return false;
+        }
+
+        $schema = new SchemaWrapper($this->connection);
+
+        /**
+         * We drop the table when it has different columns or the definition does not
+         * match. E.g. ownCloud uses a length of 177 for app and 14 for version.
+         */
+        try {
+            $table = $schema->getTable('migrations');
+            $columns = $table->getColumns();
+
+            if (count($columns) === 2) {
+                try {
+                    $column = $table->getColumn('app');
+                    $schemaMismatch = $column->getLength() !== 255;
+
+                    if (!$schemaMismatch) {
+                        $column = $table->getColumn('version');
+                        $schemaMismatch = $column->getLength() !== 255;
+                    }
+                } catch (SchemaException $e) {
+                    // One of the columns is missing
+                    $schemaMismatch = true;
+                }
+
+                if (!$schemaMismatch) {
+                    // Table exists and schema matches: return back!
+                    $this->migrationTableCreated = true;
+                    return false;
+                }
+            }
+
+            // Drop the table, when it didn't match our expectations.
+            $this->connection->dropTable('migrations');
+
+            // Recreate the schema after the table was dropped.
+            $schema = new SchemaWrapper($this->connection);
+
+        } catch (SchemaException $e) {
+            // Table not found, no need to panic, we will create it.
+        }
+
+        $table = $schema->createTable('migrations');
+        $table->addColumn('app', Type::STRING, ['length' => 255]);
+        $table->addColumn('version', Type::STRING, ['length' => 255]);
+        $table->setPrimaryKey(['app', 'version']);
+
+        $this->connection->migrateToSchema($schema->getWrappedSchema());
+
+        $this->migrationTableCreated = true;
+
+        return true;
+    }
+
+    /**
+     * Returns all versions which have already been applied
+     *
+     * @return string[]
+     * @codeCoverageIgnore - no need to test this
+     */
+    public function getMigratedVersions() {
+        $this->createMigrationTable();
+        $qb = $this->connection->getQueryBuilder();
+
+        $qb->select('version')
+            ->from('migrations')
+            ->where($qb->expr()->eq('app', $qb->createNamedParameter($this->getApp())))
+            ->orderBy('version');
+
+        $result = $qb->execute();
+        $rows = $result->fetchAll(\PDO::FETCH_COLUMN);
+        $result->closeCursor();
+
+        return $rows;
+    }
+
+    /**
+     * Returns all versions which are available in the migration folder
+     *
+     * @return array
+     */
+    public function getAvailableVersions() {
+        $this->ensureMigrationsAreLoaded();
+        return array_map('strval', array_keys($this->migrations));
+    }
+
+    protected function findMigrations() {
+        $directory = realpath($this->migrationsPath);
+        if ($directory === false || !file_exists($directory) || !is_dir($directory)) {
+            return [];
+        }
+
+        $iterator = new \RegexIterator(
+            new \RecursiveIteratorIterator(
+                new \RecursiveDirectoryIterator($directory, \FilesystemIterator::SKIP_DOTS),
+                \RecursiveIteratorIterator::LEAVES_ONLY
+            ),
+            '#^.+\\/Version[^\\/]{1,255}\\.php$#i',
+            \RegexIterator::GET_MATCH);
+
+        $files = array_keys(iterator_to_array($iterator));
+        uasort($files, function ($a, $b) {
+            preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($a), $matchA);
+            preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($b), $matchB);
+            if (!empty($matchA) && !empty($matchB)) {
+                if ($matchA[1] !== $matchB[1]) {
+                    return ($matchA[1] < $matchB[1]) ? -1 : 1;
+                }
+                return ($matchA[2] < $matchB[2]) ? -1 : 1;
+            }
+            return (basename($a) < basename($b)) ? -1 : 1;
+        });
+
+        $migrations = [];
+
+        foreach ($files as $file) {
+            $className = basename($file, '.php');
+            $version = (string) substr($className, 7);
+            if ($version === '0') {
+                throw new \InvalidArgumentException(
+                    "Cannot load a migrations with the name '$version' because it is a reserved number"
+                );
+            }
+            $migrations[$version] = sprintf('%s\\%s', $this->migrationsNamespace, $className);
+        }
+
+        return $migrations;
+    }
+
+    /**
+     * @param string $to
+     * @return string[]
+     */
+    private function getMigrationsToExecute($to) {
+        $knownMigrations = $this->getMigratedVersions();
+        $availableMigrations = $this->getAvailableVersions();
+
+        $toBeExecuted = [];
+        foreach ($availableMigrations as $v) {
+            if ($to !== 'latest' && $v > $to) {
+                continue;
+            }
+            if ($this->shallBeExecuted($v, $knownMigrations)) {
+                $toBeExecuted[] = $v;
+            }
+        }
+
+        return $toBeExecuted;
+    }
+
+    /**
+     * @param string $m
+     * @param string[] $knownMigrations
+     * @return bool
+     */
+    private function shallBeExecuted($m, $knownMigrations) {
+        if (in_array($m, $knownMigrations)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * @param string $version
+     */
+    private function markAsExecuted($version) {
+        $this->connection->insertIfNotExist('*PREFIX*migrations', [
+            'app' => $this->appName,
+            'version' => $version
+        ]);
+    }
+
+    /**
+     * Returns the name of the table which holds the already applied versions
+     *
+     * @return string
+     */
+    public function getMigrationsTableName() {
+        return $this->connection->getPrefix() . 'migrations';
+    }
+
+    /**
+     * Returns the namespace of the version classes
+     *
+     * @return string
+     */
+    public function getMigrationsNamespace() {
+        return $this->migrationsNamespace;
+    }
+
+    /**
+     * Returns the directory which holds the versions
+     *
+     * @return string
+     */
+    public function getMigrationsDirectory() {
+        return $this->migrationsPath;
+    }
+
+    /**
+     * Return the explicit version for the aliases; current, next, prev, latest
+     *
+     * @param string $alias
+     * @return mixed|null|string
+     */
+    public function getMigration($alias) {
+        switch($alias) {
+            case 'current':
+                return $this->getCurrentVersion();
+            case 'next':
+                return $this->getRelativeVersion($this->getCurrentVersion(), 1);
+            case 'prev':
+                return $this->getRelativeVersion($this->getCurrentVersion(), -1);
+            case 'latest':
+                $this->ensureMigrationsAreLoaded();
+
+                $migrations = $this->getAvailableVersions();
+                return @end($migrations);
+        }
+        return '0';
+    }
+
+    /**
+     * @param string $version
+     * @param int $delta
+     * @return null|string
+     */
+    private function getRelativeVersion($version, $delta) {
+        $this->ensureMigrationsAreLoaded();
+
+        $versions = $this->getAvailableVersions();
+        array_unshift($versions, 0);
+        $offset = array_search($version, $versions, true);
+        if ($offset === false || !isset($versions[$offset + $delta])) {
+            // Unknown version or delta out of bounds.
+            return null;
+        }
+
+        return (string) $versions[$offset + $delta];
+    }
+
+    /**
+     * @return string
+     */
+    private function getCurrentVersion() {
+        $m = $this->getMigratedVersions();
+        if (count($m) === 0) {
+            return '0';
+        }
+        $migrations = array_values($m);
+        return @end($migrations);
+    }
+
+    /**
+     * @param string $version
+     * @return string
+     * @throws \InvalidArgumentException
+     */
+    private function getClass($version) {
+        $this->ensureMigrationsAreLoaded();
+
+        if (isset($this->migrations[$version])) {
+            return $this->migrations[$version];
+        }
+
+        throw new \InvalidArgumentException("Version $version is unknown.");
+    }
+
+    /**
+     * Allows to set an IOutput implementation which is used for logging progress and messages
+     *
+     * @param IOutput $output
+     */
+    public function setOutput(IOutput $output) {
+        $this->output = $output;
+    }
+
+    /**
+     * Applies all not yet applied versions up to $to
+     *
+     * @param string $to
+     * @param bool $schemaOnly
+     * @throws \InvalidArgumentException
+     */
+    public function migrate($to = 'latest', $schemaOnly = false) {
+        // read known migrations
+        $toBeExecuted = $this->getMigrationsToExecute($to);
+        foreach ($toBeExecuted as $version) {
+            $this->executeStep($version, $schemaOnly);
+        }
+    }
+
+    /**
+     * Get the human readable descriptions for the migration steps to run
+     *
+     * @param string $to
+     * @return string[] [$name => $description]
+     */
+    public function describeMigrationStep($to = 'latest') {
+        $toBeExecuted = $this->getMigrationsToExecute($to);
+        $description = [];
+        foreach ($toBeExecuted as $version) {
+            $migration = $this->createInstance($version);
+            if ($migration->name()) {
+                $description[$migration->name()] = $migration->description();
+            }
+        }
+        return $description;
+    }
+
+    /**
+     * @param string $version
+     * @return IMigrationStep
+     * @throws \InvalidArgumentException
+     */
+    protected function createInstance($version) {
+        $class = $this->getClass($version);
+        try {
+            $s = \OC::$server->query($class);
+
+            if (!$s instanceof IMigrationStep) {
+                throw new \InvalidArgumentException('Not a valid migration');
+            }
+        } catch (QueryException $e) {
+            if (class_exists($class)) {
+                $s = new $class();
+            } else {
+                throw new \InvalidArgumentException("Migration step '$class' is unknown");
+            }
+        }
+
+        return $s;
+    }
+
+    /**
+     * Executes one explicit version
+     *
+     * @param string $version
+     * @param bool $schemaOnly
+     * @throws \InvalidArgumentException
+     */
+    public function executeStep($version, $schemaOnly = false) {
+        $instance = $this->createInstance($version);
+
+        if (!$schemaOnly) {
+            $instance->preSchemaChange($this->output, function () {
+                return new SchemaWrapper($this->connection);
+            }, ['tablePrefix' => $this->connection->getPrefix()]);
+        }
+
+        $toSchema = $instance->changeSchema($this->output, function () {
+            return new SchemaWrapper($this->connection);
+        }, ['tablePrefix' => $this->connection->getPrefix()]);
+
+        if ($toSchema instanceof SchemaWrapper) {
+            $targetSchema = $toSchema->getWrappedSchema();
+            if ($this->checkOracle) {
+                $sourceSchema = $this->connection->createSchema();
+                $this->ensureOracleIdentifierLengthLimit($sourceSchema, $targetSchema, strlen($this->connection->getPrefix()));
+            }
+            $this->connection->migrateToSchema($targetSchema);
+            $toSchema->performDropTableCalls();
+        }
+
+        if (!$schemaOnly) {
+            $instance->postSchemaChange($this->output, function () {
+                return new SchemaWrapper($this->connection);
+            }, ['tablePrefix' => $this->connection->getPrefix()]);
+        }
+
+        $this->markAsExecuted($version);
+    }
+
+    public function ensureOracleIdentifierLengthLimit(Schema $sourceSchema, Schema $targetSchema, int $prefixLength) {
+        $sequences = $targetSchema->getSequences();
+
+        foreach ($targetSchema->getTables() as $table) {
+            try {
+                $sourceTable = $sourceSchema->getTable($table->getName());
+            } catch (SchemaException $e) {
+                if (\strlen($table->getName()) - $prefixLength > 27) {
+                    throw new \InvalidArgumentException('Table name "'  . $table->getName() . '" is too long.');
+                }
+                $sourceTable = null;
+            }
+
+            foreach ($table->getColumns() as $thing) {
+                if ((!$sourceTable instanceof Table || !$sourceTable->hasColumn($thing->getName())) && \strlen($thing->getName()) > 30) {
+                    throw new \InvalidArgumentException('Column name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+                }
+            }
+
+            foreach ($table->getIndexes() as $thing) {
+                if ((!$sourceTable instanceof Table || !$sourceTable->hasIndex($thing->getName())) && \strlen($thing->getName()) > 30) {
+                    throw new \InvalidArgumentException('Index name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+                }
+            }
+
+            foreach ($table->getForeignKeys() as $thing) {
+                if ((!$sourceTable instanceof Table || !$sourceTable->hasForeignKey($thing->getName())) && \strlen($thing->getName()) > 30) {
+                    throw new \InvalidArgumentException('Foreign key name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+                }
+            }
+
+            $primaryKey = $table->getPrimaryKey();
+            if ($primaryKey instanceof Index && (!$sourceTable instanceof Table || !$sourceTable->hasPrimaryKey())) {
+                $indexName = strtolower($primaryKey->getName());
+                $isUsingDefaultName = $indexName === 'primary';
+
+                if ($this->connection->getDatabasePlatform() instanceof PostgreSqlPlatform) {
+                    $defaultName = $table->getName() . '_pkey';
+                    $isUsingDefaultName = strtolower($defaultName) === $indexName;
+
+                    if ($isUsingDefaultName) {
+                        $sequenceName = $table->getName() . '_' . implode('_', $primaryKey->getColumns()) . '_seq';
+                        $sequences = array_filter($sequences, function (Sequence $sequence) use ($sequenceName) {
+                            return $sequence->getName() !== $sequenceName;
+                        });
+                    }
+                } else if ($this->connection->getDatabasePlatform() instanceof OraclePlatform) {
+                    $defaultName = $table->getName() . '_seq';
+                    $isUsingDefaultName = strtolower($defaultName) === $indexName;
+                }
+
+                if (!$isUsingDefaultName && \strlen($indexName) > 30) {
+                    throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
+                }
+                if ($isUsingDefaultName && \strlen($table->getName()) - $prefixLength >= 23) {
+                    throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
+                }
+            }
+        }
+
+        foreach ($sequences as $sequence) {
+            if (!$sourceSchema->hasSequence($sequence->getName()) && \strlen($sequence->getName()) > 30) {
+                throw new \InvalidArgumentException('Sequence name "'  . $sequence->getName() . '" is too long.');
+            }
+        }
+    }
+
+    private function ensureMigrationsAreLoaded() {
+        if (empty($this->migrations)) {
+            $this->migrations = $this->findMigrations();
+        }
+    }
 }

Spacing +20 added lines, -20 removed lines

@@ -76,7 +76,7 @@ 
 		}
 
 		if ($appName === 'core') {
-			$this->migrationsPath = \OC::$SERVERROOT . '/core/Migrations';
+			$this->migrationsPath = \OC::$SERVERROOT.'/core/Migrations';
 			$this->migrationsNamespace = 'OC\\Core\\Migrations';
 			$this->checkOracle = true;
 		} else {
@@ -86,10 +86,10 @@ 
 			$appPath = $appLocator->getAppPath($appName);
 			$namespace = App::buildAppNamespace($appName);
 			$this->migrationsPath = "$appPath/lib/Migration";
-			$this->migrationsNamespace = $namespace . '\\Migration';
+			$this->migrationsNamespace = $namespace.'\\Migration';
 
 			$infoParser = new InfoParser();
-			$info = $infoParser->parse($appPath . '/appinfo/info.xml');
+			$info = $infoParser->parse($appPath.'/appinfo/info.xml');
 			if (!isset($info['dependencies']['database'])) {
 				$this->checkOracle = true;
 			} else {
@@ -223,7 +223,7 @@ 
 			\RegexIterator::GET_MATCH);
 
 		$files = array_keys(iterator_to_array($iterator));
-		uasort($files, function ($a, $b) {
+		uasort($files, function($a, $b) {
 			preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($a), $matchA);
 			preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($b), $matchB);
 			if (!empty($matchA) && !empty($matchB)) {
@@ -301,7 +301,7 @@ 
 	 * @return string
 	 */
 	public function getMigrationsTableName() {
-		return $this->connection->getPrefix() . 'migrations';
+		return $this->connection->getPrefix().'migrations';
 	}
 
 	/**
@@ -329,7 +329,7 @@ 
 	 * @return mixed|null|string
 	 */
 	public function getMigration($alias) {
-		switch($alias) {
+		switch ($alias) {
 			case 'current':
 				return $this->getCurrentVersion();
 			case 'next':
@@ -468,12 +468,12 @@ 
 		$instance = $this->createInstance($version);
 
 		if (!$schemaOnly) {
-			$instance->preSchemaChange($this->output, function () {
+			$instance->preSchemaChange($this->output, function() {
 				return new SchemaWrapper($this->connection);
 			}, ['tablePrefix' => $this->connection->getPrefix()]);
 		}
 
-		$toSchema = $instance->changeSchema($this->output, function () {
+		$toSchema = $instance->changeSchema($this->output, function() {
 			return new SchemaWrapper($this->connection);
 		}, ['tablePrefix' => $this->connection->getPrefix()]);
 
@@ -488,7 +488,7 @@ 
 		}
 
 		if (!$schemaOnly) {
-			$instance->postSchemaChange($this->output, function () {
+			$instance->postSchemaChange($this->output, function() {
 				return new SchemaWrapper($this->connection);
 			}, ['tablePrefix' => $this->connection->getPrefix()]);
 		}
@@ -504,26 +504,26 @@ 
 				$sourceTable = $sourceSchema->getTable($table->getName());
 			} catch (SchemaException $e) {
 				if (\strlen($table->getName()) - $prefixLength > 27) {
-					throw new \InvalidArgumentException('Table name "'  . $table->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Table name "'.$table->getName().'" is too long.');
 				}
 				$sourceTable = null;
 			}
 
 			foreach ($table->getColumns() as $thing) {
 				if ((!$sourceTable instanceof Table || !$sourceTable->hasColumn($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Column name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Column name "'.$table->getName().'"."'.$thing->getName().'" is too long.');
 				}
 			}
 
 			foreach ($table->getIndexes() as $thing) {
 				if ((!$sourceTable instanceof Table || !$sourceTable->hasIndex($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Index name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Index name "'.$table->getName().'"."'.$thing->getName().'" is too long.');
 				}
 			}
 
 			foreach ($table->getForeignKeys() as $thing) {
 				if ((!$sourceTable instanceof Table || !$sourceTable->hasForeignKey($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Foreign key name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Foreign key name "'.$table->getName().'"."'.$thing->getName().'" is too long.');
 				}
 			}
 
@@ -533,32 +533,32 @@ 
 				$isUsingDefaultName = $indexName === 'primary';
 
 				if ($this->connection->getDatabasePlatform() instanceof PostgreSqlPlatform) {
-					$defaultName = $table->getName() . '_pkey';
+					$defaultName = $table->getName().'_pkey';
 					$isUsingDefaultName = strtolower($defaultName) === $indexName;
 
 					if ($isUsingDefaultName) {
-						$sequenceName = $table->getName() . '_' . implode('_', $primaryKey->getColumns()) . '_seq';
-						$sequences = array_filter($sequences, function (Sequence $sequence) use ($sequenceName) {
+						$sequenceName = $table->getName().'_'.implode('_', $primaryKey->getColumns()).'_seq';
+						$sequences = array_filter($sequences, function(Sequence $sequence) use ($sequenceName) {
 							return $sequence->getName() !== $sequenceName;
 						});
 					}
 				} else if ($this->connection->getDatabasePlatform() instanceof OraclePlatform) {
-					$defaultName = $table->getName() . '_seq';
+					$defaultName = $table->getName().'_seq';
 					$isUsingDefaultName = strtolower($defaultName) === $indexName;
 				}
 
 				if (!$isUsingDefaultName && \strlen($indexName) > 30) {
-					throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Primary index name  on "'.$table->getName().'" is too long.');
 				}
 				if ($isUsingDefaultName && \strlen($table->getName()) - $prefixLength >= 23) {
-					throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Primary index name  on "'.$table->getName().'" is too long.');
 				}
 			}
 		}
 
 		foreach ($sequences as $sequence) {
 			if (!$sourceSchema->hasSequence($sequence->getName()) && \strlen($sequence->getName()) > 30) {
-				throw new \InvalidArgumentException('Sequence name "'  . $sequence->getName() . '" is too long.');
+				throw new \InvalidArgumentException('Sequence name "'.$sequence->getName().'" is too long.');
 			}
 		}
 	}

lib/private/DB/OracleConnection.php

Indentation +71 added lines, -71 removed lines

@@ -28,80 +28,80 @@
 namespace OC\DB;
 
 class OracleConnection extends Connection {
-	/**
-	 * Quote the keys of the array
-	 */
-	private function quoteKeys(array $data) {
-		$return = [];
-		$c = $this->getDatabasePlatform()->getIdentifierQuoteCharacter();
-		foreach($data as $key => $value) {
-			if ($key[0] !== $c) {
-				$return[$this->quoteIdentifier($key)] = $value;
-			} else {
-				$return[$key] = $value;
-			}
-		}
-		return $return;
-	}
+    /**
+     * Quote the keys of the array
+     */
+    private function quoteKeys(array $data) {
+        $return = [];
+        $c = $this->getDatabasePlatform()->getIdentifierQuoteCharacter();
+        foreach($data as $key => $value) {
+            if ($key[0] !== $c) {
+                $return[$this->quoteIdentifier($key)] = $value;
+            } else {
+                $return[$key] = $value;
+            }
+        }
+        return $return;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function insert($tableName, array $data, array $types = []) {
-		if ($tableName[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
-			$tableName = $this->quoteIdentifier($tableName);
-		}
-		$data = $this->quoteKeys($data);
-		return parent::insert($tableName, $data, $types);
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function insert($tableName, array $data, array $types = []) {
+        if ($tableName[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
+            $tableName = $this->quoteIdentifier($tableName);
+        }
+        $data = $this->quoteKeys($data);
+        return parent::insert($tableName, $data, $types);
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function update($tableName, array $data, array $identifier, array $types = []) {
-		if ($tableName[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
-			$tableName = $this->quoteIdentifier($tableName);
-		}
-		$data = $this->quoteKeys($data);
-		$identifier = $this->quoteKeys($identifier);
-		return parent::update($tableName, $data, $identifier, $types);
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function update($tableName, array $data, array $identifier, array $types = []) {
+        if ($tableName[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
+            $tableName = $this->quoteIdentifier($tableName);
+        }
+        $data = $this->quoteKeys($data);
+        $identifier = $this->quoteKeys($identifier);
+        return parent::update($tableName, $data, $identifier, $types);
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function delete($tableExpression, array $identifier, array $types = []) {
-		if ($tableExpression[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
-			$tableExpression = $this->quoteIdentifier($tableExpression);
-		}
-		$identifier = $this->quoteKeys($identifier);
-		return parent::delete($tableExpression, $identifier);
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function delete($tableExpression, array $identifier, array $types = []) {
+        if ($tableExpression[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
+            $tableExpression = $this->quoteIdentifier($tableExpression);
+        }
+        $identifier = $this->quoteKeys($identifier);
+        return parent::delete($tableExpression, $identifier);
+    }
 
-	/**
-	 * 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);
-		$table = $this->quoteIdentifier($table);
-		$schema = $this->getSchemaManager();
-		if($schema->tablesExist([$table])) {
-			$schema->dropTable($table);
-		}
-	}
+    /**
+     * 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);
+        $table = $this->quoteIdentifier($table);
+        $schema = $this->getSchemaManager();
+        if($schema->tablesExist([$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);
-		$table = $this->quoteIdentifier($table);
-		$schema = $this->getSchemaManager();
-		return $schema->tablesExist([$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);
+        $table = $this->quoteIdentifier($table);
+        $schema = $this->getSchemaManager();
+        return $schema->tablesExist([$table]);
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
 	private function quoteKeys(array $data) {
 		$return = [];
 		$c = $this->getDatabasePlatform()->getIdentifierQuoteCharacter();
-		foreach($data as $key => $value) {
+		foreach ($data as $key => $value) {
 			if ($key[0] !== $c) {
 				$return[$this->quoteIdentifier($key)] = $value;
 			} else {
@@ -84,10 +84,10 @@ 
 	 * @param string $table table name without the prefix
 	 */
 	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
+		$table = $this->tablePrefix.trim($table);
 		$table = $this->quoteIdentifier($table);
 		$schema = $this->getSchemaManager();
-		if($schema->tablesExist([$table])) {
+		if ($schema->tablesExist([$table])) {
 			$schema->dropTable($table);
 		}
 	}
@@ -99,7 +99,7 @@ 
 	 * @return bool
 	 */
 	public function tableExists($table) {
-		$table = $this->tablePrefix . trim($table);
+		$table = $this->tablePrefix.trim($table);
 		$table = $this->quoteIdentifier($table);
 		$schema = $this->getSchemaManager();
 		return $schema->tablesExist([$table]);

lib/private/DB/OracleMigrator.php

Indentation +189 added lines, -189 removed lines

@@ -39,194 +39,194 @@
 
 class OracleMigrator extends Migrator {
 
-	/**
-	 * Quote a column's name but changing the name requires recreating
-	 * the column instance and copying over all properties.
-	 *
-	 * @param Column $column old column
-	 * @return Column new column instance with new name
-	 */
-	protected function quoteColumn(Column $column) {
-		$newColumn = new Column(
-			$this->connection->quoteIdentifier($column->getName()),
-			$column->getType()
-		);
-		$newColumn->setAutoincrement($column->getAutoincrement());
-		$newColumn->setColumnDefinition($column->getColumnDefinition());
-		$newColumn->setComment($column->getComment());
-		$newColumn->setDefault($column->getDefault());
-		$newColumn->setFixed($column->getFixed());
-		$newColumn->setLength($column->getLength());
-		$newColumn->setNotnull($column->getNotnull());
-		$newColumn->setPrecision($column->getPrecision());
-		$newColumn->setScale($column->getScale());
-		$newColumn->setUnsigned($column->getUnsigned());
-		$newColumn->setPlatformOptions($column->getPlatformOptions());
-		$newColumn->setCustomSchemaOptions($column->getPlatformOptions());
-		return $newColumn;
-	}
-
-	/**
-	 * Quote an index's name but changing the name requires recreating
-	 * the index instance and copying over all properties.
-	 *
-	 * @param Index $index old index
-	 * @return Index new index instance with new name
-	 */
-	protected function quoteIndex($index) {
-		return new Index(
-		//TODO migrate existing uppercase indexes, then $this->connection->quoteIdentifier($index->getName()),
-			$index->getName(),
-			array_map(function ($columnName) {
-				return $this->connection->quoteIdentifier($columnName);
-			}, $index->getColumns()),
-			$index->isUnique(),
-			$index->isPrimary(),
-			$index->getFlags(),
-			$index->getOptions()
-		);
-	}
-
-	/**
-	 * Quote an ForeignKeyConstraint's name but changing the name requires recreating
-	 * the ForeignKeyConstraint instance and copying over all properties.
-	 *
-	 * @param ForeignKeyConstraint $fkc old fkc
-	 * @return ForeignKeyConstraint new fkc instance with new name
-	 */
-	protected function quoteForeignKeyConstraint($fkc) {
-		return new ForeignKeyConstraint(
-			array_map(function ($columnName) {
-				return $this->connection->quoteIdentifier($columnName);
-			}, $fkc->getLocalColumns()),
-			$this->connection->quoteIdentifier($fkc->getForeignTableName()),
-			array_map(function ($columnName) {
-				return $this->connection->quoteIdentifier($columnName);
-			}, $fkc->getForeignColumns()),
-			$fkc->getName(),
-			$fkc->getOptions()
-		);
-	}
-
-	/**
-	 * @param Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 * @return \Doctrine\DBAL\Schema\SchemaDiff
-	 * @throws DBALException
-	 */
-	protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
-		$schemaDiff = parent::getDiff($targetSchema, $connection);
-
-		// oracle forces us to quote the identifiers
-		$schemaDiff->newTables = array_map(function (Table $table) {
-			return new Table(
-				$this->connection->quoteIdentifier($table->getName()),
-				array_map(function (Column $column) {
-					return $this->quoteColumn($column);
-				}, $table->getColumns()),
-				array_map(function (Index $index) {
-					return $this->quoteIndex($index);
-				}, $table->getIndexes()),
-				array_map(function (ForeignKeyConstraint $fck) {
-					return $this->quoteForeignKeyConstraint($fck);
-				}, $table->getForeignKeys()),
-				0,
-				$table->getOptions()
-			);
-		}, $schemaDiff->newTables);
-
-		$schemaDiff->removedTables = array_map(function (Table $table) {
-			return new Table(
-				$this->connection->quoteIdentifier($table->getName()),
-				$table->getColumns(),
-				$table->getIndexes(),
-				$table->getForeignKeys(),
-				0,
-				$table->getOptions()
-			);
-		}, $schemaDiff->removedTables);
-
-		foreach ($schemaDiff->changedTables as $tableDiff) {
-			$tableDiff->name = $this->connection->quoteIdentifier($tableDiff->name);
-
-			$tableDiff->addedColumns = array_map(function (Column $column) {
-				return $this->quoteColumn($column);
-			}, $tableDiff->addedColumns);
-
-			foreach ($tableDiff->changedColumns as $column) {
-				$column->oldColumnName = $this->connection->quoteIdentifier($column->oldColumnName);
-				// auto increment is not relevant for oracle and can anyhow not be applied on change
-				$column->changedProperties = array_diff($column->changedProperties, ['autoincrement', 'unsigned']);
-			}
-			// remove columns that no longer have changed (because autoincrement and unsigned are not supported)
-			$tableDiff->changedColumns = array_filter($tableDiff->changedColumns, function (ColumnDiff $column) {
-				return count($column->changedProperties) > 0;
-			});
-
-			$tableDiff->removedColumns = array_map(function (Column $column) {
-				return $this->quoteColumn($column);
-			}, $tableDiff->removedColumns);
-
-			$tableDiff->renamedColumns = array_map(function (Column $column) {
-				return $this->quoteColumn($column);
-			}, $tableDiff->renamedColumns);
-
-			$tableDiff->addedIndexes = array_map(function (Index $index) {
-				return $this->quoteIndex($index);
-			}, $tableDiff->addedIndexes);
-
-			$tableDiff->changedIndexes = array_map(function (Index $index) {
-				return $this->quoteIndex($index);
-			}, $tableDiff->changedIndexes);
-
-			$tableDiff->removedIndexes = array_map(function (Index $index) {
-				return $this->quoteIndex($index);
-			}, $tableDiff->removedIndexes);
-
-			$tableDiff->renamedIndexes = array_map(function (Index $index) {
-				return $this->quoteIndex($index);
-			}, $tableDiff->renamedIndexes);
-
-			$tableDiff->addedForeignKeys = array_map(function (ForeignKeyConstraint $fkc) {
-				return $this->quoteForeignKeyConstraint($fkc);
-			}, $tableDiff->addedForeignKeys);
-
-			$tableDiff->changedForeignKeys = array_map(function (ForeignKeyConstraint $fkc) {
-				return $this->quoteForeignKeyConstraint($fkc);
-			}, $tableDiff->changedForeignKeys);
-
-			$tableDiff->removedForeignKeys = array_map(function (ForeignKeyConstraint $fkc) {
-				return $this->quoteForeignKeyConstraint($fkc);
-			}, $tableDiff->removedForeignKeys);
-		}
-
-		return $schemaDiff;
-	}
-
-	/**
-	 * @param string $name
-	 * @return string
-	 */
-	protected function generateTemporaryTableName($name) {
-		return 'oc_' . uniqid();
-	}
-
-	/**
-	 * @param $statement
-	 * @return string
-	 */
-	protected function convertStatementToScript($statement) {
-		if (substr($statement, -1) === ';') {
-			return $statement . PHP_EOL . '/' . PHP_EOL;
-		}
-		$script = $statement . ';';
-		$script .= PHP_EOL;
-		$script .= PHP_EOL;
-		return $script;
-	}
-
-	protected function getFilterExpression() {
-		return '/^"' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
-	}
+    /**
+     * Quote a column's name but changing the name requires recreating
+     * the column instance and copying over all properties.
+     *
+     * @param Column $column old column
+     * @return Column new column instance with new name
+     */
+    protected function quoteColumn(Column $column) {
+        $newColumn = new Column(
+            $this->connection->quoteIdentifier($column->getName()),
+            $column->getType()
+        );
+        $newColumn->setAutoincrement($column->getAutoincrement());
+        $newColumn->setColumnDefinition($column->getColumnDefinition());
+        $newColumn->setComment($column->getComment());
+        $newColumn->setDefault($column->getDefault());
+        $newColumn->setFixed($column->getFixed());
+        $newColumn->setLength($column->getLength());
+        $newColumn->setNotnull($column->getNotnull());
+        $newColumn->setPrecision($column->getPrecision());
+        $newColumn->setScale($column->getScale());
+        $newColumn->setUnsigned($column->getUnsigned());
+        $newColumn->setPlatformOptions($column->getPlatformOptions());
+        $newColumn->setCustomSchemaOptions($column->getPlatformOptions());
+        return $newColumn;
+    }
+
+    /**
+     * Quote an index's name but changing the name requires recreating
+     * the index instance and copying over all properties.
+     *
+     * @param Index $index old index
+     * @return Index new index instance with new name
+     */
+    protected function quoteIndex($index) {
+        return new Index(
+        //TODO migrate existing uppercase indexes, then $this->connection->quoteIdentifier($index->getName()),
+            $index->getName(),
+            array_map(function ($columnName) {
+                return $this->connection->quoteIdentifier($columnName);
+            }, $index->getColumns()),
+            $index->isUnique(),
+            $index->isPrimary(),
+            $index->getFlags(),
+            $index->getOptions()
+        );
+    }
+
+    /**
+     * Quote an ForeignKeyConstraint's name but changing the name requires recreating
+     * the ForeignKeyConstraint instance and copying over all properties.
+     *
+     * @param ForeignKeyConstraint $fkc old fkc
+     * @return ForeignKeyConstraint new fkc instance with new name
+     */
+    protected function quoteForeignKeyConstraint($fkc) {
+        return new ForeignKeyConstraint(
+            array_map(function ($columnName) {
+                return $this->connection->quoteIdentifier($columnName);
+            }, $fkc->getLocalColumns()),
+            $this->connection->quoteIdentifier($fkc->getForeignTableName()),
+            array_map(function ($columnName) {
+                return $this->connection->quoteIdentifier($columnName);
+            }, $fkc->getForeignColumns()),
+            $fkc->getName(),
+            $fkc->getOptions()
+        );
+    }
+
+    /**
+     * @param Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     * @return \Doctrine\DBAL\Schema\SchemaDiff
+     * @throws DBALException
+     */
+    protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
+        $schemaDiff = parent::getDiff($targetSchema, $connection);
+
+        // oracle forces us to quote the identifiers
+        $schemaDiff->newTables = array_map(function (Table $table) {
+            return new Table(
+                $this->connection->quoteIdentifier($table->getName()),
+                array_map(function (Column $column) {
+                    return $this->quoteColumn($column);
+                }, $table->getColumns()),
+                array_map(function (Index $index) {
+                    return $this->quoteIndex($index);
+                }, $table->getIndexes()),
+                array_map(function (ForeignKeyConstraint $fck) {
+                    return $this->quoteForeignKeyConstraint($fck);
+                }, $table->getForeignKeys()),
+                0,
+                $table->getOptions()
+            );
+        }, $schemaDiff->newTables);
+
+        $schemaDiff->removedTables = array_map(function (Table $table) {
+            return new Table(
+                $this->connection->quoteIdentifier($table->getName()),
+                $table->getColumns(),
+                $table->getIndexes(),
+                $table->getForeignKeys(),
+                0,
+                $table->getOptions()
+            );
+        }, $schemaDiff->removedTables);
+
+        foreach ($schemaDiff->changedTables as $tableDiff) {
+            $tableDiff->name = $this->connection->quoteIdentifier($tableDiff->name);
+
+            $tableDiff->addedColumns = array_map(function (Column $column) {
+                return $this->quoteColumn($column);
+            }, $tableDiff->addedColumns);
+
+            foreach ($tableDiff->changedColumns as $column) {
+                $column->oldColumnName = $this->connection->quoteIdentifier($column->oldColumnName);
+                // auto increment is not relevant for oracle and can anyhow not be applied on change
+                $column->changedProperties = array_diff($column->changedProperties, ['autoincrement', 'unsigned']);
+            }
+            // remove columns that no longer have changed (because autoincrement and unsigned are not supported)
+            $tableDiff->changedColumns = array_filter($tableDiff->changedColumns, function (ColumnDiff $column) {
+                return count($column->changedProperties) > 0;
+            });
+
+            $tableDiff->removedColumns = array_map(function (Column $column) {
+                return $this->quoteColumn($column);
+            }, $tableDiff->removedColumns);
+
+            $tableDiff->renamedColumns = array_map(function (Column $column) {
+                return $this->quoteColumn($column);
+            }, $tableDiff->renamedColumns);
+
+            $tableDiff->addedIndexes = array_map(function (Index $index) {
+                return $this->quoteIndex($index);
+            }, $tableDiff->addedIndexes);
+
+            $tableDiff->changedIndexes = array_map(function (Index $index) {
+                return $this->quoteIndex($index);
+            }, $tableDiff->changedIndexes);
+
+            $tableDiff->removedIndexes = array_map(function (Index $index) {
+                return $this->quoteIndex($index);
+            }, $tableDiff->removedIndexes);
+
+            $tableDiff->renamedIndexes = array_map(function (Index $index) {
+                return $this->quoteIndex($index);
+            }, $tableDiff->renamedIndexes);
+
+            $tableDiff->addedForeignKeys = array_map(function (ForeignKeyConstraint $fkc) {
+                return $this->quoteForeignKeyConstraint($fkc);
+            }, $tableDiff->addedForeignKeys);
+
+            $tableDiff->changedForeignKeys = array_map(function (ForeignKeyConstraint $fkc) {
+                return $this->quoteForeignKeyConstraint($fkc);
+            }, $tableDiff->changedForeignKeys);
+
+            $tableDiff->removedForeignKeys = array_map(function (ForeignKeyConstraint $fkc) {
+                return $this->quoteForeignKeyConstraint($fkc);
+            }, $tableDiff->removedForeignKeys);
+        }
+
+        return $schemaDiff;
+    }
+
+    /**
+     * @param string $name
+     * @return string
+     */
+    protected function generateTemporaryTableName($name) {
+        return 'oc_' . uniqid();
+    }
+
+    /**
+     * @param $statement
+     * @return string
+     */
+    protected function convertStatementToScript($statement) {
+        if (substr($statement, -1) === ';') {
+            return $statement . PHP_EOL . '/' . PHP_EOL;
+        }
+        $script = $statement . ';';
+        $script .= PHP_EOL;
+        $script .= PHP_EOL;
+        return $script;
+    }
+
+    protected function getFilterExpression() {
+        return '/^"' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+    }
 
 }

Spacing +23 added lines, -23 removed lines

@@ -77,7 +77,7 @@ 
 		return new Index(
 		//TODO migrate existing uppercase indexes, then $this->connection->quoteIdentifier($index->getName()),
 			$index->getName(),
-			array_map(function ($columnName) {
+			array_map(function($columnName) {
 				return $this->connection->quoteIdentifier($columnName);
 			}, $index->getColumns()),
 			$index->isUnique(),
@@ -96,11 +96,11 @@ 
 	 */
 	protected function quoteForeignKeyConstraint($fkc) {
 		return new ForeignKeyConstraint(
-			array_map(function ($columnName) {
+			array_map(function($columnName) {
 				return $this->connection->quoteIdentifier($columnName);
 			}, $fkc->getLocalColumns()),
 			$this->connection->quoteIdentifier($fkc->getForeignTableName()),
-			array_map(function ($columnName) {
+			array_map(function($columnName) {
 				return $this->connection->quoteIdentifier($columnName);
 			}, $fkc->getForeignColumns()),
 			$fkc->getName(),
@@ -118,16 +118,16 @@ 
 		$schemaDiff = parent::getDiff($targetSchema, $connection);
 
 		// oracle forces us to quote the identifiers
-		$schemaDiff->newTables = array_map(function (Table $table) {
+		$schemaDiff->newTables = array_map(function(Table $table) {
 			return new Table(
 				$this->connection->quoteIdentifier($table->getName()),
-				array_map(function (Column $column) {
+				array_map(function(Column $column) {
 					return $this->quoteColumn($column);
 				}, $table->getColumns()),
-				array_map(function (Index $index) {
+				array_map(function(Index $index) {
 					return $this->quoteIndex($index);
 				}, $table->getIndexes()),
-				array_map(function (ForeignKeyConstraint $fck) {
+				array_map(function(ForeignKeyConstraint $fck) {
 					return $this->quoteForeignKeyConstraint($fck);
 				}, $table->getForeignKeys()),
 				0,
@@ -135,7 +135,7 @@ 
 			);
 		}, $schemaDiff->newTables);
 
-		$schemaDiff->removedTables = array_map(function (Table $table) {
+		$schemaDiff->removedTables = array_map(function(Table $table) {
 			return new Table(
 				$this->connection->quoteIdentifier($table->getName()),
 				$table->getColumns(),
@@ -149,7 +149,7 @@ 
 		foreach ($schemaDiff->changedTables as $tableDiff) {
 			$tableDiff->name = $this->connection->quoteIdentifier($tableDiff->name);
 
-			$tableDiff->addedColumns = array_map(function (Column $column) {
+			$tableDiff->addedColumns = array_map(function(Column $column) {
 				return $this->quoteColumn($column);
 			}, $tableDiff->addedColumns);
 
@@ -159,43 +159,43 @@ 
 				$column->changedProperties = array_diff($column->changedProperties, ['autoincrement', 'unsigned']);
 			}
 			// remove columns that no longer have changed (because autoincrement and unsigned are not supported)
-			$tableDiff->changedColumns = array_filter($tableDiff->changedColumns, function (ColumnDiff $column) {
+			$tableDiff->changedColumns = array_filter($tableDiff->changedColumns, function(ColumnDiff $column) {
 				return count($column->changedProperties) > 0;
 			});
 
-			$tableDiff->removedColumns = array_map(function (Column $column) {
+			$tableDiff->removedColumns = array_map(function(Column $column) {
 				return $this->quoteColumn($column);
 			}, $tableDiff->removedColumns);
 
-			$tableDiff->renamedColumns = array_map(function (Column $column) {
+			$tableDiff->renamedColumns = array_map(function(Column $column) {
 				return $this->quoteColumn($column);
 			}, $tableDiff->renamedColumns);
 
-			$tableDiff->addedIndexes = array_map(function (Index $index) {
+			$tableDiff->addedIndexes = array_map(function(Index $index) {
 				return $this->quoteIndex($index);
 			}, $tableDiff->addedIndexes);
 
-			$tableDiff->changedIndexes = array_map(function (Index $index) {
+			$tableDiff->changedIndexes = array_map(function(Index $index) {
 				return $this->quoteIndex($index);
 			}, $tableDiff->changedIndexes);
 
-			$tableDiff->removedIndexes = array_map(function (Index $index) {
+			$tableDiff->removedIndexes = array_map(function(Index $index) {
 				return $this->quoteIndex($index);
 			}, $tableDiff->removedIndexes);
 
-			$tableDiff->renamedIndexes = array_map(function (Index $index) {
+			$tableDiff->renamedIndexes = array_map(function(Index $index) {
 				return $this->quoteIndex($index);
 			}, $tableDiff->renamedIndexes);
 
-			$tableDiff->addedForeignKeys = array_map(function (ForeignKeyConstraint $fkc) {
+			$tableDiff->addedForeignKeys = array_map(function(ForeignKeyConstraint $fkc) {
 				return $this->quoteForeignKeyConstraint($fkc);
 			}, $tableDiff->addedForeignKeys);
 
-			$tableDiff->changedForeignKeys = array_map(function (ForeignKeyConstraint $fkc) {
+			$tableDiff->changedForeignKeys = array_map(function(ForeignKeyConstraint $fkc) {
 				return $this->quoteForeignKeyConstraint($fkc);
 			}, $tableDiff->changedForeignKeys);
 
-			$tableDiff->removedForeignKeys = array_map(function (ForeignKeyConstraint $fkc) {
+			$tableDiff->removedForeignKeys = array_map(function(ForeignKeyConstraint $fkc) {
 				return $this->quoteForeignKeyConstraint($fkc);
 			}, $tableDiff->removedForeignKeys);
 		}
@@ -208,7 +208,7 @@ 
 	 * @return string
 	 */
 	protected function generateTemporaryTableName($name) {
-		return 'oc_' . uniqid();
+		return 'oc_'.uniqid();
 	}
 
 	/**
@@ -217,16 +217,16 @@ 
 	 */
 	protected function convertStatementToScript($statement) {
 		if (substr($statement, -1) === ';') {
-			return $statement . PHP_EOL . '/' . PHP_EOL;
+			return $statement.PHP_EOL.'/'.PHP_EOL;
 		}
-		$script = $statement . ';';
+		$script = $statement.';';
 		$script .= PHP_EOL;
 		$script .= PHP_EOL;
 		return $script;
 	}
 
 	protected function getFilterExpression() {
-		return '/^"' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+		return '/^"'.preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')).'/';
 	}
 
 }

lib/private/Updater.php

Indentation +566 added lines, -566 removed lines

@@ -57,571 +57,571 @@
  */
 class Updater extends BasicEmitter {
 
-	/** @var ILogger $log */
-	private $log;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var Checker */
-	private $checker;
-
-	/** @var Installer */
-	private $installer;
-
-	private $logLevelNames = [
-		0 => 'Debug',
-		1 => 'Info',
-		2 => 'Warning',
-		3 => 'Error',
-		4 => 'Fatal',
-	];
-
-	/**
-	 * @param IConfig $config
-	 * @param Checker $checker
-	 * @param ILogger $log
-	 * @param Installer $installer
-	 */
-	public function __construct(IConfig $config,
-								Checker $checker,
-								ILogger $log = null,
-								Installer $installer) {
-		$this->log = $log;
-		$this->config = $config;
-		$this->checker = $checker;
-		$this->installer = $installer;
-	}
-
-	/**
-	 * runs the update actions in maintenance mode, does not upgrade the source files
-	 * except the main .htaccess file
-	 *
-	 * @return bool true if the operation succeeded, false otherwise
-	 */
-	public function upgrade() {
-		$this->emitRepairEvents();
-		$this->logAllEvents();
-
-		$logLevel = $this->config->getSystemValue('loglevel', ILogger::WARN);
-		$this->emit('\OC\Updater', 'setDebugLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
-		$this->config->setSystemValue('loglevel', ILogger::DEBUG);
-
-		$wasMaintenanceModeEnabled = $this->config->getSystemValueBool('maintenance');
-
-		if(!$wasMaintenanceModeEnabled) {
-			$this->config->setSystemValue('maintenance', true);
-			$this->emit('\OC\Updater', 'maintenanceEnabled');
-		}
-
-		// Clear CAN_INSTALL file if not on git
-		if (\OC_Util::getChannel() !== 'git' && is_file(\OC::$configDir.'/CAN_INSTALL')) {
-			if (!unlink(\OC::$configDir . '/CAN_INSTALL')) {
-				$this->log->error('Could not cleanup CAN_INSTALL from your config folder. Please remove this file manually.');
-			}
-		}
-
-		$installedVersion = $this->config->getSystemValue('version', '0.0.0');
-		$currentVersion = implode('.', \OCP\Util::getVersion());
-
-		$this->log->debug('starting upgrade from ' . $installedVersion . ' to ' . $currentVersion, ['app' => 'core']);
-
-		$success = true;
-		try {
-			$this->doUpgrade($currentVersion, $installedVersion);
-		} catch (HintException $exception) {
-			$this->log->logException($exception, ['app' => 'core']);
-			$this->emit('\OC\Updater', 'failure', [$exception->getMessage() . ': ' .$exception->getHint()]);
-			$success = false;
-		} catch (\Exception $exception) {
-			$this->log->logException($exception, ['app' => 'core']);
-			$this->emit('\OC\Updater', 'failure', [get_class($exception) . ': ' .$exception->getMessage()]);
-			$success = false;
-		}
-
-		$this->emit('\OC\Updater', 'updateEnd', [$success]);
-
-		if(!$wasMaintenanceModeEnabled && $success) {
-			$this->config->setSystemValue('maintenance', false);
-			$this->emit('\OC\Updater', 'maintenanceDisabled');
-		} else {
-			$this->emit('\OC\Updater', 'maintenanceActive');
-		}
-
-		$this->emit('\OC\Updater', 'resetLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
-		$this->config->setSystemValue('loglevel', $logLevel);
-		$this->config->setSystemValue('installed', true);
-
-		return $success;
-	}
-
-	/**
-	 * Return version from which this version is allowed to upgrade from
-	 *
-	 * @return array allowed previous versions per vendor
-	 */
-	private function getAllowedPreviousVersions() {
-		// this should really be a JSON file
-		require \OC::$SERVERROOT . '/version.php';
-		/** @var array $OC_VersionCanBeUpgradedFrom */
-		return $OC_VersionCanBeUpgradedFrom;
-	}
-
-	/**
-	 * Return vendor from which this version was published
-	 *
-	 * @return string Get the vendor
-	 */
-	private function getVendor() {
-		// this should really be a JSON file
-		require \OC::$SERVERROOT . '/version.php';
-		/** @var string $vendor */
-		return (string) $vendor;
-	}
-
-	/**
-	 * Whether an upgrade to a specified version is possible
-	 * @param string $oldVersion
-	 * @param string $newVersion
-	 * @param array $allowedPreviousVersions
-	 * @return bool
-	 */
-	public function isUpgradePossible($oldVersion, $newVersion, array $allowedPreviousVersions) {
-		$version = explode('.', $oldVersion);
-		$majorMinor = $version[0] . '.' . $version[1];
-
-		$currentVendor = $this->config->getAppValue('core', 'vendor', '');
-
-		// Vendor was not set correctly on install, so we have to white-list known versions
-		if ($currentVendor === '' && isset($allowedPreviousVersions['owncloud'][$oldVersion])) {
-			$currentVendor = 'owncloud';
-		}
-
-		if ($currentVendor === 'nextcloud') {
-			return isset($allowedPreviousVersions[$currentVendor][$majorMinor])
-				&& (version_compare($oldVersion, $newVersion, '<=') ||
-					$this->config->getSystemValue('debug', false));
-		}
-
-		// Check if the instance can be migrated
-		return isset($allowedPreviousVersions[$currentVendor][$majorMinor]) ||
-			isset($allowedPreviousVersions[$currentVendor][$oldVersion]);
-	}
-
-	/**
-	 * runs the update actions in maintenance mode, does not upgrade the source files
-	 * except the main .htaccess file
-	 *
-	 * @param string $currentVersion current version to upgrade to
-	 * @param string $installedVersion previous version from which to upgrade from
-	 *
-	 * @throws \Exception
-	 */
-	private function doUpgrade($currentVersion, $installedVersion) {
-		// Stop update if the update is over several major versions
-		$allowedPreviousVersions = $this->getAllowedPreviousVersions();
-		if (!$this->isUpgradePossible($installedVersion, $currentVersion, $allowedPreviousVersions)) {
-			throw new \Exception('Updates between multiple major versions and downgrades are unsupported.');
-		}
-
-		// Update .htaccess files
-		try {
-			Setup::updateHtaccess();
-			Setup::protectDataDirectory();
-		} catch (\Exception $e) {
-			throw new \Exception($e->getMessage());
-		}
-
-		// create empty file in data dir, so we can later find
-		// out that this is indeed an ownCloud data directory
-		// (in case it didn't exist before)
-		file_put_contents($this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/.ocdata', '');
-
-		// pre-upgrade repairs
-		$repair = new Repair(Repair::getBeforeUpgradeRepairSteps(), \OC::$server->getEventDispatcher());
-		$repair->run();
-
-		$this->doCoreUpgrade();
-
-		try {
-			// TODO: replace with the new repair step mechanism https://github.com/owncloud/core/pull/24378
-			Setup::installBackgroundJobs();
-		} catch (\Exception $e) {
-			throw new \Exception($e->getMessage());
-		}
-
-		// update all shipped apps
-		$this->checkAppsRequirements();
-		$this->doAppUpgrade();
-
-		// Update the appfetchers version so it downloads the correct list from the appstore
-		\OC::$server->getAppFetcher()->setVersion($currentVersion);
-
-		// upgrade appstore apps
-		$this->upgradeAppStoreApps(\OC::$server->getAppManager()->getInstalledApps());
-		$autoDisabledApps = \OC::$server->getAppManager()->getAutoDisabledApps();
-		$this->upgradeAppStoreApps($autoDisabledApps, true);
-
-		// install new shipped apps on upgrade
-		OC_App::loadApps(['authentication']);
-		$errors = Installer::installShippedApps(true);
-		foreach ($errors as $appId => $exception) {
-			/** @var \Exception $exception */
-			$this->log->logException($exception, ['app' => $appId]);
-			$this->emit('\OC\Updater', 'failure', [$appId . ': ' . $exception->getMessage()]);
-		}
-
-		// post-upgrade repairs
-		$repair = new Repair(Repair::getRepairSteps(), \OC::$server->getEventDispatcher());
-		$repair->run();
-
-		//Invalidate update feed
-		$this->config->setAppValue('core', 'lastupdatedat', 0);
-
-		// Check for code integrity if not disabled
-		if(\OC::$server->getIntegrityCodeChecker()->isCodeCheckEnforced()) {
-			$this->emit('\OC\Updater', 'startCheckCodeIntegrity');
-			$this->checker->runInstanceVerification();
-			$this->emit('\OC\Updater', 'finishedCheckCodeIntegrity');
-		}
-
-		// only set the final version if everything went well
-		$this->config->setSystemValue('version', implode('.', Util::getVersion()));
-		$this->config->setAppValue('core', 'vendor', $this->getVendor());
-	}
-
-	protected function doCoreUpgrade() {
-		$this->emit('\OC\Updater', 'dbUpgradeBefore');
-
-		// execute core migrations
-		$ms = new MigrationService('core', \OC::$server->getDatabaseConnection());
-		$ms->migrate();
-
-		$this->emit('\OC\Updater', 'dbUpgrade');
-	}
-
-	/**
-	 * @param string $version the oc version to check app compatibility with
-	 */
-	protected function checkAppUpgrade($version) {
-		$apps = \OC_App::getEnabledApps();
-		$this->emit('\OC\Updater', 'appUpgradeCheckBefore');
-
-		$appManager = \OC::$server->getAppManager();
-		foreach ($apps as $appId) {
-			$info = \OC_App::getAppInfo($appId);
-			$compatible = \OC_App::isAppCompatible($version, $info);
-			$isShipped = $appManager->isShipped($appId);
-
-			if ($compatible && $isShipped && \OC_App::shouldUpgrade($appId)) {
-				/**
-				 * FIXME: The preupdate check is performed before the database migration, otherwise database changes
-				 * are not possible anymore within it. - Consider this when touching the code.
-				 * @link https://github.com/owncloud/core/issues/10980
-				 * @see \OC_App::updateApp
-				 */
-				if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/preupdate.php')) {
-					$this->includePreUpdate($appId);
-				}
-				if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/database.xml')) {
-					$this->emit('\OC\Updater', 'appSimulateUpdate', [$appId]);
-					\OC_DB::simulateUpdateDbFromStructure(\OC_App::getAppPath($appId) . '/appinfo/database.xml');
-				}
-			}
-		}
-
-		$this->emit('\OC\Updater', 'appUpgradeCheck');
-	}
-
-	/**
-	 * Includes the pre-update file. Done here to prevent namespace mixups.
-	 * @param string $appId
-	 */
-	private function includePreUpdate($appId) {
-		include \OC_App::getAppPath($appId) . '/appinfo/preupdate.php';
-	}
-
-	/**
-	 * upgrades all apps within a major ownCloud upgrade. Also loads "priority"
-	 * (types authentication, filesystem, logging, in that order) afterwards.
-	 *
-	 * @throws NeedsUpdateException
-	 */
-	protected function doAppUpgrade() {
-		$apps = \OC_App::getEnabledApps();
-		$priorityTypes = ['authentication', 'filesystem', 'logging'];
-		$pseudoOtherType = 'other';
-		$stacks = [$pseudoOtherType => []];
-
-		foreach ($apps as $appId) {
-			$priorityType = false;
-			foreach ($priorityTypes as $type) {
-				if(!isset($stacks[$type])) {
-					$stacks[$type] = [];
-				}
-				if (\OC_App::isType($appId, [$type])) {
-					$stacks[$type][] = $appId;
-					$priorityType = true;
-					break;
-				}
-			}
-			if (!$priorityType) {
-				$stacks[$pseudoOtherType][] = $appId;
-			}
-		}
-		foreach ($stacks as $type => $stack) {
-			foreach ($stack as $appId) {
-				if (\OC_App::shouldUpgrade($appId)) {
-					$this->emit('\OC\Updater', 'appUpgradeStarted', [$appId, \OC_App::getAppVersion($appId)]);
-					\OC_App::updateApp($appId);
-					$this->emit('\OC\Updater', 'appUpgrade', [$appId, \OC_App::getAppVersion($appId)]);
-				}
-				if($type !== $pseudoOtherType) {
-					// load authentication, filesystem and logging apps after
-					// upgrading them. Other apps my need to rely on modifying
-					// user and/or filesystem aspects.
-					\OC_App::loadApp($appId);
-				}
-			}
-		}
-	}
-
-	/**
-	 * check if the current enabled apps are compatible with the current
-	 * ownCloud version. disable them if not.
-	 * This is important if you upgrade ownCloud and have non ported 3rd
-	 * party apps installed.
-	 *
-	 * @return array
-	 * @throws \Exception
-	 */
-	private function checkAppsRequirements() {
-		$isCoreUpgrade = $this->isCodeUpgrade();
-		$apps = OC_App::getEnabledApps();
-		$version = implode('.', Util::getVersion());
-		$disabledApps = [];
-		$appManager = \OC::$server->getAppManager();
-		foreach ($apps as $app) {
-			// check if the app is compatible with this version of ownCloud
-			$info = OC_App::getAppInfo($app);
-			if($info === null || !OC_App::isAppCompatible($version, $info)) {
-				if ($appManager->isShipped($app)) {
-					throw new \UnexpectedValueException('The files of the app "' . $app . '" were not correctly replaced before running the update');
-				}
-				\OC::$server->getAppManager()->disableApp($app, true);
-				$this->emit('\OC\Updater', 'incompatibleAppDisabled', [$app]);
-			}
-			// no need to disable any app in case this is a non-core upgrade
-			if (!$isCoreUpgrade) {
-				continue;
-			}
-			// shipped apps will remain enabled
-			if ($appManager->isShipped($app)) {
-				continue;
-			}
-			// authentication and session apps will remain enabled as well
-			if (OC_App::isType($app, ['session', 'authentication'])) {
-				continue;
-			}
-		}
-		return $disabledApps;
-	}
-
-	/**
-	 * @return bool
-	 */
-	private function isCodeUpgrade() {
-		$installedVersion = $this->config->getSystemValue('version', '0.0.0');
-		$currentVersion = implode('.', Util::getVersion());
-		if (version_compare($currentVersion, $installedVersion, '>')) {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * @param array $disabledApps
-	 * @param bool $reenable
-	 * @throws \Exception
-	 */
-	private function upgradeAppStoreApps(array $disabledApps, $reenable = false) {
-		foreach($disabledApps as $app) {
-			try {
-				$this->emit('\OC\Updater', 'checkAppStoreAppBefore', [$app]);
-				if ($this->installer->isUpdateAvailable($app)) {
-					$this->emit('\OC\Updater', 'upgradeAppStoreApp', [$app]);
-					$this->installer->updateAppstoreApp($app);
-				}
-				$this->emit('\OC\Updater', 'checkAppStoreApp', [$app]);
-
-				if ($reenable) {
-					$ocApp = new \OC_App();
-					$ocApp->enable($app);
-				}
-			} catch (\Exception $ex) {
-				$this->log->logException($ex, ['app' => 'core']);
-			}
-		}
-	}
-
-	/**
-	 * Forward messages emitted by the repair routine
-	 */
-	private function emitRepairEvents() {
-		$dispatcher = \OC::$server->getEventDispatcher();
-		$dispatcher->addListener('\OC\Repair::warning', function ($event) {
-			if ($event instanceof GenericEvent) {
-				$this->emit('\OC\Updater', 'repairWarning', $event->getArguments());
-			}
-		});
-		$dispatcher->addListener('\OC\Repair::error', function ($event) {
-			if ($event instanceof GenericEvent) {
-				$this->emit('\OC\Updater', 'repairError', $event->getArguments());
-			}
-		});
-		$dispatcher->addListener('\OC\Repair::info', function ($event) {
-			if ($event instanceof GenericEvent) {
-				$this->emit('\OC\Updater', 'repairInfo', $event->getArguments());
-			}
-		});
-		$dispatcher->addListener('\OC\Repair::step', function ($event) {
-			if ($event instanceof GenericEvent) {
-				$this->emit('\OC\Updater', 'repairStep', $event->getArguments());
-			}
-		});
-	}
-
-	private function logAllEvents() {
-		$log = $this->log;
-
-		$dispatcher = \OC::$server->getEventDispatcher();
-		$dispatcher->addListener('\OC\DB\Migrator::executeSql', function ($event) use ($log) {
-			if (!$event instanceof GenericEvent) {
-				return;
-			}
-			$log->info('\OC\DB\Migrator::executeSql: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
-		});
-		$dispatcher->addListener('\OC\DB\Migrator::checkTable', function ($event) use ($log) {
-			if (!$event instanceof GenericEvent) {
-				return;
-			}
-			$log->info('\OC\DB\Migrator::checkTable: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
-		});
-
-		$repairListener = function ($event) use ($log) {
-			if (!$event instanceof GenericEvent) {
-				return;
-			}
-			switch ($event->getSubject()) {
-				case '\OC\Repair::startProgress':
-					$log->info('\OC\Repair::startProgress: Starting ... ' . $event->getArgument(1) .  ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
-					break;
-				case '\OC\Repair::advance':
-					$desc = $event->getArgument(1);
-					if (empty($desc)) {
-						$desc = '';
-					}
-					$log->info('\OC\Repair::advance: ' . $desc . ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
-
-					break;
-				case '\OC\Repair::finishProgress':
-					$log->info('\OC\Repair::finishProgress', ['app' => 'updater']);
-					break;
-				case '\OC\Repair::step':
-					$log->info('\OC\Repair::step: Repair step: ' . $event->getArgument(0), ['app' => 'updater']);
-					break;
-				case '\OC\Repair::info':
-					$log->info('\OC\Repair::info: Repair info: ' . $event->getArgument(0), ['app' => 'updater']);
-					break;
-				case '\OC\Repair::warning':
-					$log->warning('\OC\Repair::warning: Repair warning: ' . $event->getArgument(0), ['app' => 'updater']);
-					break;
-				case '\OC\Repair::error':
-					$log->error('\OC\Repair::error: Repair error: ' . $event->getArgument(0), ['app' => 'updater']);
-					break;
-			}
-		};
-
-		$dispatcher->addListener('\OC\Repair::startProgress', $repairListener);
-		$dispatcher->addListener('\OC\Repair::advance', $repairListener);
-		$dispatcher->addListener('\OC\Repair::finishProgress', $repairListener);
-		$dispatcher->addListener('\OC\Repair::step', $repairListener);
-		$dispatcher->addListener('\OC\Repair::info', $repairListener);
-		$dispatcher->addListener('\OC\Repair::warning', $repairListener);
-		$dispatcher->addListener('\OC\Repair::error', $repairListener);
-
-
-		$this->listen('\OC\Updater', 'maintenanceEnabled', function () use ($log) {
-			$log->info('\OC\Updater::maintenanceEnabled: Turned on maintenance mode', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'maintenanceDisabled', function () use ($log) {
-			$log->info('\OC\Updater::maintenanceDisabled: Turned off maintenance mode', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'maintenanceActive', function () use ($log) {
-			$log->info('\OC\Updater::maintenanceActive: Maintenance mode is kept active', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'updateEnd', function ($success) use ($log) {
-			if ($success) {
-				$log->info('\OC\Updater::updateEnd: Update successful', ['app' => 'updater']);
-			} else {
-				$log->error('\OC\Updater::updateEnd: Update failed', ['app' => 'updater']);
-			}
-		});
-		$this->listen('\OC\Updater', 'dbUpgradeBefore', function () use ($log) {
-			$log->info('\OC\Updater::dbUpgradeBefore: Updating database schema', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'dbUpgrade', function () use ($log) {
-			$log->info('\OC\Updater::dbUpgrade: Updated database', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'dbSimulateUpgradeBefore', function () use ($log) {
-			$log->info('\OC\Updater::dbSimulateUpgradeBefore: Checking whether the database schema can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'dbSimulateUpgrade', function () use ($log) {
-			$log->info('\OC\Updater::dbSimulateUpgrade: Checked database schema update', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'incompatibleAppDisabled', function ($app) use ($log) {
-			$log->info('\OC\Updater::incompatibleAppDisabled: Disabled incompatible app: ' . $app, ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'checkAppStoreAppBefore', function ($app) use ($log) {
-			$log->info('\OC\Updater::checkAppStoreAppBefore: Checking for update of app "' . $app . '" in appstore', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'upgradeAppStoreApp', function ($app) use ($log) {
-			$log->info('\OC\Updater::upgradeAppStoreApp: Update app "' . $app . '" from appstore', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'checkAppStoreApp', function ($app) use ($log) {
-			$log->info('\OC\Updater::checkAppStoreApp: Checked for update of app "' . $app . '" in appstore', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'appUpgradeCheckBefore', function () use ($log) {
-			$log->info('\OC\Updater::appUpgradeCheckBefore: Checking updates of apps', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'appSimulateUpdate', function ($app) use ($log) {
-			$log->info('\OC\Updater::appSimulateUpdate: Checking whether the database schema for <' . $app . '> can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'appUpgradeCheck', function () use ($log) {
-			$log->info('\OC\Updater::appUpgradeCheck: Checked database schema update for apps', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'appUpgradeStarted', function ($app) use ($log) {
-			$log->info('\OC\Updater::appUpgradeStarted: Updating <' . $app . '> ...', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'appUpgrade', function ($app, $version) use ($log) {
-			$log->info('\OC\Updater::appUpgrade: Updated <' . $app . '> to ' . $version, ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'failure', function ($message) use ($log) {
-			$log->error('\OC\Updater::failure: ' . $message, ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'setDebugLogLevel', function () use ($log) {
-			$log->info('\OC\Updater::setDebugLogLevel: Set log level to debug', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'resetLogLevel', function ($logLevel, $logLevelName) use ($log) {
-			$log->info('\OC\Updater::resetLogLevel: Reset log level to ' . $logLevelName . '(' . $logLevel . ')', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'startCheckCodeIntegrity', function () use ($log) {
-			$log->info('\OC\Updater::startCheckCodeIntegrity: Starting code integrity check...', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'finishedCheckCodeIntegrity', function () use ($log) {
-			$log->info('\OC\Updater::finishedCheckCodeIntegrity: Finished code integrity check', ['app' => 'updater']);
-		});
-
-	}
+    /** @var ILogger $log */
+    private $log;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var Checker */
+    private $checker;
+
+    /** @var Installer */
+    private $installer;
+
+    private $logLevelNames = [
+        0 => 'Debug',
+        1 => 'Info',
+        2 => 'Warning',
+        3 => 'Error',
+        4 => 'Fatal',
+    ];
+
+    /**
+     * @param IConfig $config
+     * @param Checker $checker
+     * @param ILogger $log
+     * @param Installer $installer
+     */
+    public function __construct(IConfig $config,
+                                Checker $checker,
+                                ILogger $log = null,
+                                Installer $installer) {
+        $this->log = $log;
+        $this->config = $config;
+        $this->checker = $checker;
+        $this->installer = $installer;
+    }
+
+    /**
+     * runs the update actions in maintenance mode, does not upgrade the source files
+     * except the main .htaccess file
+     *
+     * @return bool true if the operation succeeded, false otherwise
+     */
+    public function upgrade() {
+        $this->emitRepairEvents();
+        $this->logAllEvents();
+
+        $logLevel = $this->config->getSystemValue('loglevel', ILogger::WARN);
+        $this->emit('\OC\Updater', 'setDebugLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
+        $this->config->setSystemValue('loglevel', ILogger::DEBUG);
+
+        $wasMaintenanceModeEnabled = $this->config->getSystemValueBool('maintenance');
+
+        if(!$wasMaintenanceModeEnabled) {
+            $this->config->setSystemValue('maintenance', true);
+            $this->emit('\OC\Updater', 'maintenanceEnabled');
+        }
+
+        // Clear CAN_INSTALL file if not on git
+        if (\OC_Util::getChannel() !== 'git' && is_file(\OC::$configDir.'/CAN_INSTALL')) {
+            if (!unlink(\OC::$configDir . '/CAN_INSTALL')) {
+                $this->log->error('Could not cleanup CAN_INSTALL from your config folder. Please remove this file manually.');
+            }
+        }
+
+        $installedVersion = $this->config->getSystemValue('version', '0.0.0');
+        $currentVersion = implode('.', \OCP\Util::getVersion());
+
+        $this->log->debug('starting upgrade from ' . $installedVersion . ' to ' . $currentVersion, ['app' => 'core']);
+
+        $success = true;
+        try {
+            $this->doUpgrade($currentVersion, $installedVersion);
+        } catch (HintException $exception) {
+            $this->log->logException($exception, ['app' => 'core']);
+            $this->emit('\OC\Updater', 'failure', [$exception->getMessage() . ': ' .$exception->getHint()]);
+            $success = false;
+        } catch (\Exception $exception) {
+            $this->log->logException($exception, ['app' => 'core']);
+            $this->emit('\OC\Updater', 'failure', [get_class($exception) . ': ' .$exception->getMessage()]);
+            $success = false;
+        }
+
+        $this->emit('\OC\Updater', 'updateEnd', [$success]);
+
+        if(!$wasMaintenanceModeEnabled && $success) {
+            $this->config->setSystemValue('maintenance', false);
+            $this->emit('\OC\Updater', 'maintenanceDisabled');
+        } else {
+            $this->emit('\OC\Updater', 'maintenanceActive');
+        }
+
+        $this->emit('\OC\Updater', 'resetLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
+        $this->config->setSystemValue('loglevel', $logLevel);
+        $this->config->setSystemValue('installed', true);
+
+        return $success;
+    }
+
+    /**
+     * Return version from which this version is allowed to upgrade from
+     *
+     * @return array allowed previous versions per vendor
+     */
+    private function getAllowedPreviousVersions() {
+        // this should really be a JSON file
+        require \OC::$SERVERROOT . '/version.php';
+        /** @var array $OC_VersionCanBeUpgradedFrom */
+        return $OC_VersionCanBeUpgradedFrom;
+    }
+
+    /**
+     * Return vendor from which this version was published
+     *
+     * @return string Get the vendor
+     */
+    private function getVendor() {
+        // this should really be a JSON file
+        require \OC::$SERVERROOT . '/version.php';
+        /** @var string $vendor */
+        return (string) $vendor;
+    }
+
+    /**
+     * Whether an upgrade to a specified version is possible
+     * @param string $oldVersion
+     * @param string $newVersion
+     * @param array $allowedPreviousVersions
+     * @return bool
+     */
+    public function isUpgradePossible($oldVersion, $newVersion, array $allowedPreviousVersions) {
+        $version = explode('.', $oldVersion);
+        $majorMinor = $version[0] . '.' . $version[1];
+
+        $currentVendor = $this->config->getAppValue('core', 'vendor', '');
+
+        // Vendor was not set correctly on install, so we have to white-list known versions
+        if ($currentVendor === '' && isset($allowedPreviousVersions['owncloud'][$oldVersion])) {
+            $currentVendor = 'owncloud';
+        }
+
+        if ($currentVendor === 'nextcloud') {
+            return isset($allowedPreviousVersions[$currentVendor][$majorMinor])
+                && (version_compare($oldVersion, $newVersion, '<=') ||
+                    $this->config->getSystemValue('debug', false));
+        }
+
+        // Check if the instance can be migrated
+        return isset($allowedPreviousVersions[$currentVendor][$majorMinor]) ||
+            isset($allowedPreviousVersions[$currentVendor][$oldVersion]);
+    }
+
+    /**
+     * runs the update actions in maintenance mode, does not upgrade the source files
+     * except the main .htaccess file
+     *
+     * @param string $currentVersion current version to upgrade to
+     * @param string $installedVersion previous version from which to upgrade from
+     *
+     * @throws \Exception
+     */
+    private function doUpgrade($currentVersion, $installedVersion) {
+        // Stop update if the update is over several major versions
+        $allowedPreviousVersions = $this->getAllowedPreviousVersions();
+        if (!$this->isUpgradePossible($installedVersion, $currentVersion, $allowedPreviousVersions)) {
+            throw new \Exception('Updates between multiple major versions and downgrades are unsupported.');
+        }
+
+        // Update .htaccess files
+        try {
+            Setup::updateHtaccess();
+            Setup::protectDataDirectory();
+        } catch (\Exception $e) {
+            throw new \Exception($e->getMessage());
+        }
+
+        // create empty file in data dir, so we can later find
+        // out that this is indeed an ownCloud data directory
+        // (in case it didn't exist before)
+        file_put_contents($this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/.ocdata', '');
+
+        // pre-upgrade repairs
+        $repair = new Repair(Repair::getBeforeUpgradeRepairSteps(), \OC::$server->getEventDispatcher());
+        $repair->run();
+
+        $this->doCoreUpgrade();
+
+        try {
+            // TODO: replace with the new repair step mechanism https://github.com/owncloud/core/pull/24378
+            Setup::installBackgroundJobs();
+        } catch (\Exception $e) {
+            throw new \Exception($e->getMessage());
+        }
+
+        // update all shipped apps
+        $this->checkAppsRequirements();
+        $this->doAppUpgrade();
+
+        // Update the appfetchers version so it downloads the correct list from the appstore
+        \OC::$server->getAppFetcher()->setVersion($currentVersion);
+
+        // upgrade appstore apps
+        $this->upgradeAppStoreApps(\OC::$server->getAppManager()->getInstalledApps());
+        $autoDisabledApps = \OC::$server->getAppManager()->getAutoDisabledApps();
+        $this->upgradeAppStoreApps($autoDisabledApps, true);
+
+        // install new shipped apps on upgrade
+        OC_App::loadApps(['authentication']);
+        $errors = Installer::installShippedApps(true);
+        foreach ($errors as $appId => $exception) {
+            /** @var \Exception $exception */
+            $this->log->logException($exception, ['app' => $appId]);
+            $this->emit('\OC\Updater', 'failure', [$appId . ': ' . $exception->getMessage()]);
+        }
+
+        // post-upgrade repairs
+        $repair = new Repair(Repair::getRepairSteps(), \OC::$server->getEventDispatcher());
+        $repair->run();
+
+        //Invalidate update feed
+        $this->config->setAppValue('core', 'lastupdatedat', 0);
+
+        // Check for code integrity if not disabled
+        if(\OC::$server->getIntegrityCodeChecker()->isCodeCheckEnforced()) {
+            $this->emit('\OC\Updater', 'startCheckCodeIntegrity');
+            $this->checker->runInstanceVerification();
+            $this->emit('\OC\Updater', 'finishedCheckCodeIntegrity');
+        }
+
+        // only set the final version if everything went well
+        $this->config->setSystemValue('version', implode('.', Util::getVersion()));
+        $this->config->setAppValue('core', 'vendor', $this->getVendor());
+    }
+
+    protected function doCoreUpgrade() {
+        $this->emit('\OC\Updater', 'dbUpgradeBefore');
+
+        // execute core migrations
+        $ms = new MigrationService('core', \OC::$server->getDatabaseConnection());
+        $ms->migrate();
+
+        $this->emit('\OC\Updater', 'dbUpgrade');
+    }
+
+    /**
+     * @param string $version the oc version to check app compatibility with
+     */
+    protected function checkAppUpgrade($version) {
+        $apps = \OC_App::getEnabledApps();
+        $this->emit('\OC\Updater', 'appUpgradeCheckBefore');
+
+        $appManager = \OC::$server->getAppManager();
+        foreach ($apps as $appId) {
+            $info = \OC_App::getAppInfo($appId);
+            $compatible = \OC_App::isAppCompatible($version, $info);
+            $isShipped = $appManager->isShipped($appId);
+
+            if ($compatible && $isShipped && \OC_App::shouldUpgrade($appId)) {
+                /**
+                 * FIXME: The preupdate check is performed before the database migration, otherwise database changes
+                 * are not possible anymore within it. - Consider this when touching the code.
+                 * @link https://github.com/owncloud/core/issues/10980
+                 * @see \OC_App::updateApp
+                 */
+                if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/preupdate.php')) {
+                    $this->includePreUpdate($appId);
+                }
+                if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/database.xml')) {
+                    $this->emit('\OC\Updater', 'appSimulateUpdate', [$appId]);
+                    \OC_DB::simulateUpdateDbFromStructure(\OC_App::getAppPath($appId) . '/appinfo/database.xml');
+                }
+            }
+        }
+
+        $this->emit('\OC\Updater', 'appUpgradeCheck');
+    }
+
+    /**
+     * Includes the pre-update file. Done here to prevent namespace mixups.
+     * @param string $appId
+     */
+    private function includePreUpdate($appId) {
+        include \OC_App::getAppPath($appId) . '/appinfo/preupdate.php';
+    }
+
+    /**
+     * upgrades all apps within a major ownCloud upgrade. Also loads "priority"
+     * (types authentication, filesystem, logging, in that order) afterwards.
+     *
+     * @throws NeedsUpdateException
+     */
+    protected function doAppUpgrade() {
+        $apps = \OC_App::getEnabledApps();
+        $priorityTypes = ['authentication', 'filesystem', 'logging'];
+        $pseudoOtherType = 'other';
+        $stacks = [$pseudoOtherType => []];
+
+        foreach ($apps as $appId) {
+            $priorityType = false;
+            foreach ($priorityTypes as $type) {
+                if(!isset($stacks[$type])) {
+                    $stacks[$type] = [];
+                }
+                if (\OC_App::isType($appId, [$type])) {
+                    $stacks[$type][] = $appId;
+                    $priorityType = true;
+                    break;
+                }
+            }
+            if (!$priorityType) {
+                $stacks[$pseudoOtherType][] = $appId;
+            }
+        }
+        foreach ($stacks as $type => $stack) {
+            foreach ($stack as $appId) {
+                if (\OC_App::shouldUpgrade($appId)) {
+                    $this->emit('\OC\Updater', 'appUpgradeStarted', [$appId, \OC_App::getAppVersion($appId)]);
+                    \OC_App::updateApp($appId);
+                    $this->emit('\OC\Updater', 'appUpgrade', [$appId, \OC_App::getAppVersion($appId)]);
+                }
+                if($type !== $pseudoOtherType) {
+                    // load authentication, filesystem and logging apps after
+                    // upgrading them. Other apps my need to rely on modifying
+                    // user and/or filesystem aspects.
+                    \OC_App::loadApp($appId);
+                }
+            }
+        }
+    }
+
+    /**
+     * check if the current enabled apps are compatible with the current
+     * ownCloud version. disable them if not.
+     * This is important if you upgrade ownCloud and have non ported 3rd
+     * party apps installed.
+     *
+     * @return array
+     * @throws \Exception
+     */
+    private function checkAppsRequirements() {
+        $isCoreUpgrade = $this->isCodeUpgrade();
+        $apps = OC_App::getEnabledApps();
+        $version = implode('.', Util::getVersion());
+        $disabledApps = [];
+        $appManager = \OC::$server->getAppManager();
+        foreach ($apps as $app) {
+            // check if the app is compatible with this version of ownCloud
+            $info = OC_App::getAppInfo($app);
+            if($info === null || !OC_App::isAppCompatible($version, $info)) {
+                if ($appManager->isShipped($app)) {
+                    throw new \UnexpectedValueException('The files of the app "' . $app . '" were not correctly replaced before running the update');
+                }
+                \OC::$server->getAppManager()->disableApp($app, true);
+                $this->emit('\OC\Updater', 'incompatibleAppDisabled', [$app]);
+            }
+            // no need to disable any app in case this is a non-core upgrade
+            if (!$isCoreUpgrade) {
+                continue;
+            }
+            // shipped apps will remain enabled
+            if ($appManager->isShipped($app)) {
+                continue;
+            }
+            // authentication and session apps will remain enabled as well
+            if (OC_App::isType($app, ['session', 'authentication'])) {
+                continue;
+            }
+        }
+        return $disabledApps;
+    }
+
+    /**
+     * @return bool
+     */
+    private function isCodeUpgrade() {
+        $installedVersion = $this->config->getSystemValue('version', '0.0.0');
+        $currentVersion = implode('.', Util::getVersion());
+        if (version_compare($currentVersion, $installedVersion, '>')) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * @param array $disabledApps
+     * @param bool $reenable
+     * @throws \Exception
+     */
+    private function upgradeAppStoreApps(array $disabledApps, $reenable = false) {
+        foreach($disabledApps as $app) {
+            try {
+                $this->emit('\OC\Updater', 'checkAppStoreAppBefore', [$app]);
+                if ($this->installer->isUpdateAvailable($app)) {
+                    $this->emit('\OC\Updater', 'upgradeAppStoreApp', [$app]);
+                    $this->installer->updateAppstoreApp($app);
+                }
+                $this->emit('\OC\Updater', 'checkAppStoreApp', [$app]);
+
+                if ($reenable) {
+                    $ocApp = new \OC_App();
+                    $ocApp->enable($app);
+                }
+            } catch (\Exception $ex) {
+                $this->log->logException($ex, ['app' => 'core']);
+            }
+        }
+    }
+
+    /**
+     * Forward messages emitted by the repair routine
+     */
+    private function emitRepairEvents() {
+        $dispatcher = \OC::$server->getEventDispatcher();
+        $dispatcher->addListener('\OC\Repair::warning', function ($event) {
+            if ($event instanceof GenericEvent) {
+                $this->emit('\OC\Updater', 'repairWarning', $event->getArguments());
+            }
+        });
+        $dispatcher->addListener('\OC\Repair::error', function ($event) {
+            if ($event instanceof GenericEvent) {
+                $this->emit('\OC\Updater', 'repairError', $event->getArguments());
+            }
+        });
+        $dispatcher->addListener('\OC\Repair::info', function ($event) {
+            if ($event instanceof GenericEvent) {
+                $this->emit('\OC\Updater', 'repairInfo', $event->getArguments());
+            }
+        });
+        $dispatcher->addListener('\OC\Repair::step', function ($event) {
+            if ($event instanceof GenericEvent) {
+                $this->emit('\OC\Updater', 'repairStep', $event->getArguments());
+            }
+        });
+    }
+
+    private function logAllEvents() {
+        $log = $this->log;
+
+        $dispatcher = \OC::$server->getEventDispatcher();
+        $dispatcher->addListener('\OC\DB\Migrator::executeSql', function ($event) use ($log) {
+            if (!$event instanceof GenericEvent) {
+                return;
+            }
+            $log->info('\OC\DB\Migrator::executeSql: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
+        });
+        $dispatcher->addListener('\OC\DB\Migrator::checkTable', function ($event) use ($log) {
+            if (!$event instanceof GenericEvent) {
+                return;
+            }
+            $log->info('\OC\DB\Migrator::checkTable: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
+        });
+
+        $repairListener = function ($event) use ($log) {
+            if (!$event instanceof GenericEvent) {
+                return;
+            }
+            switch ($event->getSubject()) {
+                case '\OC\Repair::startProgress':
+                    $log->info('\OC\Repair::startProgress: Starting ... ' . $event->getArgument(1) .  ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
+                    break;
+                case '\OC\Repair::advance':
+                    $desc = $event->getArgument(1);
+                    if (empty($desc)) {
+                        $desc = '';
+                    }
+                    $log->info('\OC\Repair::advance: ' . $desc . ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
+
+                    break;
+                case '\OC\Repair::finishProgress':
+                    $log->info('\OC\Repair::finishProgress', ['app' => 'updater']);
+                    break;
+                case '\OC\Repair::step':
+                    $log->info('\OC\Repair::step: Repair step: ' . $event->getArgument(0), ['app' => 'updater']);
+                    break;
+                case '\OC\Repair::info':
+                    $log->info('\OC\Repair::info: Repair info: ' . $event->getArgument(0), ['app' => 'updater']);
+                    break;
+                case '\OC\Repair::warning':
+                    $log->warning('\OC\Repair::warning: Repair warning: ' . $event->getArgument(0), ['app' => 'updater']);
+                    break;
+                case '\OC\Repair::error':
+                    $log->error('\OC\Repair::error: Repair error: ' . $event->getArgument(0), ['app' => 'updater']);
+                    break;
+            }
+        };
+
+        $dispatcher->addListener('\OC\Repair::startProgress', $repairListener);
+        $dispatcher->addListener('\OC\Repair::advance', $repairListener);
+        $dispatcher->addListener('\OC\Repair::finishProgress', $repairListener);
+        $dispatcher->addListener('\OC\Repair::step', $repairListener);
+        $dispatcher->addListener('\OC\Repair::info', $repairListener);
+        $dispatcher->addListener('\OC\Repair::warning', $repairListener);
+        $dispatcher->addListener('\OC\Repair::error', $repairListener);
+
+
+        $this->listen('\OC\Updater', 'maintenanceEnabled', function () use ($log) {
+            $log->info('\OC\Updater::maintenanceEnabled: Turned on maintenance mode', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'maintenanceDisabled', function () use ($log) {
+            $log->info('\OC\Updater::maintenanceDisabled: Turned off maintenance mode', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'maintenanceActive', function () use ($log) {
+            $log->info('\OC\Updater::maintenanceActive: Maintenance mode is kept active', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'updateEnd', function ($success) use ($log) {
+            if ($success) {
+                $log->info('\OC\Updater::updateEnd: Update successful', ['app' => 'updater']);
+            } else {
+                $log->error('\OC\Updater::updateEnd: Update failed', ['app' => 'updater']);
+            }
+        });
+        $this->listen('\OC\Updater', 'dbUpgradeBefore', function () use ($log) {
+            $log->info('\OC\Updater::dbUpgradeBefore: Updating database schema', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'dbUpgrade', function () use ($log) {
+            $log->info('\OC\Updater::dbUpgrade: Updated database', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'dbSimulateUpgradeBefore', function () use ($log) {
+            $log->info('\OC\Updater::dbSimulateUpgradeBefore: Checking whether the database schema can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'dbSimulateUpgrade', function () use ($log) {
+            $log->info('\OC\Updater::dbSimulateUpgrade: Checked database schema update', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'incompatibleAppDisabled', function ($app) use ($log) {
+            $log->info('\OC\Updater::incompatibleAppDisabled: Disabled incompatible app: ' . $app, ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'checkAppStoreAppBefore', function ($app) use ($log) {
+            $log->info('\OC\Updater::checkAppStoreAppBefore: Checking for update of app "' . $app . '" in appstore', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'upgradeAppStoreApp', function ($app) use ($log) {
+            $log->info('\OC\Updater::upgradeAppStoreApp: Update app "' . $app . '" from appstore', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'checkAppStoreApp', function ($app) use ($log) {
+            $log->info('\OC\Updater::checkAppStoreApp: Checked for update of app "' . $app . '" in appstore', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'appUpgradeCheckBefore', function () use ($log) {
+            $log->info('\OC\Updater::appUpgradeCheckBefore: Checking updates of apps', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'appSimulateUpdate', function ($app) use ($log) {
+            $log->info('\OC\Updater::appSimulateUpdate: Checking whether the database schema for <' . $app . '> can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'appUpgradeCheck', function () use ($log) {
+            $log->info('\OC\Updater::appUpgradeCheck: Checked database schema update for apps', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'appUpgradeStarted', function ($app) use ($log) {
+            $log->info('\OC\Updater::appUpgradeStarted: Updating <' . $app . '> ...', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'appUpgrade', function ($app, $version) use ($log) {
+            $log->info('\OC\Updater::appUpgrade: Updated <' . $app . '> to ' . $version, ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'failure', function ($message) use ($log) {
+            $log->error('\OC\Updater::failure: ' . $message, ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'setDebugLogLevel', function () use ($log) {
+            $log->info('\OC\Updater::setDebugLogLevel: Set log level to debug', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'resetLogLevel', function ($logLevel, $logLevelName) use ($log) {
+            $log->info('\OC\Updater::resetLogLevel: Reset log level to ' . $logLevelName . '(' . $logLevel . ')', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'startCheckCodeIntegrity', function () use ($log) {
+            $log->info('\OC\Updater::startCheckCodeIntegrity: Starting code integrity check...', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'finishedCheckCodeIntegrity', function () use ($log) {
+            $log->info('\OC\Updater::finishedCheckCodeIntegrity: Finished code integrity check', ['app' => 'updater']);
+        });
+
+    }
 
 }

Spacing +69 added lines, -69 removed lines

@@ -104,19 +104,19 @@ 
 		$this->logAllEvents();
 
 		$logLevel = $this->config->getSystemValue('loglevel', ILogger::WARN);
-		$this->emit('\OC\Updater', 'setDebugLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
+		$this->emit('\OC\Updater', 'setDebugLogLevel', [$logLevel, $this->logLevelNames[$logLevel]]);
 		$this->config->setSystemValue('loglevel', ILogger::DEBUG);
 
 		$wasMaintenanceModeEnabled = $this->config->getSystemValueBool('maintenance');
 
-		if(!$wasMaintenanceModeEnabled) {
+		if (!$wasMaintenanceModeEnabled) {
 			$this->config->setSystemValue('maintenance', true);
 			$this->emit('\OC\Updater', 'maintenanceEnabled');
 		}
 
 		// Clear CAN_INSTALL file if not on git
 		if (\OC_Util::getChannel() !== 'git' && is_file(\OC::$configDir.'/CAN_INSTALL')) {
-			if (!unlink(\OC::$configDir . '/CAN_INSTALL')) {
+			if (!unlink(\OC::$configDir.'/CAN_INSTALL')) {
 				$this->log->error('Could not cleanup CAN_INSTALL from your config folder. Please remove this file manually.');
 			}
 		}
@@ -124,31 +124,31 @@ 
 		$installedVersion = $this->config->getSystemValue('version', '0.0.0');
 		$currentVersion = implode('.', \OCP\Util::getVersion());
 
-		$this->log->debug('starting upgrade from ' . $installedVersion . ' to ' . $currentVersion, ['app' => 'core']);
+		$this->log->debug('starting upgrade from '.$installedVersion.' to '.$currentVersion, ['app' => 'core']);
 
 		$success = true;
 		try {
 			$this->doUpgrade($currentVersion, $installedVersion);
 		} catch (HintException $exception) {
 			$this->log->logException($exception, ['app' => 'core']);
-			$this->emit('\OC\Updater', 'failure', [$exception->getMessage() . ': ' .$exception->getHint()]);
+			$this->emit('\OC\Updater', 'failure', [$exception->getMessage().': '.$exception->getHint()]);
 			$success = false;
 		} catch (\Exception $exception) {
 			$this->log->logException($exception, ['app' => 'core']);
-			$this->emit('\OC\Updater', 'failure', [get_class($exception) . ': ' .$exception->getMessage()]);
+			$this->emit('\OC\Updater', 'failure', [get_class($exception).': '.$exception->getMessage()]);
 			$success = false;
 		}
 
 		$this->emit('\OC\Updater', 'updateEnd', [$success]);
 
-		if(!$wasMaintenanceModeEnabled && $success) {
+		if (!$wasMaintenanceModeEnabled && $success) {
 			$this->config->setSystemValue('maintenance', false);
 			$this->emit('\OC\Updater', 'maintenanceDisabled');
 		} else {
 			$this->emit('\OC\Updater', 'maintenanceActive');
 		}
 
-		$this->emit('\OC\Updater', 'resetLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
+		$this->emit('\OC\Updater', 'resetLogLevel', [$logLevel, $this->logLevelNames[$logLevel]]);
 		$this->config->setSystemValue('loglevel', $logLevel);
 		$this->config->setSystemValue('installed', true);
 
@@ -162,7 +162,7 @@ 
 	 */
 	private function getAllowedPreviousVersions() {
 		// this should really be a JSON file
-		require \OC::$SERVERROOT . '/version.php';
+		require \OC::$SERVERROOT.'/version.php';
 		/** @var array $OC_VersionCanBeUpgradedFrom */
 		return $OC_VersionCanBeUpgradedFrom;
 	}
@@ -174,7 +174,7 @@ 
 	 */
 	private function getVendor() {
 		// this should really be a JSON file
-		require \OC::$SERVERROOT . '/version.php';
+		require \OC::$SERVERROOT.'/version.php';
 		/** @var string $vendor */
 		return (string) $vendor;
 	}
@@ -188,7 +188,7 @@ 
 	 */
 	public function isUpgradePossible($oldVersion, $newVersion, array $allowedPreviousVersions) {
 		$version = explode('.', $oldVersion);
-		$majorMinor = $version[0] . '.' . $version[1];
+		$majorMinor = $version[0].'.'.$version[1];
 
 		$currentVendor = $this->config->getAppValue('core', 'vendor', '');
 
@@ -235,7 +235,7 @@ 
 		// create empty file in data dir, so we can later find
 		// out that this is indeed an ownCloud data directory
 		// (in case it didn't exist before)
-		file_put_contents($this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/.ocdata', '');
+		file_put_contents($this->config->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').'/.ocdata', '');
 
 		// pre-upgrade repairs
 		$repair = new Repair(Repair::getBeforeUpgradeRepairSteps(), \OC::$server->getEventDispatcher());
@@ -268,7 +268,7 @@ 
 		foreach ($errors as $appId => $exception) {
 			/** @var \Exception $exception */
 			$this->log->logException($exception, ['app' => $appId]);
-			$this->emit('\OC\Updater', 'failure', [$appId . ': ' . $exception->getMessage()]);
+			$this->emit('\OC\Updater', 'failure', [$appId.': '.$exception->getMessage()]);
 		}
 
 		// post-upgrade repairs
@@ -279,7 +279,7 @@ 
 		$this->config->setAppValue('core', 'lastupdatedat', 0);
 
 		// Check for code integrity if not disabled
-		if(\OC::$server->getIntegrityCodeChecker()->isCodeCheckEnforced()) {
+		if (\OC::$server->getIntegrityCodeChecker()->isCodeCheckEnforced()) {
 			$this->emit('\OC\Updater', 'startCheckCodeIntegrity');
 			$this->checker->runInstanceVerification();
 			$this->emit('\OC\Updater', 'finishedCheckCodeIntegrity');
@@ -320,12 +320,12 @@ 
 				 * @link https://github.com/owncloud/core/issues/10980
 				 * @see \OC_App::updateApp
 				 */
-				if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/preupdate.php')) {
+				if (file_exists(\OC_App::getAppPath($appId).'/appinfo/preupdate.php')) {
 					$this->includePreUpdate($appId);
 				}
-				if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/database.xml')) {
+				if (file_exists(\OC_App::getAppPath($appId).'/appinfo/database.xml')) {
 					$this->emit('\OC\Updater', 'appSimulateUpdate', [$appId]);
-					\OC_DB::simulateUpdateDbFromStructure(\OC_App::getAppPath($appId) . '/appinfo/database.xml');
+					\OC_DB::simulateUpdateDbFromStructure(\OC_App::getAppPath($appId).'/appinfo/database.xml');
 				}
 			}
 		}
@@ -338,7 +338,7 @@ 
 	 * @param string $appId
 	 */
 	private function includePreUpdate($appId) {
-		include \OC_App::getAppPath($appId) . '/appinfo/preupdate.php';
+		include \OC_App::getAppPath($appId).'/appinfo/preupdate.php';
 	}
 
 	/**
@@ -356,7 +356,7 @@ 
 		foreach ($apps as $appId) {
 			$priorityType = false;
 			foreach ($priorityTypes as $type) {
-				if(!isset($stacks[$type])) {
+				if (!isset($stacks[$type])) {
 					$stacks[$type] = [];
 				}
 				if (\OC_App::isType($appId, [$type])) {
@@ -376,7 +376,7 @@ 
 					\OC_App::updateApp($appId);
 					$this->emit('\OC\Updater', 'appUpgrade', [$appId, \OC_App::getAppVersion($appId)]);
 				}
-				if($type !== $pseudoOtherType) {
+				if ($type !== $pseudoOtherType) {
 					// load authentication, filesystem and logging apps after
 					// upgrading them. Other apps my need to rely on modifying
 					// user and/or filesystem aspects.
@@ -404,9 +404,9 @@ 
 		foreach ($apps as $app) {
 			// check if the app is compatible with this version of ownCloud
 			$info = OC_App::getAppInfo($app);
-			if($info === null || !OC_App::isAppCompatible($version, $info)) {
+			if ($info === null || !OC_App::isAppCompatible($version, $info)) {
 				if ($appManager->isShipped($app)) {
-					throw new \UnexpectedValueException('The files of the app "' . $app . '" were not correctly replaced before running the update');
+					throw new \UnexpectedValueException('The files of the app "'.$app.'" were not correctly replaced before running the update');
 				}
 				\OC::$server->getAppManager()->disableApp($app, true);
 				$this->emit('\OC\Updater', 'incompatibleAppDisabled', [$app]);
@@ -445,7 +445,7 @@ 
 	 * @throws \Exception
 	 */
 	private function upgradeAppStoreApps(array $disabledApps, $reenable = false) {
-		foreach($disabledApps as $app) {
+		foreach ($disabledApps as $app) {
 			try {
 				$this->emit('\OC\Updater', 'checkAppStoreAppBefore', [$app]);
 				if ($this->installer->isUpdateAvailable($app)) {
@@ -469,22 +469,22 @@ 
 	 */
 	private function emitRepairEvents() {
 		$dispatcher = \OC::$server->getEventDispatcher();
-		$dispatcher->addListener('\OC\Repair::warning', function ($event) {
+		$dispatcher->addListener('\OC\Repair::warning', function($event) {
 			if ($event instanceof GenericEvent) {
 				$this->emit('\OC\Updater', 'repairWarning', $event->getArguments());
 			}
 		});
-		$dispatcher->addListener('\OC\Repair::error', function ($event) {
+		$dispatcher->addListener('\OC\Repair::error', function($event) {
 			if ($event instanceof GenericEvent) {
 				$this->emit('\OC\Updater', 'repairError', $event->getArguments());
 			}
 		});
-		$dispatcher->addListener('\OC\Repair::info', function ($event) {
+		$dispatcher->addListener('\OC\Repair::info', function($event) {
 			if ($event instanceof GenericEvent) {
 				$this->emit('\OC\Updater', 'repairInfo', $event->getArguments());
 			}
 		});
-		$dispatcher->addListener('\OC\Repair::step', function ($event) {
+		$dispatcher->addListener('\OC\Repair::step', function($event) {
 			if ($event instanceof GenericEvent) {
 				$this->emit('\OC\Updater', 'repairStep', $event->getArguments());
 			}
@@ -495,49 +495,49 @@ 
 		$log = $this->log;
 
 		$dispatcher = \OC::$server->getEventDispatcher();
-		$dispatcher->addListener('\OC\DB\Migrator::executeSql', function ($event) use ($log) {
+		$dispatcher->addListener('\OC\DB\Migrator::executeSql', function($event) use ($log) {
 			if (!$event instanceof GenericEvent) {
 				return;
 			}
-			$log->info('\OC\DB\Migrator::executeSql: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
+			$log->info('\OC\DB\Migrator::executeSql: '.$event->getSubject().' ('.$event->getArgument(0).' of '.$event->getArgument(1).')', ['app' => 'updater']);
 		});
-		$dispatcher->addListener('\OC\DB\Migrator::checkTable', function ($event) use ($log) {
+		$dispatcher->addListener('\OC\DB\Migrator::checkTable', function($event) use ($log) {
 			if (!$event instanceof GenericEvent) {
 				return;
 			}
-			$log->info('\OC\DB\Migrator::checkTable: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
+			$log->info('\OC\DB\Migrator::checkTable: '.$event->getSubject().' ('.$event->getArgument(0).' of '.$event->getArgument(1).')', ['app' => 'updater']);
 		});
 
-		$repairListener = function ($event) use ($log) {
+		$repairListener = function($event) use ($log) {
 			if (!$event instanceof GenericEvent) {
 				return;
 			}
 			switch ($event->getSubject()) {
 				case '\OC\Repair::startProgress':
-					$log->info('\OC\Repair::startProgress: Starting ... ' . $event->getArgument(1) .  ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
+					$log->info('\OC\Repair::startProgress: Starting ... '.$event->getArgument(1).' ('.$event->getArgument(0).')', ['app' => 'updater']);
 					break;
 				case '\OC\Repair::advance':
 					$desc = $event->getArgument(1);
 					if (empty($desc)) {
 						$desc = '';
 					}
-					$log->info('\OC\Repair::advance: ' . $desc . ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
+					$log->info('\OC\Repair::advance: '.$desc.' ('.$event->getArgument(0).')', ['app' => 'updater']);
 
 					break;
 				case '\OC\Repair::finishProgress':
 					$log->info('\OC\Repair::finishProgress', ['app' => 'updater']);
 					break;
 				case '\OC\Repair::step':
-					$log->info('\OC\Repair::step: Repair step: ' . $event->getArgument(0), ['app' => 'updater']);
+					$log->info('\OC\Repair::step: Repair step: '.$event->getArgument(0), ['app' => 'updater']);
 					break;
 				case '\OC\Repair::info':
-					$log->info('\OC\Repair::info: Repair info: ' . $event->getArgument(0), ['app' => 'updater']);
+					$log->info('\OC\Repair::info: Repair info: '.$event->getArgument(0), ['app' => 'updater']);
 					break;
 				case '\OC\Repair::warning':
-					$log->warning('\OC\Repair::warning: Repair warning: ' . $event->getArgument(0), ['app' => 'updater']);
+					$log->warning('\OC\Repair::warning: Repair warning: '.$event->getArgument(0), ['app' => 'updater']);
 					break;
 				case '\OC\Repair::error':
-					$log->error('\OC\Repair::error: Repair error: ' . $event->getArgument(0), ['app' => 'updater']);
+					$log->error('\OC\Repair::error: Repair error: '.$event->getArgument(0), ['app' => 'updater']);
 					break;
 			}
 		};
@@ -551,74 +551,74 @@ 
 		$dispatcher->addListener('\OC\Repair::error', $repairListener);
 
 
-		$this->listen('\OC\Updater', 'maintenanceEnabled', function () use ($log) {
+		$this->listen('\OC\Updater', 'maintenanceEnabled', function() use ($log) {
 			$log->info('\OC\Updater::maintenanceEnabled: Turned on maintenance mode', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'maintenanceDisabled', function () use ($log) {
+		$this->listen('\OC\Updater', 'maintenanceDisabled', function() use ($log) {
 			$log->info('\OC\Updater::maintenanceDisabled: Turned off maintenance mode', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'maintenanceActive', function () use ($log) {
+		$this->listen('\OC\Updater', 'maintenanceActive', function() use ($log) {
 			$log->info('\OC\Updater::maintenanceActive: Maintenance mode is kept active', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'updateEnd', function ($success) use ($log) {
+		$this->listen('\OC\Updater', 'updateEnd', function($success) use ($log) {
 			if ($success) {
 				$log->info('\OC\Updater::updateEnd: Update successful', ['app' => 'updater']);
 			} else {
 				$log->error('\OC\Updater::updateEnd: Update failed', ['app' => 'updater']);
 			}
 		});
-		$this->listen('\OC\Updater', 'dbUpgradeBefore', function () use ($log) {
+		$this->listen('\OC\Updater', 'dbUpgradeBefore', function() use ($log) {
 			$log->info('\OC\Updater::dbUpgradeBefore: Updating database schema', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'dbUpgrade', function () use ($log) {
+		$this->listen('\OC\Updater', 'dbUpgrade', function() use ($log) {
 			$log->info('\OC\Updater::dbUpgrade: Updated database', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'dbSimulateUpgradeBefore', function () use ($log) {
+		$this->listen('\OC\Updater', 'dbSimulateUpgradeBefore', function() use ($log) {
 			$log->info('\OC\Updater::dbSimulateUpgradeBefore: Checking whether the database schema can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'dbSimulateUpgrade', function () use ($log) {
+		$this->listen('\OC\Updater', 'dbSimulateUpgrade', function() use ($log) {
 			$log->info('\OC\Updater::dbSimulateUpgrade: Checked database schema update', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'incompatibleAppDisabled', function ($app) use ($log) {
-			$log->info('\OC\Updater::incompatibleAppDisabled: Disabled incompatible app: ' . $app, ['app' => 'updater']);
+		$this->listen('\OC\Updater', 'incompatibleAppDisabled', function($app) use ($log) {
+			$log->info('\OC\Updater::incompatibleAppDisabled: Disabled incompatible app: '.$app, ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'checkAppStoreAppBefore', function ($app) use ($log) {
-			$log->info('\OC\Updater::checkAppStoreAppBefore: Checking for update of app "' . $app . '" in appstore', ['app' => 'updater']);
+		$this->listen('\OC\Updater', 'checkAppStoreAppBefore', function($app) use ($log) {
+			$log->info('\OC\Updater::checkAppStoreAppBefore: Checking for update of app "'.$app.'" in appstore', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'upgradeAppStoreApp', function ($app) use ($log) {
-			$log->info('\OC\Updater::upgradeAppStoreApp: Update app "' . $app . '" from appstore', ['app' => 'updater']);
+		$this->listen('\OC\Updater', 'upgradeAppStoreApp', function($app) use ($log) {
+			$log->info('\OC\Updater::upgradeAppStoreApp: Update app "'.$app.'" from appstore', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'checkAppStoreApp', function ($app) use ($log) {
-			$log->info('\OC\Updater::checkAppStoreApp: Checked for update of app "' . $app . '" in appstore', ['app' => 'updater']);
+		$this->listen('\OC\Updater', 'checkAppStoreApp', function($app) use ($log) {
+			$log->info('\OC\Updater::checkAppStoreApp: Checked for update of app "'.$app.'" in appstore', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'appUpgradeCheckBefore', function () use ($log) {
+		$this->listen('\OC\Updater', 'appUpgradeCheckBefore', function() use ($log) {
 			$log->info('\OC\Updater::appUpgradeCheckBefore: Checking updates of apps', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'appSimulateUpdate', function ($app) use ($log) {
-			$log->info('\OC\Updater::appSimulateUpdate: Checking whether the database schema for <' . $app . '> can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
+		$this->listen('\OC\Updater', 'appSimulateUpdate', function($app) use ($log) {
+			$log->info('\OC\Updater::appSimulateUpdate: Checking whether the database schema for <'.$app.'> can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'appUpgradeCheck', function () use ($log) {
+		$this->listen('\OC\Updater', 'appUpgradeCheck', function() use ($log) {
 			$log->info('\OC\Updater::appUpgradeCheck: Checked database schema update for apps', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'appUpgradeStarted', function ($app) use ($log) {
-			$log->info('\OC\Updater::appUpgradeStarted: Updating <' . $app . '> ...', ['app' => 'updater']);
+		$this->listen('\OC\Updater', 'appUpgradeStarted', function($app) use ($log) {
+			$log->info('\OC\Updater::appUpgradeStarted: Updating <'.$app.'> ...', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'appUpgrade', function ($app, $version) use ($log) {
-			$log->info('\OC\Updater::appUpgrade: Updated <' . $app . '> to ' . $version, ['app' => 'updater']);
+		$this->listen('\OC\Updater', 'appUpgrade', function($app, $version) use ($log) {
+			$log->info('\OC\Updater::appUpgrade: Updated <'.$app.'> to '.$version, ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'failure', function ($message) use ($log) {
-			$log->error('\OC\Updater::failure: ' . $message, ['app' => 'updater']);
+		$this->listen('\OC\Updater', 'failure', function($message) use ($log) {
+			$log->error('\OC\Updater::failure: '.$message, ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'setDebugLogLevel', function () use ($log) {
+		$this->listen('\OC\Updater', 'setDebugLogLevel', function() use ($log) {
 			$log->info('\OC\Updater::setDebugLogLevel: Set log level to debug', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'resetLogLevel', function ($logLevel, $logLevelName) use ($log) {
-			$log->info('\OC\Updater::resetLogLevel: Reset log level to ' . $logLevelName . '(' . $logLevel . ')', ['app' => 'updater']);
+		$this->listen('\OC\Updater', 'resetLogLevel', function($logLevel, $logLevelName) use ($log) {
+			$log->info('\OC\Updater::resetLogLevel: Reset log level to '.$logLevelName.'('.$logLevel.')', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'startCheckCodeIntegrity', function () use ($log) {
+		$this->listen('\OC\Updater', 'startCheckCodeIntegrity', function() use ($log) {
 			$log->info('\OC\Updater::startCheckCodeIntegrity: Starting code integrity check...', ['app' => 'updater']);
 		});
-		$this->listen('\OC\Updater', 'finishedCheckCodeIntegrity', function () use ($log) {
+		$this->listen('\OC\Updater', 'finishedCheckCodeIntegrity', function() use ($log) {
 			$log->info('\OC\Updater::finishedCheckCodeIntegrity: Finished code integrity check', ['app' => 'updater']);
 		});
 

lib/private/Tags.php

Indentation +805 added lines, -805 removed lines

@@ -54,809 +54,809 @@
 
 class Tags implements ITags {
 
-	/**
-	 * Tags
-	 *
-	 * @var array
-	 */
-	private $tags = [];
-
-	/**
-	 * Used for storing objectid/categoryname pairs while rescanning.
-	 *
-	 * @var array
-	 */
-	private static $relations = [];
-
-	/**
-	 * Type
-	 *
-	 * @var string
-	 */
-	private $type;
-
-	/**
-	 * User
-	 *
-	 * @var string
-	 */
-	private $user;
-
-	/**
-	 * Are we including tags for shared items?
-	 *
-	 * @var bool
-	 */
-	private $includeShared = false;
-
-	/**
-	 * The current user, plus any owners of the items shared with the current
-	 * user, if $this->includeShared === true.
-	 *
-	 * @var array
-	 */
-	private $owners = [];
-
-	/**
-	 * The Mapper we're using to communicate our Tag objects to the database.
-	 *
-	 * @var TagMapper
-	 */
-	private $mapper;
-
-	/**
-	 * The sharing backend for objects of $this->type. Required if
-	 * $this->includeShared === true to determine ownership of items.
-	 *
-	 * @var \OCP\Share_Backend
-	 */
-	private $backend;
-
-	const TAG_TABLE = '*PREFIX*vcategory';
-	const RELATION_TABLE = '*PREFIX*vcategory_to_object';
-
-	/**
-	 * Constructor.
-	 *
-	 * @param TagMapper $mapper Instance of the TagMapper abstraction layer.
-	 * @param string $user The user whose data the object will operate on.
-	 * @param string $type The type of items for which tags will be loaded.
-	 * @param array $defaultTags Tags that should be created at construction.
-	 * @param boolean $includeShared Whether to include tags for items shared with this user by others.
-	 */
-	public function __construct(TagMapper $mapper, $user, $type, $defaultTags = [], $includeShared = false) {
-		$this->mapper = $mapper;
-		$this->user = $user;
-		$this->type = $type;
-		$this->includeShared = $includeShared;
-		$this->owners = [$this->user];
-		if ($this->includeShared) {
-			$this->owners = array_merge($this->owners, \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true));
-			$this->backend = \OC\Share\Share::getBackend($this->type);
-		}
-		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-
-		if(count($defaultTags) > 0 && count($this->tags) === 0) {
-			$this->addMultiple($defaultTags, true);
-		}
-	}
-
-	/**
-	 * Check if any tags are saved for this type and user.
-	 *
-	 * @return boolean
-	 */
-	public function isEmpty() {
-		return count($this->tags) === 0;
-	}
-
-	/**
-	 * Returns an array mapping a given tag's properties to its values:
-	 * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	 *
-	 * @param string $id The ID of the tag that is going to be mapped
-	 * @return array|false
-	 */
-	public function getTag($id) {
-		$key = $this->getTagById($id);
-		if ($key !== false) {
-			return $this->tagMap($this->tags[$key]);
-		}
-		return false;
-	}
-
-	/**
-	 * Get the tags for a specific user.
-	 *
-	 * This returns an array with maps containing each tag's properties:
-	 * [
-	 * 	['id' => 0, 'name' = 'First tag', 'owner' = 'User', 'type' => 'tagtype'],
-	 * 	['id' => 1, 'name' = 'Shared tag', 'owner' = 'Other user', 'type' => 'tagtype'],
-	 * ]
-	 *
-	 * @return array
-	 */
-	public function getTags() {
-		if(!count($this->tags)) {
-			return [];
-		}
-
-		usort($this->tags, function ($a, $b) {
-			return strnatcasecmp($a->getName(), $b->getName());
-		});
-		$tagMap = [];
-
-		foreach($this->tags as $tag) {
-			if($tag->getName() !== ITags::TAG_FAVORITE) {
-				$tagMap[] = $this->tagMap($tag);
-			}
-		}
-		return $tagMap;
-
-	}
-
-	/**
-	 * Return only the tags owned by the given user, omitting any tags shared
-	 * by other users.
-	 *
-	 * @param string $user The user whose tags are to be checked.
-	 * @return array An array of Tag objects.
-	 */
-	public function getTagsForUser($user) {
-		return array_filter($this->tags,
-			function ($tag) use ($user) {
-				return $tag->getOwner() === $user;
-			}
-		);
-	}
-
-	/**
-	 * Get the list of tags for the given ids.
-	 *
-	 * @param array $objIds array of object ids
-	 * @return array|boolean of tags id as key to array of tag names
-	 * or false if an error occurred
-	 */
-	public function getTagsForObjects(array $objIds) {
-		$entries = [];
-
-		try {
-			$conn = \OC::$server->getDatabaseConnection();
-			$chunks = array_chunk($objIds, 900, false);
-			foreach ($chunks as $chunk) {
-				$result = $conn->executeQuery(
-					'SELECT `category`, `categoryid`, `objid` ' .
-					'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
-					'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
-					[$this->user, $this->type, $chunk],
-					[null, null, IQueryBuilder::PARAM_INT_ARRAY]
-				);
-				while ($row = $result->fetch()) {
-					$objId = (int)$row['objid'];
-					if (!isset($entries[$objId])) {
-						$entries[$objId] = [];
-					}
-					$entries[$objId][] = $row['category'];
-				}
-				if ($result === null) {
-					\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
-					return false;
-				}
-			}
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => ILogger::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-
-		return $entries;
-	}
-
-	/**
-	 * Get the a list if items tagged with $tag.
-	 *
-	 * Throws an exception if the tag could not be found.
-	 *
-	 * @param string $tag Tag id or name.
-	 * @return array|false An array of object ids or false on error.
-	 * @throws \Exception
-	 */
-	public function getIdsForTag($tag) {
-		$result = null;
-		$tagId = false;
-		if(is_numeric($tag)) {
-			$tagId = $tag;
-		} elseif(is_string($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', ILogger::DEBUG);
-				return false;
-			}
-			$tagId = $this->getTagId($tag);
-		}
-
-		if($tagId === false) {
-			$l10n = \OC::$server->getL10N('core');
-			throw new \Exception(
-				$l10n->t('Could not find category "%s"', [$tag])
-			);
-		}
-
-		$ids = [];
-		$sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
-			. '` WHERE `categoryid` = ?';
-
-		try {
-			$stmt = \OC_DB::prepare($sql);
-			$result = $stmt->execute([$tagId]);
-			if ($result === null) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
-				return false;
-			}
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => ILogger::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-
-		if(!is_null($result)) {
-			while( $row = $result->fetchRow()) {
-				$id = (int)$row['objid'];
-
-				if ($this->includeShared) {
-					// We have to check if we are really allowed to access the
-					// items that are tagged with $tag. To that end, we ask the
-					// corresponding sharing backend if the item identified by $id
-					// is owned by any of $this->owners.
-					foreach ($this->owners as $owner) {
-						if ($this->backend->isValidSource($id, $owner)) {
-							$ids[] = $id;
-							break;
-						}
-					}
-				} else {
-					$ids[] = $id;
-				}
-			}
-		}
-
-		return $ids;
-	}
-
-	/**
-	 * Checks whether a tag is saved for the given user,
-	 * disregarding the ones shared with him or her.
-	 *
-	 * @param string $name The tag name to check for.
-	 * @param string $user The user whose tags are to be checked.
-	 * @return bool
-	 */
-	public function userHasTag($name, $user) {
-		$key = $this->array_searchi($name, $this->getTagsForUser($user));
-		return ($key !== false) ? $this->tags[$key]->getId() : false;
-	}
-
-	/**
-	 * Checks whether a tag is saved for or shared with the current user.
-	 *
-	 * @param string $name The tag name to check for.
-	 * @return bool
-	 */
-	public function hasTag($name) {
-		return $this->getTagId($name) !== false;
-	}
-
-	/**
-	 * Add a new tag.
-	 *
-	 * @param string $name A string with a name of the tag
-	 * @return false|int the id of the added tag or false on error.
-	 */
-	public function add($name) {
-		$name = trim($name);
-
-		if($name === '') {
-			\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', ILogger::DEBUG);
-			return false;
-		}
-		if($this->userHasTag($name, $this->user)) {
-			\OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', ILogger::DEBUG);
-			return false;
-		}
-		try {
-			$tag = new Tag($this->user, $this->type, $name);
-			$tag = $this->mapper->insert($tag);
-			$this->tags[] = $tag;
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => ILogger::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		\OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), ILogger::DEBUG);
-		return $tag->getId();
-	}
-
-	/**
-	 * Rename tag.
-	 *
-	 * @param string|integer $from The name or ID of the existing tag
-	 * @param string $to The new name of the tag.
-	 * @return bool
-	 */
-	public function rename($from, $to) {
-		$from = trim($from);
-		$to = trim($to);
-
-		if($to === '' || $from === '') {
-			\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', ILogger::DEBUG);
-			return false;
-		}
-
-		if (is_numeric($from)) {
-			$key = $this->getTagById($from);
-		} else {
-			$key = $this->getTagByName($from);
-		}
-		if($key === false) {
-			\OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', ILogger::DEBUG);
-			return false;
-		}
-		$tag = $this->tags[$key];
-
-		if($this->userHasTag($to, $tag->getOwner())) {
-			\OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', ILogger::DEBUG);
-			return false;
-		}
-
-		try {
-			$tag->setName($to);
-			$this->tags[$key] = $this->mapper->update($tag);
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => ILogger::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * Add a list of new tags.
-	 *
-	 * @param string[] $names A string with a name or an array of strings containing
-	 * the name(s) of the tag(s) to add.
-	 * @param bool $sync When true, save the tags
-	 * @param int|null $id int Optional object id to add to this|these tag(s)
-	 * @return bool Returns false on error.
-	 */
-	public function addMultiple($names, $sync=false, $id = null) {
-		if(!is_array($names)) {
-			$names = [$names];
-		}
-		$names = array_map('trim', $names);
-		array_filter($names);
-
-		$newones = [];
-		foreach($names as $name) {
-			if(!$this->hasTag($name) && $name !== '') {
-				$newones[] = new Tag($this->user, $this->type, $name);
-			}
-			if(!is_null($id) ) {
-				// Insert $objectid, $categoryid  pairs if not exist.
-				self::$relations[] = ['objid' => $id, 'tag' => $name];
-			}
-		}
-		$this->tags = array_merge($this->tags, $newones);
-		if($sync === true) {
-			$this->save();
-		}
-
-		return true;
-	}
-
-	/**
-	 * Save the list of tags and their object relations
-	 */
-	protected function save() {
-		if(is_array($this->tags)) {
-			foreach($this->tags as $tag) {
-				try {
-					if (!$this->mapper->tagExists($tag)) {
-						$this->mapper->insert($tag);
-					}
-				} catch(\Exception $e) {
-					\OC::$server->getLogger()->logException($e, [
-						'message' => __METHOD__,
-						'level' => ILogger::ERROR,
-						'app' => 'core',
-					]);
-				}
-			}
-
-			// reload tags to get the proper ids.
-			$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-			\OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
-				ILogger::DEBUG);
-			// Loop through temporarily cached objectid/tagname pairs
-			// and save relations.
-			$tags = $this->tags;
-			// For some reason this is needed or array_search(i) will return 0..?
-			ksort($tags);
-			$dbConnection = \OC::$server->getDatabaseConnection();
-			foreach(self::$relations as $relation) {
-				$tagId = $this->getTagId($relation['tag']);
-				\OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, ILogger::DEBUG);
-				if($tagId) {
-					try {
-						$dbConnection->insertIfNotExist(self::RELATION_TABLE,
-							[
-								'objid' => $relation['objid'],
-								'categoryid' => $tagId,
-								'type' => $this->type,
-							]);
-					} catch(\Exception $e) {
-						\OC::$server->getLogger()->logException($e, [
-							'message' => __METHOD__,
-							'level' => ILogger::ERROR,
-							'app' => 'core',
-						]);
-					}
-				}
-			}
-			self::$relations = []; // reset
-		} else {
-			\OCP\Util::writeLog('core', __METHOD__.', $this->tags is not an array! '
-				. print_r($this->tags, true), ILogger::ERROR);
-		}
-	}
-
-	/**
-	 * Delete tags and tag/object relations for a user.
-	 *
-	 * For hooking up on post_deleteUser
-	 *
-	 * @param array $arguments
-	 */
-	public static function post_deleteUser($arguments) {
-		// Find all objectid/tagId pairs.
-		$result = null;
-		try {
-			$stmt = \OC_DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
-				. 'WHERE `uid` = ?');
-			$result = $stmt->execute([$arguments['uid']]);
-			if ($result === null) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
-			}
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => ILogger::ERROR,
-				'app' => 'core',
-			]);
-		}
-
-		if(!is_null($result)) {
-			try {
-				$stmt = \OC_DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
-					. 'WHERE `categoryid` = ?');
-				while( $row = $result->fetchRow()) {
-					try {
-						$stmt->execute([$row['id']]);
-					} catch(\Exception $e) {
-						\OC::$server->getLogger()->logException($e, [
-							'message' => __METHOD__,
-							'level' => ILogger::ERROR,
-							'app' => 'core',
-						]);
-					}
-				}
-			} catch(\Exception $e) {
-				\OC::$server->getLogger()->logException($e, [
-					'message' => __METHOD__,
-					'level' => ILogger::ERROR,
-					'app' => 'core',
-				]);
-			}
-		}
-		try {
-			$stmt = \OC_DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
-				. 'WHERE `uid` = ?');
-			$result = $stmt->execute([$arguments['uid']]);
-			if ($result === null) {
-				\OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
-			}
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => ILogger::ERROR,
-				'app' => 'core',
-			]);
-		}
-	}
-
-	/**
-	 * Delete tag/object relations from the db
-	 *
-	 * @param array $ids The ids of the objects
-	 * @return boolean Returns false on error.
-	 */
-	public function purgeObjects(array $ids) {
-		if(count($ids) === 0) {
-			// job done ;)
-			return true;
-		}
-		$updates = $ids;
-		try {
-			$query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
-			$query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
-			$query .= 'AND `type`= ?';
-			$updates[] = $this->type;
-			$stmt = \OC_DB::prepare($query);
-			$result = $stmt->execute($updates);
-			if ($result === null) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
-				return false;
-			}
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => ILogger::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * Get favorites for an object type
-	 *
-	 * @return array|false An array of object ids.
-	 */
-	public function getFavorites() {
-		if(!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
-			return [];
-		}
-
-		try {
-			return $this->getIdsForTag(ITags::TAG_FAVORITE);
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => ILogger::ERROR,
-				'app' => 'core',
-			]);
-			return [];
-		}
-	}
-
-	/**
-	 * Add an object to favorites
-	 *
-	 * @param int $objid The id of the object
-	 * @return boolean
-	 */
-	public function addToFavorites($objid) {
-		if(!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
-			$this->add(ITags::TAG_FAVORITE);
-		}
-		return $this->tagAs($objid, ITags::TAG_FAVORITE);
-	}
-
-	/**
-	 * Remove an object from favorites
-	 *
-	 * @param int $objid The id of the object
-	 * @return boolean
-	 */
-	public function removeFromFavorites($objid) {
-		return $this->unTag($objid, ITags::TAG_FAVORITE);
-	}
-
-	/**
-	 * Creates a tag/object relation.
-	 *
-	 * @param int $objid The id of the object
-	 * @param string $tag The id or name of the tag
-	 * @return boolean Returns false on error.
-	 */
-	public function tagAs($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', ILogger::DEBUG);
-				return false;
-			}
-			if(!$this->hasTag($tag)) {
-				$this->add($tag);
-			}
-			$tagId =  $this->getTagId($tag);
-		} else {
-			$tagId = $tag;
-		}
-		try {
-			\OC::$server->getDatabaseConnection()->insertIfNotExist(self::RELATION_TABLE,
-				[
-					'objid' => $objid,
-					'categoryid' => $tagId,
-					'type' => $this->type,
-				]);
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => ILogger::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * Delete single tag/object relation from the db
-	 *
-	 * @param int $objid The id of the object
-	 * @param string $tag The id or name of the tag
-	 * @return boolean
-	 */
-	public function unTag($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', ILogger::DEBUG);
-				return false;
-			}
-			$tagId =  $this->getTagId($tag);
-		} else {
-			$tagId = $tag;
-		}
-
-		try {
-			$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
-					. 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
-			$stmt = \OC_DB::prepare($sql);
-			$stmt->execute([$objid, $tagId, $this->type]);
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => ILogger::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * Delete tags from the database.
-	 *
-	 * @param string[]|integer[] $names An array of tags (names or IDs) to delete
-	 * @return bool Returns false on error
-	 */
-	public function delete($names) {
-		if(!is_array($names)) {
-			$names = [$names];
-		}
-
-		$names = array_map('trim', $names);
-		array_filter($names);
-
-		\OCP\Util::writeLog('core', __METHOD__ . ', before: '
-			. print_r($this->tags, true), ILogger::DEBUG);
-		foreach($names as $name) {
-			$id = null;
-
-			if (is_numeric($name)) {
-				$key = $this->getTagById($name);
-			} else {
-				$key = $this->getTagByName($name);
-			}
-			if ($key !== false) {
-				$tag = $this->tags[$key];
-				$id = $tag->getId();
-				unset($this->tags[$key]);
-				$this->mapper->delete($tag);
-			} else {
-				\OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
-					. ': not found.', ILogger::ERROR);
-			}
-			if(!is_null($id) && $id !== false) {
-				try {
-					$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
-							. 'WHERE `categoryid` = ?';
-					$stmt = \OC_DB::prepare($sql);
-					$result = $stmt->execute([$id]);
-					if ($result === null) {
-						\OCP\Util::writeLog('core',
-							__METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(),
-							ILogger::ERROR);
-						return false;
-					}
-				} catch(\Exception $e) {
-					\OC::$server->getLogger()->logException($e, [
-						'message' => __METHOD__,
-						'level' => ILogger::ERROR,
-						'app' => 'core',
-					]);
-					return false;
-				}
-			}
-		}
-		return true;
-	}
-
-	// case-insensitive array_search
-	protected function array_searchi($needle, $haystack, $mem='getName') {
-		if(!is_array($haystack)) {
-			return false;
-		}
-		return array_search(strtolower($needle), array_map(
-			function ($tag) use ($mem) {
-				return strtolower(call_user_func([$tag, $mem]));
-			}, $haystack)
-		);
-	}
-
-	/**
-	 * Get a tag's ID.
-	 *
-	 * @param string $name The tag name to look for.
-	 * @return string|bool The tag's id or false if no matching tag is found.
-	 */
-	private function getTagId($name) {
-		$key = $this->array_searchi($name, $this->tags);
-		if ($key !== false) {
-			return $this->tags[$key]->getId();
-		}
-		return false;
-	}
-
-	/**
-	 * Get a tag by its name.
-	 *
-	 * @param string $name The tag name.
-	 * @return integer|bool The tag object's offset within the $this->tags
-	 *                      array or false if it doesn't exist.
-	 */
-	private function getTagByName($name) {
-		return $this->array_searchi($name, $this->tags, 'getName');
-	}
-
-	/**
-	 * Get a tag by its ID.
-	 *
-	 * @param string $id The tag ID to look for.
-	 * @return integer|bool The tag object's offset within the $this->tags
-	 *                      array or false if it doesn't exist.
-	 */
-	private function getTagById($id) {
-		return $this->array_searchi($id, $this->tags, 'getId');
-	}
-
-	/**
-	 * Returns an array mapping a given tag's properties to its values:
-	 * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	 *
-	 * @param Tag $tag The tag that is going to be mapped
-	 * @return array
-	 */
-	private function tagMap(Tag $tag) {
-		return [
-			'id'    => $tag->getId(),
-			'name'  => $tag->getName(),
-			'owner' => $tag->getOwner(),
-			'type'  => $tag->getType()
-		];
-	}
+    /**
+     * Tags
+     *
+     * @var array
+     */
+    private $tags = [];
+
+    /**
+     * Used for storing objectid/categoryname pairs while rescanning.
+     *
+     * @var array
+     */
+    private static $relations = [];
+
+    /**
+     * Type
+     *
+     * @var string
+     */
+    private $type;
+
+    /**
+     * User
+     *
+     * @var string
+     */
+    private $user;
+
+    /**
+     * Are we including tags for shared items?
+     *
+     * @var bool
+     */
+    private $includeShared = false;
+
+    /**
+     * The current user, plus any owners of the items shared with the current
+     * user, if $this->includeShared === true.
+     *
+     * @var array
+     */
+    private $owners = [];
+
+    /**
+     * The Mapper we're using to communicate our Tag objects to the database.
+     *
+     * @var TagMapper
+     */
+    private $mapper;
+
+    /**
+     * The sharing backend for objects of $this->type. Required if
+     * $this->includeShared === true to determine ownership of items.
+     *
+     * @var \OCP\Share_Backend
+     */
+    private $backend;
+
+    const TAG_TABLE = '*PREFIX*vcategory';
+    const RELATION_TABLE = '*PREFIX*vcategory_to_object';
+
+    /**
+     * Constructor.
+     *
+     * @param TagMapper $mapper Instance of the TagMapper abstraction layer.
+     * @param string $user The user whose data the object will operate on.
+     * @param string $type The type of items for which tags will be loaded.
+     * @param array $defaultTags Tags that should be created at construction.
+     * @param boolean $includeShared Whether to include tags for items shared with this user by others.
+     */
+    public function __construct(TagMapper $mapper, $user, $type, $defaultTags = [], $includeShared = false) {
+        $this->mapper = $mapper;
+        $this->user = $user;
+        $this->type = $type;
+        $this->includeShared = $includeShared;
+        $this->owners = [$this->user];
+        if ($this->includeShared) {
+            $this->owners = array_merge($this->owners, \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true));
+            $this->backend = \OC\Share\Share::getBackend($this->type);
+        }
+        $this->tags = $this->mapper->loadTags($this->owners, $this->type);
+
+        if(count($defaultTags) > 0 && count($this->tags) === 0) {
+            $this->addMultiple($defaultTags, true);
+        }
+    }
+
+    /**
+     * Check if any tags are saved for this type and user.
+     *
+     * @return boolean
+     */
+    public function isEmpty() {
+        return count($this->tags) === 0;
+    }
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param string $id The ID of the tag that is going to be mapped
+     * @return array|false
+     */
+    public function getTag($id) {
+        $key = $this->getTagById($id);
+        if ($key !== false) {
+            return $this->tagMap($this->tags[$key]);
+        }
+        return false;
+    }
+
+    /**
+     * Get the tags for a specific user.
+     *
+     * This returns an array with maps containing each tag's properties:
+     * [
+     * 	['id' => 0, 'name' = 'First tag', 'owner' = 'User', 'type' => 'tagtype'],
+     * 	['id' => 1, 'name' = 'Shared tag', 'owner' = 'Other user', 'type' => 'tagtype'],
+     * ]
+     *
+     * @return array
+     */
+    public function getTags() {
+        if(!count($this->tags)) {
+            return [];
+        }
+
+        usort($this->tags, function ($a, $b) {
+            return strnatcasecmp($a->getName(), $b->getName());
+        });
+        $tagMap = [];
+
+        foreach($this->tags as $tag) {
+            if($tag->getName() !== ITags::TAG_FAVORITE) {
+                $tagMap[] = $this->tagMap($tag);
+            }
+        }
+        return $tagMap;
+
+    }
+
+    /**
+     * Return only the tags owned by the given user, omitting any tags shared
+     * by other users.
+     *
+     * @param string $user The user whose tags are to be checked.
+     * @return array An array of Tag objects.
+     */
+    public function getTagsForUser($user) {
+        return array_filter($this->tags,
+            function ($tag) use ($user) {
+                return $tag->getOwner() === $user;
+            }
+        );
+    }
+
+    /**
+     * Get the list of tags for the given ids.
+     *
+     * @param array $objIds array of object ids
+     * @return array|boolean of tags id as key to array of tag names
+     * or false if an error occurred
+     */
+    public function getTagsForObjects(array $objIds) {
+        $entries = [];
+
+        try {
+            $conn = \OC::$server->getDatabaseConnection();
+            $chunks = array_chunk($objIds, 900, false);
+            foreach ($chunks as $chunk) {
+                $result = $conn->executeQuery(
+                    'SELECT `category`, `categoryid`, `objid` ' .
+                    'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
+                    'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
+                    [$this->user, $this->type, $chunk],
+                    [null, null, IQueryBuilder::PARAM_INT_ARRAY]
+                );
+                while ($row = $result->fetch()) {
+                    $objId = (int)$row['objid'];
+                    if (!isset($entries[$objId])) {
+                        $entries[$objId] = [];
+                    }
+                    $entries[$objId][] = $row['category'];
+                }
+                if ($result === null) {
+                    \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
+                    return false;
+                }
+            }
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => ILogger::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+
+        return $entries;
+    }
+
+    /**
+     * Get the a list if items tagged with $tag.
+     *
+     * Throws an exception if the tag could not be found.
+     *
+     * @param string $tag Tag id or name.
+     * @return array|false An array of object ids or false on error.
+     * @throws \Exception
+     */
+    public function getIdsForTag($tag) {
+        $result = null;
+        $tagId = false;
+        if(is_numeric($tag)) {
+            $tagId = $tag;
+        } elseif(is_string($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', ILogger::DEBUG);
+                return false;
+            }
+            $tagId = $this->getTagId($tag);
+        }
+
+        if($tagId === false) {
+            $l10n = \OC::$server->getL10N('core');
+            throw new \Exception(
+                $l10n->t('Could not find category "%s"', [$tag])
+            );
+        }
+
+        $ids = [];
+        $sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
+            . '` WHERE `categoryid` = ?';
+
+        try {
+            $stmt = \OC_DB::prepare($sql);
+            $result = $stmt->execute([$tagId]);
+            if ($result === null) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
+                return false;
+            }
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => ILogger::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+
+        if(!is_null($result)) {
+            while( $row = $result->fetchRow()) {
+                $id = (int)$row['objid'];
+
+                if ($this->includeShared) {
+                    // We have to check if we are really allowed to access the
+                    // items that are tagged with $tag. To that end, we ask the
+                    // corresponding sharing backend if the item identified by $id
+                    // is owned by any of $this->owners.
+                    foreach ($this->owners as $owner) {
+                        if ($this->backend->isValidSource($id, $owner)) {
+                            $ids[] = $id;
+                            break;
+                        }
+                    }
+                } else {
+                    $ids[] = $id;
+                }
+            }
+        }
+
+        return $ids;
+    }
+
+    /**
+     * Checks whether a tag is saved for the given user,
+     * disregarding the ones shared with him or her.
+     *
+     * @param string $name The tag name to check for.
+     * @param string $user The user whose tags are to be checked.
+     * @return bool
+     */
+    public function userHasTag($name, $user) {
+        $key = $this->array_searchi($name, $this->getTagsForUser($user));
+        return ($key !== false) ? $this->tags[$key]->getId() : false;
+    }
+
+    /**
+     * Checks whether a tag is saved for or shared with the current user.
+     *
+     * @param string $name The tag name to check for.
+     * @return bool
+     */
+    public function hasTag($name) {
+        return $this->getTagId($name) !== false;
+    }
+
+    /**
+     * Add a new tag.
+     *
+     * @param string $name A string with a name of the tag
+     * @return false|int the id of the added tag or false on error.
+     */
+    public function add($name) {
+        $name = trim($name);
+
+        if($name === '') {
+            \OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', ILogger::DEBUG);
+            return false;
+        }
+        if($this->userHasTag($name, $this->user)) {
+            \OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', ILogger::DEBUG);
+            return false;
+        }
+        try {
+            $tag = new Tag($this->user, $this->type, $name);
+            $tag = $this->mapper->insert($tag);
+            $this->tags[] = $tag;
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => ILogger::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        \OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), ILogger::DEBUG);
+        return $tag->getId();
+    }
+
+    /**
+     * Rename tag.
+     *
+     * @param string|integer $from The name or ID of the existing tag
+     * @param string $to The new name of the tag.
+     * @return bool
+     */
+    public function rename($from, $to) {
+        $from = trim($from);
+        $to = trim($to);
+
+        if($to === '' || $from === '') {
+            \OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', ILogger::DEBUG);
+            return false;
+        }
+
+        if (is_numeric($from)) {
+            $key = $this->getTagById($from);
+        } else {
+            $key = $this->getTagByName($from);
+        }
+        if($key === false) {
+            \OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', ILogger::DEBUG);
+            return false;
+        }
+        $tag = $this->tags[$key];
+
+        if($this->userHasTag($to, $tag->getOwner())) {
+            \OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', ILogger::DEBUG);
+            return false;
+        }
+
+        try {
+            $tag->setName($to);
+            $this->tags[$key] = $this->mapper->update($tag);
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => ILogger::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Add a list of new tags.
+     *
+     * @param string[] $names A string with a name or an array of strings containing
+     * the name(s) of the tag(s) to add.
+     * @param bool $sync When true, save the tags
+     * @param int|null $id int Optional object id to add to this|these tag(s)
+     * @return bool Returns false on error.
+     */
+    public function addMultiple($names, $sync=false, $id = null) {
+        if(!is_array($names)) {
+            $names = [$names];
+        }
+        $names = array_map('trim', $names);
+        array_filter($names);
+
+        $newones = [];
+        foreach($names as $name) {
+            if(!$this->hasTag($name) && $name !== '') {
+                $newones[] = new Tag($this->user, $this->type, $name);
+            }
+            if(!is_null($id) ) {
+                // Insert $objectid, $categoryid  pairs if not exist.
+                self::$relations[] = ['objid' => $id, 'tag' => $name];
+            }
+        }
+        $this->tags = array_merge($this->tags, $newones);
+        if($sync === true) {
+            $this->save();
+        }
+
+        return true;
+    }
+
+    /**
+     * Save the list of tags and their object relations
+     */
+    protected function save() {
+        if(is_array($this->tags)) {
+            foreach($this->tags as $tag) {
+                try {
+                    if (!$this->mapper->tagExists($tag)) {
+                        $this->mapper->insert($tag);
+                    }
+                } catch(\Exception $e) {
+                    \OC::$server->getLogger()->logException($e, [
+                        'message' => __METHOD__,
+                        'level' => ILogger::ERROR,
+                        'app' => 'core',
+                    ]);
+                }
+            }
+
+            // reload tags to get the proper ids.
+            $this->tags = $this->mapper->loadTags($this->owners, $this->type);
+            \OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
+                ILogger::DEBUG);
+            // Loop through temporarily cached objectid/tagname pairs
+            // and save relations.
+            $tags = $this->tags;
+            // For some reason this is needed or array_search(i) will return 0..?
+            ksort($tags);
+            $dbConnection = \OC::$server->getDatabaseConnection();
+            foreach(self::$relations as $relation) {
+                $tagId = $this->getTagId($relation['tag']);
+                \OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, ILogger::DEBUG);
+                if($tagId) {
+                    try {
+                        $dbConnection->insertIfNotExist(self::RELATION_TABLE,
+                            [
+                                'objid' => $relation['objid'],
+                                'categoryid' => $tagId,
+                                'type' => $this->type,
+                            ]);
+                    } catch(\Exception $e) {
+                        \OC::$server->getLogger()->logException($e, [
+                            'message' => __METHOD__,
+                            'level' => ILogger::ERROR,
+                            'app' => 'core',
+                        ]);
+                    }
+                }
+            }
+            self::$relations = []; // reset
+        } else {
+            \OCP\Util::writeLog('core', __METHOD__.', $this->tags is not an array! '
+                . print_r($this->tags, true), ILogger::ERROR);
+        }
+    }
+
+    /**
+     * Delete tags and tag/object relations for a user.
+     *
+     * For hooking up on post_deleteUser
+     *
+     * @param array $arguments
+     */
+    public static function post_deleteUser($arguments) {
+        // Find all objectid/tagId pairs.
+        $result = null;
+        try {
+            $stmt = \OC_DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
+                . 'WHERE `uid` = ?');
+            $result = $stmt->execute([$arguments['uid']]);
+            if ($result === null) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
+            }
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => ILogger::ERROR,
+                'app' => 'core',
+            ]);
+        }
+
+        if(!is_null($result)) {
+            try {
+                $stmt = \OC_DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
+                    . 'WHERE `categoryid` = ?');
+                while( $row = $result->fetchRow()) {
+                    try {
+                        $stmt->execute([$row['id']]);
+                    } catch(\Exception $e) {
+                        \OC::$server->getLogger()->logException($e, [
+                            'message' => __METHOD__,
+                            'level' => ILogger::ERROR,
+                            'app' => 'core',
+                        ]);
+                    }
+                }
+            } catch(\Exception $e) {
+                \OC::$server->getLogger()->logException($e, [
+                    'message' => __METHOD__,
+                    'level' => ILogger::ERROR,
+                    'app' => 'core',
+                ]);
+            }
+        }
+        try {
+            $stmt = \OC_DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
+                . 'WHERE `uid` = ?');
+            $result = $stmt->execute([$arguments['uid']]);
+            if ($result === null) {
+                \OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
+            }
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => ILogger::ERROR,
+                'app' => 'core',
+            ]);
+        }
+    }
+
+    /**
+     * Delete tag/object relations from the db
+     *
+     * @param array $ids The ids of the objects
+     * @return boolean Returns false on error.
+     */
+    public function purgeObjects(array $ids) {
+        if(count($ids) === 0) {
+            // job done ;)
+            return true;
+        }
+        $updates = $ids;
+        try {
+            $query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
+            $query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
+            $query .= 'AND `type`= ?';
+            $updates[] = $this->type;
+            $stmt = \OC_DB::prepare($query);
+            $result = $stmt->execute($updates);
+            if ($result === null) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
+                return false;
+            }
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => ILogger::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Get favorites for an object type
+     *
+     * @return array|false An array of object ids.
+     */
+    public function getFavorites() {
+        if(!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
+            return [];
+        }
+
+        try {
+            return $this->getIdsForTag(ITags::TAG_FAVORITE);
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => ILogger::ERROR,
+                'app' => 'core',
+            ]);
+            return [];
+        }
+    }
+
+    /**
+     * Add an object to favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     */
+    public function addToFavorites($objid) {
+        if(!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
+            $this->add(ITags::TAG_FAVORITE);
+        }
+        return $this->tagAs($objid, ITags::TAG_FAVORITE);
+    }
+
+    /**
+     * Remove an object from favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     */
+    public function removeFromFavorites($objid) {
+        return $this->unTag($objid, ITags::TAG_FAVORITE);
+    }
+
+    /**
+     * Creates a tag/object relation.
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @return boolean Returns false on error.
+     */
+    public function tagAs($objid, $tag) {
+        if(is_string($tag) && !is_numeric($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', ILogger::DEBUG);
+                return false;
+            }
+            if(!$this->hasTag($tag)) {
+                $this->add($tag);
+            }
+            $tagId =  $this->getTagId($tag);
+        } else {
+            $tagId = $tag;
+        }
+        try {
+            \OC::$server->getDatabaseConnection()->insertIfNotExist(self::RELATION_TABLE,
+                [
+                    'objid' => $objid,
+                    'categoryid' => $tagId,
+                    'type' => $this->type,
+                ]);
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => ILogger::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Delete single tag/object relation from the db
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @return boolean
+     */
+    public function unTag($objid, $tag) {
+        if(is_string($tag) && !is_numeric($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', ILogger::DEBUG);
+                return false;
+            }
+            $tagId =  $this->getTagId($tag);
+        } else {
+            $tagId = $tag;
+        }
+
+        try {
+            $sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+                    . 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
+            $stmt = \OC_DB::prepare($sql);
+            $stmt->execute([$objid, $tagId, $this->type]);
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => ILogger::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Delete tags from the database.
+     *
+     * @param string[]|integer[] $names An array of tags (names or IDs) to delete
+     * @return bool Returns false on error
+     */
+    public function delete($names) {
+        if(!is_array($names)) {
+            $names = [$names];
+        }
+
+        $names = array_map('trim', $names);
+        array_filter($names);
+
+        \OCP\Util::writeLog('core', __METHOD__ . ', before: '
+            . print_r($this->tags, true), ILogger::DEBUG);
+        foreach($names as $name) {
+            $id = null;
+
+            if (is_numeric($name)) {
+                $key = $this->getTagById($name);
+            } else {
+                $key = $this->getTagByName($name);
+            }
+            if ($key !== false) {
+                $tag = $this->tags[$key];
+                $id = $tag->getId();
+                unset($this->tags[$key]);
+                $this->mapper->delete($tag);
+            } else {
+                \OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
+                    . ': not found.', ILogger::ERROR);
+            }
+            if(!is_null($id) && $id !== false) {
+                try {
+                    $sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+                            . 'WHERE `categoryid` = ?';
+                    $stmt = \OC_DB::prepare($sql);
+                    $result = $stmt->execute([$id]);
+                    if ($result === null) {
+                        \OCP\Util::writeLog('core',
+                            __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(),
+                            ILogger::ERROR);
+                        return false;
+                    }
+                } catch(\Exception $e) {
+                    \OC::$server->getLogger()->logException($e, [
+                        'message' => __METHOD__,
+                        'level' => ILogger::ERROR,
+                        'app' => 'core',
+                    ]);
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
+    // case-insensitive array_search
+    protected function array_searchi($needle, $haystack, $mem='getName') {
+        if(!is_array($haystack)) {
+            return false;
+        }
+        return array_search(strtolower($needle), array_map(
+            function ($tag) use ($mem) {
+                return strtolower(call_user_func([$tag, $mem]));
+            }, $haystack)
+        );
+    }
+
+    /**
+     * Get a tag's ID.
+     *
+     * @param string $name The tag name to look for.
+     * @return string|bool The tag's id or false if no matching tag is found.
+     */
+    private function getTagId($name) {
+        $key = $this->array_searchi($name, $this->tags);
+        if ($key !== false) {
+            return $this->tags[$key]->getId();
+        }
+        return false;
+    }
+
+    /**
+     * Get a tag by its name.
+     *
+     * @param string $name The tag name.
+     * @return integer|bool The tag object's offset within the $this->tags
+     *                      array or false if it doesn't exist.
+     */
+    private function getTagByName($name) {
+        return $this->array_searchi($name, $this->tags, 'getName');
+    }
+
+    /**
+     * Get a tag by its ID.
+     *
+     * @param string $id The tag ID to look for.
+     * @return integer|bool The tag object's offset within the $this->tags
+     *                      array or false if it doesn't exist.
+     */
+    private function getTagById($id) {
+        return $this->array_searchi($id, $this->tags, 'getId');
+    }
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param Tag $tag The tag that is going to be mapped
+     * @return array
+     */
+    private function tagMap(Tag $tag) {
+        return [
+            'id'    => $tag->getId(),
+            'name'  => $tag->getName(),
+            'owner' => $tag->getOwner(),
+            'type'  => $tag->getType()
+        ];
+    }
 }

Spacing +86 added lines, -86 removed lines

@@ -136,7 +136,7 @@ 
 		}
 		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
 
-		if(count($defaultTags) > 0 && count($this->tags) === 0) {
+		if (count($defaultTags) > 0 && count($this->tags) === 0) {
 			$this->addMultiple($defaultTags, true);
 		}
 	}
@@ -177,17 +177,17 @@ 
 	 * @return array
 	 */
 	public function getTags() {
-		if(!count($this->tags)) {
+		if (!count($this->tags)) {
 			return [];
 		}
 
-		usort($this->tags, function ($a, $b) {
+		usort($this->tags, function($a, $b) {
 			return strnatcasecmp($a->getName(), $b->getName());
 		});
 		$tagMap = [];
 
-		foreach($this->tags as $tag) {
-			if($tag->getName() !== ITags::TAG_FAVORITE) {
+		foreach ($this->tags as $tag) {
+			if ($tag->getName() !== ITags::TAG_FAVORITE) {
 				$tagMap[] = $this->tagMap($tag);
 			}
 		}
@@ -204,7 +204,7 @@ 
 	 */
 	public function getTagsForUser($user) {
 		return array_filter($this->tags,
-			function ($tag) use ($user) {
+			function($tag) use ($user) {
 				return $tag->getOwner() === $user;
 			}
 		);
@@ -225,25 +225,25 @@ 
 			$chunks = array_chunk($objIds, 900, false);
 			foreach ($chunks as $chunk) {
 				$result = $conn->executeQuery(
-					'SELECT `category`, `categoryid`, `objid` ' .
-					'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
+					'SELECT `category`, `categoryid`, `objid` '.
+					'FROM `'.self::RELATION_TABLE.'` r, `'.self::TAG_TABLE.'` '.
 					'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
 					[$this->user, $this->type, $chunk],
 					[null, null, IQueryBuilder::PARAM_INT_ARRAY]
 				);
 				while ($row = $result->fetch()) {
-					$objId = (int)$row['objid'];
+					$objId = (int) $row['objid'];
 					if (!isset($entries[$objId])) {
 						$entries[$objId] = [];
 					}
 					$entries[$objId][] = $row['category'];
 				}
 				if ($result === null) {
-					\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
+					\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
 					return false;
 				}
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => ILogger::ERROR,
@@ -267,18 +267,18 @@ 
 	public function getIdsForTag($tag) {
 		$result = null;
 		$tagId = false;
-		if(is_numeric($tag)) {
+		if (is_numeric($tag)) {
 			$tagId = $tag;
-		} elseif(is_string($tag)) {
+		} elseif (is_string($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', ILogger::DEBUG);
 				return false;
 			}
 			$tagId = $this->getTagId($tag);
 		}
 
-		if($tagId === false) {
+		if ($tagId === false) {
 			$l10n = \OC::$server->getL10N('core');
 			throw new \Exception(
 				$l10n->t('Could not find category "%s"', [$tag])
@@ -286,17 +286,17 @@ 
 		}
 
 		$ids = [];
-		$sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
+		$sql = 'SELECT `objid` FROM `'.self::RELATION_TABLE
 			. '` WHERE `categoryid` = ?';
 
 		try {
 			$stmt = \OC_DB::prepare($sql);
 			$result = $stmt->execute([$tagId]);
 			if ($result === null) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
 				return false;
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => ILogger::ERROR,
@@ -305,9 +305,9 @@ 
 			return false;
 		}
 
-		if(!is_null($result)) {
-			while( $row = $result->fetchRow()) {
-				$id = (int)$row['objid'];
+		if (!is_null($result)) {
+			while ($row = $result->fetchRow()) {
+				$id = (int) $row['objid'];
 
 				if ($this->includeShared) {
 					// We have to check if we are really allowed to access the
@@ -361,19 +361,19 @@ 
 	public function add($name) {
 		$name = trim($name);
 
-		if($name === '') {
+		if ($name === '') {
 			\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', ILogger::DEBUG);
 			return false;
 		}
-		if($this->userHasTag($name, $this->user)) {
-			\OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', ILogger::DEBUG);
+		if ($this->userHasTag($name, $this->user)) {
+			\OCP\Util::writeLog('core', __METHOD__.', name: '.$name.' exists already', ILogger::DEBUG);
 			return false;
 		}
 		try {
 			$tag = new Tag($this->user, $this->type, $name);
 			$tag = $this->mapper->insert($tag);
 			$this->tags[] = $tag;
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => ILogger::ERROR,
@@ -381,7 +381,7 @@ 
 			]);
 			return false;
 		}
-		\OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), ILogger::DEBUG);
+		\OCP\Util::writeLog('core', __METHOD__.', id: '.$tag->getId(), ILogger::DEBUG);
 		return $tag->getId();
 	}
 
@@ -396,7 +396,7 @@ 
 		$from = trim($from);
 		$to = trim($to);
 
-		if($to === '' || $from === '') {
+		if ($to === '' || $from === '') {
 			\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', ILogger::DEBUG);
 			return false;
 		}
@@ -406,21 +406,21 @@ 
 		} else {
 			$key = $this->getTagByName($from);
 		}
-		if($key === false) {
-			\OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', ILogger::DEBUG);
+		if ($key === false) {
+			\OCP\Util::writeLog('core', __METHOD__.', tag: '.$from.' does not exist', ILogger::DEBUG);
 			return false;
 		}
 		$tag = $this->tags[$key];
 
-		if($this->userHasTag($to, $tag->getOwner())) {
-			\OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', ILogger::DEBUG);
+		if ($this->userHasTag($to, $tag->getOwner())) {
+			\OCP\Util::writeLog('core', __METHOD__.', A tag named '.$to.' already exists for user '.$tag->getOwner().'.', ILogger::DEBUG);
 			return false;
 		}
 
 		try {
 			$tag->setName($to);
 			$this->tags[$key] = $this->mapper->update($tag);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => ILogger::ERROR,
@@ -440,25 +440,25 @@ 
 	 * @param int|null $id int Optional object id to add to this|these tag(s)
 	 * @return bool Returns false on error.
 	 */
-	public function addMultiple($names, $sync=false, $id = null) {
-		if(!is_array($names)) {
+	public function addMultiple($names, $sync = false, $id = null) {
+		if (!is_array($names)) {
 			$names = [$names];
 		}
 		$names = array_map('trim', $names);
 		array_filter($names);
 
 		$newones = [];
-		foreach($names as $name) {
-			if(!$this->hasTag($name) && $name !== '') {
+		foreach ($names as $name) {
+			if (!$this->hasTag($name) && $name !== '') {
 				$newones[] = new Tag($this->user, $this->type, $name);
 			}
-			if(!is_null($id) ) {
+			if (!is_null($id)) {
 				// Insert $objectid, $categoryid  pairs if not exist.
 				self::$relations[] = ['objid' => $id, 'tag' => $name];
 			}
 		}
 		$this->tags = array_merge($this->tags, $newones);
-		if($sync === true) {
+		if ($sync === true) {
 			$this->save();
 		}
 
@@ -469,13 +469,13 @@ 
 	 * Save the list of tags and their object relations
 	 */
 	protected function save() {
-		if(is_array($this->tags)) {
-			foreach($this->tags as $tag) {
+		if (is_array($this->tags)) {
+			foreach ($this->tags as $tag) {
 				try {
 					if (!$this->mapper->tagExists($tag)) {
 						$this->mapper->insert($tag);
 					}
-				} catch(\Exception $e) {
+				} catch (\Exception $e) {
 					\OC::$server->getLogger()->logException($e, [
 						'message' => __METHOD__,
 						'level' => ILogger::ERROR,
@@ -486,7 +486,7 @@ 
 
 			// reload tags to get the proper ids.
 			$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-			\OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
+			\OCP\Util::writeLog('core', __METHOD__.', tags: '.print_r($this->tags, true),
 				ILogger::DEBUG);
 			// Loop through temporarily cached objectid/tagname pairs
 			// and save relations.
@@ -494,10 +494,10 @@ 
 			// For some reason this is needed or array_search(i) will return 0..?
 			ksort($tags);
 			$dbConnection = \OC::$server->getDatabaseConnection();
-			foreach(self::$relations as $relation) {
+			foreach (self::$relations as $relation) {
 				$tagId = $this->getTagId($relation['tag']);
-				\OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, ILogger::DEBUG);
-				if($tagId) {
+				\OCP\Util::writeLog('core', __METHOD__.'catid, '.$relation['tag'].' '.$tagId, ILogger::DEBUG);
+				if ($tagId) {
 					try {
 						$dbConnection->insertIfNotExist(self::RELATION_TABLE,
 							[
@@ -505,7 +505,7 @@ 
 								'categoryid' => $tagId,
 								'type' => $this->type,
 							]);
-					} catch(\Exception $e) {
+					} catch (\Exception $e) {
 						\OC::$server->getLogger()->logException($e, [
 							'message' => __METHOD__,
 							'level' => ILogger::ERROR,
@@ -532,13 +532,13 @@ 
 		// Find all objectid/tagId pairs.
 		$result = null;
 		try {
-			$stmt = \OC_DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
+			$stmt = \OC_DB::prepare('SELECT `id` FROM `'.self::TAG_TABLE.'` '
 				. 'WHERE `uid` = ?');
 			$result = $stmt->execute([$arguments['uid']]);
 			if ($result === null) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => ILogger::ERROR,
@@ -546,14 +546,14 @@ 
 			]);
 		}
 
-		if(!is_null($result)) {
+		if (!is_null($result)) {
 			try {
-				$stmt = \OC_DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
+				$stmt = \OC_DB::prepare('DELETE FROM `'.self::RELATION_TABLE.'` '
 					. 'WHERE `categoryid` = ?');
-				while( $row = $result->fetchRow()) {
+				while ($row = $result->fetchRow()) {
 					try {
 						$stmt->execute([$row['id']]);
-					} catch(\Exception $e) {
+					} catch (\Exception $e) {
 						\OC::$server->getLogger()->logException($e, [
 							'message' => __METHOD__,
 							'level' => ILogger::ERROR,
@@ -561,7 +561,7 @@ 
 						]);
 					}
 				}
-			} catch(\Exception $e) {
+			} catch (\Exception $e) {
 				\OC::$server->getLogger()->logException($e, [
 					'message' => __METHOD__,
 					'level' => ILogger::ERROR,
@@ -570,13 +570,13 @@ 
 			}
 		}
 		try {
-			$stmt = \OC_DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
+			$stmt = \OC_DB::prepare('DELETE FROM `'.self::TAG_TABLE.'` '
 				. 'WHERE `uid` = ?');
 			$result = $stmt->execute([$arguments['uid']]);
 			if ($result === null) {
-				\OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.', DB error: '.\OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => ILogger::ERROR,
@@ -592,23 +592,23 @@ 
 	 * @return boolean Returns false on error.
 	 */
 	public function purgeObjects(array $ids) {
-		if(count($ids) === 0) {
+		if (count($ids) === 0) {
 			// job done ;)
 			return true;
 		}
 		$updates = $ids;
 		try {
-			$query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
-			$query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
+			$query = 'DELETE FROM `'.self::RELATION_TABLE.'` ';
+			$query .= 'WHERE `objid` IN ('.str_repeat('?,', count($ids) - 1).'?) ';
 			$query .= 'AND `type`= ?';
 			$updates[] = $this->type;
 			$stmt = \OC_DB::prepare($query);
 			$result = $stmt->execute($updates);
 			if ($result === null) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OC::$server->getDatabaseConnection()->getError(), ILogger::ERROR);
 				return false;
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => ILogger::ERROR,
@@ -625,13 +625,13 @@ 
 	 * @return array|false An array of object ids.
 	 */
 	public function getFavorites() {
-		if(!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
+		if (!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
 			return [];
 		}
 
 		try {
 			return $this->getIdsForTag(ITags::TAG_FAVORITE);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => ILogger::ERROR,
@@ -648,7 +648,7 @@ 
 	 * @return boolean
 	 */
 	public function addToFavorites($objid) {
-		if(!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
+		if (!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
 			$this->add(ITags::TAG_FAVORITE);
 		}
 		return $this->tagAs($objid, ITags::TAG_FAVORITE);
@@ -672,16 +672,16 @@ 
 	 * @return boolean Returns false on error.
 	 */
 	public function tagAs($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
+		if (is_string($tag) && !is_numeric($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', ILogger::DEBUG);
 				return false;
 			}
-			if(!$this->hasTag($tag)) {
+			if (!$this->hasTag($tag)) {
 				$this->add($tag);
 			}
-			$tagId =  $this->getTagId($tag);
+			$tagId = $this->getTagId($tag);
 		} else {
 			$tagId = $tag;
 		}
@@ -692,7 +692,7 @@ 
 					'categoryid' => $tagId,
 					'type' => $this->type,
 				]);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => ILogger::ERROR,
@@ -711,23 +711,23 @@ 
 	 * @return boolean
 	 */
 	public function unTag($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
+		if (is_string($tag) && !is_numeric($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', ILogger::DEBUG);
 				return false;
 			}
-			$tagId =  $this->getTagId($tag);
+			$tagId = $this->getTagId($tag);
 		} else {
 			$tagId = $tag;
 		}
 
 		try {
-			$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+			$sql = 'DELETE FROM `'.self::RELATION_TABLE.'` '
 					. 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
 			$stmt = \OC_DB::prepare($sql);
 			$stmt->execute([$objid, $tagId, $this->type]);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => ILogger::ERROR,
@@ -745,16 +745,16 @@ 
 	 * @return bool Returns false on error
 	 */
 	public function delete($names) {
-		if(!is_array($names)) {
+		if (!is_array($names)) {
 			$names = [$names];
 		}
 
 		$names = array_map('trim', $names);
 		array_filter($names);
 
-		\OCP\Util::writeLog('core', __METHOD__ . ', before: '
+		\OCP\Util::writeLog('core', __METHOD__.', before: '
 			. print_r($this->tags, true), ILogger::DEBUG);
-		foreach($names as $name) {
+		foreach ($names as $name) {
 			$id = null;
 
 			if (is_numeric($name)) {
@@ -768,22 +768,22 @@ 
 				unset($this->tags[$key]);
 				$this->mapper->delete($tag);
 			} else {
-				\OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
+				\OCP\Util::writeLog('core', __METHOD__.'Cannot delete tag '.$name
 					. ': not found.', ILogger::ERROR);
 			}
-			if(!is_null($id) && $id !== false) {
+			if (!is_null($id) && $id !== false) {
 				try {
-					$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+					$sql = 'DELETE FROM `'.self::RELATION_TABLE.'` '
 							. 'WHERE `categoryid` = ?';
 					$stmt = \OC_DB::prepare($sql);
 					$result = $stmt->execute([$id]);
 					if ($result === null) {
 						\OCP\Util::writeLog('core',
-							__METHOD__. 'DB error: ' . \OC::$server->getDatabaseConnection()->getError(),
+							__METHOD__.'DB error: '.\OC::$server->getDatabaseConnection()->getError(),
 							ILogger::ERROR);
 						return false;
 					}
-				} catch(\Exception $e) {
+				} catch (\Exception $e) {
 					\OC::$server->getLogger()->logException($e, [
 						'message' => __METHOD__,
 						'level' => ILogger::ERROR,
@@ -797,12 +797,12 @@ 
 	}
 
 	// case-insensitive array_search
-	protected function array_searchi($needle, $haystack, $mem='getName') {
-		if(!is_array($haystack)) {
+	protected function array_searchi($needle, $haystack, $mem = 'getName') {
+		if (!is_array($haystack)) {
 			return false;
 		}
 		return array_search(strtolower($needle), array_map(
-			function ($tag) use ($mem) {
+			function($tag) use ($mem) {
 				return strtolower(call_user_func([$tag, $mem]));
 			}, $haystack)
 		);

lib/private/Group/Group.php

Indentation +357 added lines, -357 removed lines

@@ -45,361 +45,361 @@
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class Group implements IGroup {
-	/** @var null|string  */
-	protected $displayName;
-
-	/** @var string */
-	private $gid;
-
-	/** @var \OC\User\User[] */
-	private $users = [];
-
-	/** @var bool */
-	private $usersLoaded;
-
-	/** @var Backend[] */
-	private $backends;
-	/** @var EventDispatcherInterface */
-	private $dispatcher;
-	/** @var \OC\User\Manager|IUserManager  */
-	private $userManager;
-	/** @var PublicEmitter */
-	private $emitter;
-
-
-	/**
-	 * @param string $gid
-	 * @param Backend[] $backends
-	 * @param EventDispatcherInterface $dispatcher
-	 * @param IUserManager $userManager
-	 * @param PublicEmitter $emitter
-	 * @param string $displayName
-	 */
-	public function __construct(string $gid, array $backends, EventDispatcherInterface $dispatcher, IUserManager $userManager, PublicEmitter $emitter = null, ?string $displayName = null) {
-		$this->gid = $gid;
-		$this->backends = $backends;
-		$this->dispatcher = $dispatcher;
-		$this->userManager = $userManager;
-		$this->emitter = $emitter;
-		$this->displayName = $displayName;
-	}
-
-	public function getGID() {
-		return $this->gid;
-	}
-
-	public function getDisplayName() {
-		if (is_null($this->displayName)) {
-			foreach ($this->backends as $backend) {
-				if ($backend instanceof IGetDisplayNameBackend) {
-					$displayName = $backend->getDisplayName($this->gid);
-					if (trim($displayName) !== '') {
-						$this->displayName = $displayName;
-						return $this->displayName;
-					}
-				}
-			}
-			return $this->gid;
-		}
-		return $this->displayName;
-	}
-
-	public function setDisplayName(string $displayName): bool {
-		$displayName = trim($displayName);
-		if ($displayName !== '') {
-			foreach ($this->backends as $backend) {
-				if (($backend instanceof ISetDisplayNameBackend)
-					&& $backend->setDisplayName($this->gid, $displayName)) {
-					$this->displayName = $displayName;
-					return true;
-				}
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * get all users in the group
-	 *
-	 * @return \OC\User\User[]
-	 */
-	public function getUsers() {
-		if ($this->usersLoaded) {
-			return $this->users;
-		}
-
-		$userIds = [];
-		foreach ($this->backends as $backend) {
-			$diff = array_diff(
-				$backend->usersInGroup($this->gid),
-				$userIds
-			);
-			if ($diff) {
-				$userIds = array_merge($userIds, $diff);
-			}
-		}
-
-		$this->users = $this->getVerifiedUsers($userIds);
-		$this->usersLoaded = true;
-		return $this->users;
-	}
-
-	/**
-	 * check if a user is in the group
-	 *
-	 * @param IUser $user
-	 * @return bool
-	 */
-	public function inGroup(IUser $user) {
-		if (isset($this->users[$user->getUID()])) {
-			return true;
-		}
-		foreach ($this->backends as $backend) {
-			if ($backend->inGroup($user->getUID(), $this->gid)) {
-				$this->users[$user->getUID()] = $user;
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * add a user to the group
-	 *
-	 * @param IUser $user
-	 */
-	public function addUser(IUser $user) {
-		if ($this->inGroup($user)) {
-			return;
-		}
-
-		$this->dispatcher->dispatch(IGroup::class . '::preAddUser', new GenericEvent($this, [
-			'user' => $user,
-		]));
-
-		if ($this->emitter) {
-			$this->emitter->emit('\OC\Group', 'preAddUser', [$this, $user]);
-		}
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(\OC\Group\Backend::ADD_TO_GROUP)) {
-				$backend->addToGroup($user->getUID(), $this->gid);
-				if ($this->users) {
-					$this->users[$user->getUID()] = $user;
-				}
-
-				$this->dispatcher->dispatch(IGroup::class . '::postAddUser', new GenericEvent($this, [
-					'user' => $user,
-				]));
-
-				if ($this->emitter) {
-					$this->emitter->emit('\OC\Group', 'postAddUser', [$this, $user]);
-				}
-				return;
-			}
-		}
-	}
-
-	/**
-	 * remove a user from the group
-	 *
-	 * @param \OC\User\User $user
-	 */
-	public function removeUser($user) {
-		$result = false;
-		$this->dispatcher->dispatch(IGroup::class . '::preRemoveUser', new GenericEvent($this, [
-			'user' => $user,
-		]));
-		if ($this->emitter) {
-			$this->emitter->emit('\OC\Group', 'preRemoveUser', [$this, $user]);
-		}
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(\OC\Group\Backend::REMOVE_FROM_GOUP) and $backend->inGroup($user->getUID(), $this->gid)) {
-				$backend->removeFromGroup($user->getUID(), $this->gid);
-				$result = true;
-			}
-		}
-		if ($result) {
-			$this->dispatcher->dispatch(IGroup::class . '::postRemoveUser', new GenericEvent($this, [
-				'user' => $user,
-			]));
-			if ($this->emitter) {
-				$this->emitter->emit('\OC\Group', 'postRemoveUser', [$this, $user]);
-			}
-			if ($this->users) {
-				foreach ($this->users as $index => $groupUser) {
-					if ($groupUser->getUID() === $user->getUID()) {
-						unset($this->users[$index]);
-						return;
-					}
-				}
-			}
-		}
-	}
-
-	/**
-	 * search for users in the group by userid
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OC\User\User[]
-	 */
-	public function searchUsers($search, $limit = null, $offset = null) {
-		$users = [];
-		foreach ($this->backends as $backend) {
-			$userIds = $backend->usersInGroup($this->gid, $search, $limit, $offset);
-			$users += $this->getVerifiedUsers($userIds);
-			if (!is_null($limit) and $limit <= 0) {
-				return $users;
-			}
-		}
-		return $users;
-	}
-
-	/**
-	 * returns the number of users matching the search string
-	 *
-	 * @param string $search
-	 * @return int|bool
-	 */
-	public function count($search = '') {
-		$users = false;
-		foreach ($this->backends as $backend) {
-			if($backend->implementsActions(\OC\Group\Backend::COUNT_USERS)) {
-				if($users === false) {
-					//we could directly add to a bool variable, but this would
-					//be ugly
-					$users = 0;
-				}
-				$users += $backend->countUsersInGroup($this->gid, $search);
-			}
-		}
-		return $users;
-	}
-
-	/**
-	 * returns the number of disabled users
-	 *
-	 * @return int|bool
-	 */
-	public function countDisabled() {
-		$users = false;
-		foreach ($this->backends as $backend) {
-			if($backend instanceOf ICountDisabledInGroup) {
-				if($users === false) {
-					//we could directly add to a bool variable, but this would
-					//be ugly
-					$users = 0;
-				}
-				$users += $backend->countDisabledInGroup($this->gid);
-			}
-		}
-		return $users;
-	}
-
-	/**
-	 * search for users in the group by displayname
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OC\User\User[]
-	 */
-	public function searchDisplayName($search, $limit = null, $offset = null) {
-		$users = [];
-		foreach ($this->backends as $backend) {
-			$userIds = $backend->usersInGroup($this->gid, $search, $limit, $offset);
-			$users = $this->getVerifiedUsers($userIds);
-			if (!is_null($limit) and $limit <= 0) {
-				return array_values($users);
-			}
-		}
-		return array_values($users);
-	}
-
-	/**
-	 * delete the group
-	 *
-	 * @return bool
-	 */
-	public function delete() {
-		// Prevent users from deleting group admin
-		if ($this->getGID() === 'admin') {
-			return false;
-		}
-
-		$result = false;
-		$this->dispatcher->dispatch(IGroup::class . '::preDelete', new GenericEvent($this));
-		if ($this->emitter) {
-			$this->emitter->emit('\OC\Group', 'preDelete', [$this]);
-		}
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(\OC\Group\Backend::DELETE_GROUP)) {
-				$result = true;
-				$backend->deleteGroup($this->gid);
-			}
-		}
-		if ($result) {
-			$this->dispatcher->dispatch(IGroup::class . '::postDelete', new GenericEvent($this));
-			if ($this->emitter) {
-				$this->emitter->emit('\OC\Group', 'postDelete', [$this]);
-			}
-		}
-		return $result;
-	}
-
-	/**
-	 * returns all the Users from an array that really exists
-	 * @param string[] $userIds an array containing user IDs
-	 * @return \OC\User\User[] an Array with the userId as Key and \OC\User\User as value
-	 */
-	private function getVerifiedUsers($userIds) {
-		if (!is_array($userIds)) {
-			return [];
-		}
-		$users = [];
-		foreach ($userIds as $userId) {
-			$user = $this->userManager->get($userId);
-			if (!is_null($user)) {
-				$users[$userId] = $user;
-			}
-		}
-		return $users;
-	}
-
-	/**
-	 * @return bool
-	 * @since 14.0.0
-	 */
-	public function canRemoveUser() {
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(GroupInterface::REMOVE_FROM_GOUP)) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * @return bool
-	 * @since 14.0.0
-	 */
-	public function canAddUser() {
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(GroupInterface::ADD_TO_GROUP)) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function hideFromCollaboration(): bool {
-		return array_reduce($this->backends, function (bool $hide, GroupInterface $backend) {
-			return $hide | ($backend instanceof IHideFromCollaborationBackend && $backend->hideGroup($this->gid));
-		}, false);
-	}
+    /** @var null|string  */
+    protected $displayName;
+
+    /** @var string */
+    private $gid;
+
+    /** @var \OC\User\User[] */
+    private $users = [];
+
+    /** @var bool */
+    private $usersLoaded;
+
+    /** @var Backend[] */
+    private $backends;
+    /** @var EventDispatcherInterface */
+    private $dispatcher;
+    /** @var \OC\User\Manager|IUserManager  */
+    private $userManager;
+    /** @var PublicEmitter */
+    private $emitter;
+
+
+    /**
+     * @param string $gid
+     * @param Backend[] $backends
+     * @param EventDispatcherInterface $dispatcher
+     * @param IUserManager $userManager
+     * @param PublicEmitter $emitter
+     * @param string $displayName
+     */
+    public function __construct(string $gid, array $backends, EventDispatcherInterface $dispatcher, IUserManager $userManager, PublicEmitter $emitter = null, ?string $displayName = null) {
+        $this->gid = $gid;
+        $this->backends = $backends;
+        $this->dispatcher = $dispatcher;
+        $this->userManager = $userManager;
+        $this->emitter = $emitter;
+        $this->displayName = $displayName;
+    }
+
+    public function getGID() {
+        return $this->gid;
+    }
+
+    public function getDisplayName() {
+        if (is_null($this->displayName)) {
+            foreach ($this->backends as $backend) {
+                if ($backend instanceof IGetDisplayNameBackend) {
+                    $displayName = $backend->getDisplayName($this->gid);
+                    if (trim($displayName) !== '') {
+                        $this->displayName = $displayName;
+                        return $this->displayName;
+                    }
+                }
+            }
+            return $this->gid;
+        }
+        return $this->displayName;
+    }
+
+    public function setDisplayName(string $displayName): bool {
+        $displayName = trim($displayName);
+        if ($displayName !== '') {
+            foreach ($this->backends as $backend) {
+                if (($backend instanceof ISetDisplayNameBackend)
+                    && $backend->setDisplayName($this->gid, $displayName)) {
+                    $this->displayName = $displayName;
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * get all users in the group
+     *
+     * @return \OC\User\User[]
+     */
+    public function getUsers() {
+        if ($this->usersLoaded) {
+            return $this->users;
+        }
+
+        $userIds = [];
+        foreach ($this->backends as $backend) {
+            $diff = array_diff(
+                $backend->usersInGroup($this->gid),
+                $userIds
+            );
+            if ($diff) {
+                $userIds = array_merge($userIds, $diff);
+            }
+        }
+
+        $this->users = $this->getVerifiedUsers($userIds);
+        $this->usersLoaded = true;
+        return $this->users;
+    }
+
+    /**
+     * check if a user is in the group
+     *
+     * @param IUser $user
+     * @return bool
+     */
+    public function inGroup(IUser $user) {
+        if (isset($this->users[$user->getUID()])) {
+            return true;
+        }
+        foreach ($this->backends as $backend) {
+            if ($backend->inGroup($user->getUID(), $this->gid)) {
+                $this->users[$user->getUID()] = $user;
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * add a user to the group
+     *
+     * @param IUser $user
+     */
+    public function addUser(IUser $user) {
+        if ($this->inGroup($user)) {
+            return;
+        }
+
+        $this->dispatcher->dispatch(IGroup::class . '::preAddUser', new GenericEvent($this, [
+            'user' => $user,
+        ]));
+
+        if ($this->emitter) {
+            $this->emitter->emit('\OC\Group', 'preAddUser', [$this, $user]);
+        }
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(\OC\Group\Backend::ADD_TO_GROUP)) {
+                $backend->addToGroup($user->getUID(), $this->gid);
+                if ($this->users) {
+                    $this->users[$user->getUID()] = $user;
+                }
+
+                $this->dispatcher->dispatch(IGroup::class . '::postAddUser', new GenericEvent($this, [
+                    'user' => $user,
+                ]));
+
+                if ($this->emitter) {
+                    $this->emitter->emit('\OC\Group', 'postAddUser', [$this, $user]);
+                }
+                return;
+            }
+        }
+    }
+
+    /**
+     * remove a user from the group
+     *
+     * @param \OC\User\User $user
+     */
+    public function removeUser($user) {
+        $result = false;
+        $this->dispatcher->dispatch(IGroup::class . '::preRemoveUser', new GenericEvent($this, [
+            'user' => $user,
+        ]));
+        if ($this->emitter) {
+            $this->emitter->emit('\OC\Group', 'preRemoveUser', [$this, $user]);
+        }
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(\OC\Group\Backend::REMOVE_FROM_GOUP) and $backend->inGroup($user->getUID(), $this->gid)) {
+                $backend->removeFromGroup($user->getUID(), $this->gid);
+                $result = true;
+            }
+        }
+        if ($result) {
+            $this->dispatcher->dispatch(IGroup::class . '::postRemoveUser', new GenericEvent($this, [
+                'user' => $user,
+            ]));
+            if ($this->emitter) {
+                $this->emitter->emit('\OC\Group', 'postRemoveUser', [$this, $user]);
+            }
+            if ($this->users) {
+                foreach ($this->users as $index => $groupUser) {
+                    if ($groupUser->getUID() === $user->getUID()) {
+                        unset($this->users[$index]);
+                        return;
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * search for users in the group by userid
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return \OC\User\User[]
+     */
+    public function searchUsers($search, $limit = null, $offset = null) {
+        $users = [];
+        foreach ($this->backends as $backend) {
+            $userIds = $backend->usersInGroup($this->gid, $search, $limit, $offset);
+            $users += $this->getVerifiedUsers($userIds);
+            if (!is_null($limit) and $limit <= 0) {
+                return $users;
+            }
+        }
+        return $users;
+    }
+
+    /**
+     * returns the number of users matching the search string
+     *
+     * @param string $search
+     * @return int|bool
+     */
+    public function count($search = '') {
+        $users = false;
+        foreach ($this->backends as $backend) {
+            if($backend->implementsActions(\OC\Group\Backend::COUNT_USERS)) {
+                if($users === false) {
+                    //we could directly add to a bool variable, but this would
+                    //be ugly
+                    $users = 0;
+                }
+                $users += $backend->countUsersInGroup($this->gid, $search);
+            }
+        }
+        return $users;
+    }
+
+    /**
+     * returns the number of disabled users
+     *
+     * @return int|bool
+     */
+    public function countDisabled() {
+        $users = false;
+        foreach ($this->backends as $backend) {
+            if($backend instanceOf ICountDisabledInGroup) {
+                if($users === false) {
+                    //we could directly add to a bool variable, but this would
+                    //be ugly
+                    $users = 0;
+                }
+                $users += $backend->countDisabledInGroup($this->gid);
+            }
+        }
+        return $users;
+    }
+
+    /**
+     * search for users in the group by displayname
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return \OC\User\User[]
+     */
+    public function searchDisplayName($search, $limit = null, $offset = null) {
+        $users = [];
+        foreach ($this->backends as $backend) {
+            $userIds = $backend->usersInGroup($this->gid, $search, $limit, $offset);
+            $users = $this->getVerifiedUsers($userIds);
+            if (!is_null($limit) and $limit <= 0) {
+                return array_values($users);
+            }
+        }
+        return array_values($users);
+    }
+
+    /**
+     * delete the group
+     *
+     * @return bool
+     */
+    public function delete() {
+        // Prevent users from deleting group admin
+        if ($this->getGID() === 'admin') {
+            return false;
+        }
+
+        $result = false;
+        $this->dispatcher->dispatch(IGroup::class . '::preDelete', new GenericEvent($this));
+        if ($this->emitter) {
+            $this->emitter->emit('\OC\Group', 'preDelete', [$this]);
+        }
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(\OC\Group\Backend::DELETE_GROUP)) {
+                $result = true;
+                $backend->deleteGroup($this->gid);
+            }
+        }
+        if ($result) {
+            $this->dispatcher->dispatch(IGroup::class . '::postDelete', new GenericEvent($this));
+            if ($this->emitter) {
+                $this->emitter->emit('\OC\Group', 'postDelete', [$this]);
+            }
+        }
+        return $result;
+    }
+
+    /**
+     * returns all the Users from an array that really exists
+     * @param string[] $userIds an array containing user IDs
+     * @return \OC\User\User[] an Array with the userId as Key and \OC\User\User as value
+     */
+    private function getVerifiedUsers($userIds) {
+        if (!is_array($userIds)) {
+            return [];
+        }
+        $users = [];
+        foreach ($userIds as $userId) {
+            $user = $this->userManager->get($userId);
+            if (!is_null($user)) {
+                $users[$userId] = $user;
+            }
+        }
+        return $users;
+    }
+
+    /**
+     * @return bool
+     * @since 14.0.0
+     */
+    public function canRemoveUser() {
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(GroupInterface::REMOVE_FROM_GOUP)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * @return bool
+     * @since 14.0.0
+     */
+    public function canAddUser() {
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(GroupInterface::ADD_TO_GROUP)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * @return bool
+     * @since 16.0.0
+     */
+    public function hideFromCollaboration(): bool {
+        return array_reduce($this->backends, function (bool $hide, GroupInterface $backend) {
+            return $hide | ($backend instanceof IHideFromCollaborationBackend && $backend->hideGroup($this->gid));
+        }, false);
+    }
 }

Spacing +11 added lines, -11 removed lines

@@ -173,7 +173,7 @@ 
 			return;
 		}
 
-		$this->dispatcher->dispatch(IGroup::class . '::preAddUser', new GenericEvent($this, [
+		$this->dispatcher->dispatch(IGroup::class.'::preAddUser', new GenericEvent($this, [
 			'user' => $user,
 		]));
 
@@ -187,7 +187,7 @@ 
 					$this->users[$user->getUID()] = $user;
 				}
 
-				$this->dispatcher->dispatch(IGroup::class . '::postAddUser', new GenericEvent($this, [
+				$this->dispatcher->dispatch(IGroup::class.'::postAddUser', new GenericEvent($this, [
 					'user' => $user,
 				]));
 
@@ -206,7 +206,7 @@ 
 	 */
 	public function removeUser($user) {
 		$result = false;
-		$this->dispatcher->dispatch(IGroup::class . '::preRemoveUser', new GenericEvent($this, [
+		$this->dispatcher->dispatch(IGroup::class.'::preRemoveUser', new GenericEvent($this, [
 			'user' => $user,
 		]));
 		if ($this->emitter) {
@@ -219,7 +219,7 @@ 
 			}
 		}
 		if ($result) {
-			$this->dispatcher->dispatch(IGroup::class . '::postRemoveUser', new GenericEvent($this, [
+			$this->dispatcher->dispatch(IGroup::class.'::postRemoveUser', new GenericEvent($this, [
 				'user' => $user,
 			]));
 			if ($this->emitter) {
@@ -265,8 +265,8 @@ 
 	public function count($search = '') {
 		$users = false;
 		foreach ($this->backends as $backend) {
-			if($backend->implementsActions(\OC\Group\Backend::COUNT_USERS)) {
-				if($users === false) {
+			if ($backend->implementsActions(\OC\Group\Backend::COUNT_USERS)) {
+				if ($users === false) {
 					//we could directly add to a bool variable, but this would
 					//be ugly
 					$users = 0;
@@ -285,8 +285,8 @@ 
 	public function countDisabled() {
 		$users = false;
 		foreach ($this->backends as $backend) {
-			if($backend instanceOf ICountDisabledInGroup) {
-				if($users === false) {
+			if ($backend instanceOf ICountDisabledInGroup) {
+				if ($users === false) {
 					//we could directly add to a bool variable, but this would
 					//be ugly
 					$users = 0;
@@ -329,7 +329,7 @@ 
 		}
 
 		$result = false;
-		$this->dispatcher->dispatch(IGroup::class . '::preDelete', new GenericEvent($this));
+		$this->dispatcher->dispatch(IGroup::class.'::preDelete', new GenericEvent($this));
 		if ($this->emitter) {
 			$this->emitter->emit('\OC\Group', 'preDelete', [$this]);
 		}
@@ -340,7 +340,7 @@ 
 			}
 		}
 		if ($result) {
-			$this->dispatcher->dispatch(IGroup::class . '::postDelete', new GenericEvent($this));
+			$this->dispatcher->dispatch(IGroup::class.'::postDelete', new GenericEvent($this));
 			if ($this->emitter) {
 				$this->emitter->emit('\OC\Group', 'postDelete', [$this]);
 			}
@@ -398,7 +398,7 @@ 
 	 * @since 16.0.0
 	 */
 	public function hideFromCollaboration(): bool {
-		return array_reduce($this->backends, function (bool $hide, GroupInterface $backend) {
+		return array_reduce($this->backends, function(bool $hide, GroupInterface $backend) {
 			return $hide | ($backend instanceof IHideFromCollaborationBackend && $backend->hideGroup($this->gid));
 		}, false);
 	}

lib/private/Group/Database.php

Indentation +412 added lines, -412 removed lines

@@ -61,417 +61,417 @@
  * Class for group management in a SQL Database (e.g. MySQL, SQLite)
  */
 class Database extends ABackend
-	implements IAddToGroupBackend,
-			   ICountDisabledInGroup,
-			   ICountUsersBackend,
-			   ICreateGroupBackend,
-			   IDeleteGroupBackend,
-			   IGetDisplayNameBackend,
-			   IGroupDetailsBackend,
-			   IRemoveFromGroupBackend,
-			   ISetDisplayNameBackend {
-
-	/** @var string[] */
-	private $groupCache = [];
-
-	/** @var IDBConnection */
-	private $dbConn;
-
-	/**
-	 * \OC\Group\Database constructor.
-	 *
-	 * @param IDBConnection|null $dbConn
-	 */
-	public function __construct(IDBConnection $dbConn = null) {
-		$this->dbConn = $dbConn;
-	}
-
-	/**
-	 * FIXME: This function should not be required!
-	 */
-	private function fixDI() {
-		if ($this->dbConn === null) {
-			$this->dbConn = \OC::$server->getDatabaseConnection();
-		}
-	}
-
-	/**
-	 * Try to create a new group
-	 * @param string $gid The name of the group to create
-	 * @return bool
-	 *
-	 * Tries to create a new group. If the group name already exists, false will
-	 * be returned.
-	 */
-	public function createGroup(string $gid): bool {
-		$this->fixDI();
-
-		try {
-			// Add group
-			$builder = $this->dbConn->getQueryBuilder();
-			$result = $builder->insert('groups')
-				->setValue('gid', $builder->createNamedParameter($gid))
-				->setValue('displayname', $builder->createNamedParameter($gid))
-				->execute();
-		} catch(UniqueConstraintViolationException $e) {
-			$result = 0;
-		}
-
-		// Add to cache
-		$this->groupCache[$gid] = $gid;
-
-		return $result === 1;
-	}
-
-	/**
-	 * delete a group
-	 * @param string $gid gid of the group to delete
-	 * @return bool
-	 *
-	 * Deletes a group and removes it from the group_user-table
-	 */
-	public function deleteGroup(string $gid): bool {
-		$this->fixDI();
-
-		// Delete the group
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('groups')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-
-		// Delete the group-user relation
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_user')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-
-		// Delete the group-groupadmin relation
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-
-		// Delete from cache
-		unset($this->groupCache[$gid]);
-
-		return true;
-	}
-
-	/**
-	 * is user in group?
-	 * @param string $uid uid of the user
-	 * @param string $gid gid of the group
-	 * @return bool
-	 *
-	 * Checks whether the user is member of a group or not.
-	 */
-	public function inGroup($uid, $gid) {
-		$this->fixDI();
-
-		// check
-		$qb = $this->dbConn->getQueryBuilder();
-		$cursor = $qb->select('uid')
-			->from('group_user')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->execute();
-
-		$result = $cursor->fetch();
-		$cursor->closeCursor();
-
-		return $result ? true : false;
-	}
-
-	/**
-	 * Add a user to a group
-	 * @param string $uid Name of the user to add to group
-	 * @param string $gid Name of the group in which add the user
-	 * @return bool
-	 *
-	 * Adds a user to a group.
-	 */
-	public function addToGroup(string $uid, string $gid): bool {
-		$this->fixDI();
-
-		// No duplicate entries!
-		if( !$this->inGroup( $uid, $gid )) {
-			$qb = $this->dbConn->getQueryBuilder();
-			$qb->insert('group_user')
-				->setValue('uid', $qb->createNamedParameter($uid))
-				->setValue('gid', $qb->createNamedParameter($gid))
-				->execute();
-			return true;
-		}else{
-			return false;
-		}
-	}
-
-	/**
-	 * Removes a user from a group
-	 * @param string $uid Name of the user to remove from group
-	 * @param string $gid Name of the group from which remove the user
-	 * @return bool
-	 *
-	 * removes the user from a group.
-	 */
-	public function removeFromGroup(string $uid, string $gid): bool {
-		$this->fixDI();
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_user')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->andWhere($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-
-		return true;
-	}
-
-	/**
-	 * Get all groups a user belongs to
-	 * @param string $uid Name of the user
-	 * @return array an array of group names
-	 *
-	 * This function fetches all groups a user belongs to. It does not check
-	 * if the user exists at all.
-	 */
-	public function getUserGroups($uid) {
-		//guests has empty or null $uid
-		if ($uid === null || $uid === '') {
-			return [];
-		}
-
-		$this->fixDI();
-
-		// No magic!
-		$qb = $this->dbConn->getQueryBuilder();
-		$cursor = $qb->select('gid')
-			->from('group_user')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->execute();
-
-		$groups = [];
-		while( $row = $cursor->fetch()) {
-			$groups[] = $row['gid'];
-			$this->groupCache[$row['gid']] = $row['gid'];
-		}
-		$cursor->closeCursor();
-
-		return $groups;
-	}
-
-	/**
-	 * get a list of all groups
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of group names
-	 *
-	 * Returns a list with all groups
-	 */
-	public function getGroups($search = '', $limit = null, $offset = null) {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('gid')
-			->from('groups')
-			->orderBy('gid', 'ASC');
-
-		if ($search !== '') {
-			$query->where($query->expr()->iLike('gid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-		}
-
-		$query->setMaxResults($limit)
-			->setFirstResult($offset);
-		$result = $query->execute();
-
-		$groups = [];
-		while ($row = $result->fetch()) {
-			$groups[] = $row['gid'];
-		}
-		$result->closeCursor();
-
-		return $groups;
-	}
-
-	/**
-	 * check if a group exists
-	 * @param string $gid
-	 * @return bool
-	 */
-	public function groupExists($gid) {
-		$this->fixDI();
-
-		// Check cache first
-		if (isset($this->groupCache[$gid])) {
-			return true;
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$cursor = $qb->select('gid')
-			->from('groups')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-		$result = $cursor->fetch();
-		$cursor->closeCursor();
-
-		if ($result !== false) {
-			$this->groupCache[$gid] = $gid;
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * get a list of all users in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of user ids
-	 */
-	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('uid')
-			->from('group_user')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
-			->orderBy('uid', 'ASC');
-
-		if ($search !== '') {
-			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-		}
-
-		if ($limit !== -1) {
-			$query->setMaxResults($limit);
-		}
-		if ($offset !== 0) {
-			$query->setFirstResult($offset);
-		}
-
-		$result = $query->execute();
-
-		$users = [];
-		while ($row = $result->fetch()) {
-			$users[] = $row['uid'];
-		}
-		$result->closeCursor();
-
-		return $users;
-	}
-
-	/**
-	 * get the number of all users matching the search string in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @return int
-	 */
-	public function countUsersInGroup(string $gid, string $search = ''): int {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->func()->count('*', 'num_users'))
-			->from('group_user')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
-
-		if ($search !== '') {
-			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-		}
-
-		$result = $query->execute();
-		$count = $result->fetchColumn();
-		$result->closeCursor();
-
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
-
-	/**
-	 * get the number of disabled users in a group
-	 *
-	 * @param string $search
-	 *
-	 * @return int
-	 */
-	public function countDisabledInGroup(string $gid): int {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
-			->from('preferences', 'p')
-			->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
-			->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
-			->andWhere($query->expr()->eq('configkey', $query->createNamedParameter('enabled')))
-			->andWhere($query->expr()->eq('configvalue', $query->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
-			->andWhere($query->expr()->eq('gid', $query->createNamedParameter($gid), IQueryBuilder::PARAM_STR));
-
-		$result = $query->execute();
-		$count = $result->fetchColumn();
-		$result->closeCursor();
-
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
-
-	public function getDisplayName(string $gid): string {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('displayname')
-			->from('groups')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
-
-		$result = $query->execute();
-		$displayName = $result->fetchColumn();
-		$result->closeCursor();
-
-		return (string) $displayName;
-	}
-
-	public function getGroupDetails(string $gid): array {
-		$displayName = $this->getDisplayName($gid);
-		if ($displayName !== '') {
-			return ['displayName' => $displayName];
-		}
-
-		return [];
-	}
-
-	public function setDisplayName(string $gid, string $displayName): bool {
-		if (!$this->groupExists($gid)) {
-			return false;
-		}
-
-		$this->fixDI();
-
-		$displayName = trim($displayName);
-		if ($displayName === '') {
-			$displayName = $gid;
-		}
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->update('groups')
-			->set('displayname', $query->createNamedParameter($displayName))
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
-		$query->execute();
-
-		return true;
-	}
+    implements IAddToGroupBackend,
+                ICountDisabledInGroup,
+                ICountUsersBackend,
+                ICreateGroupBackend,
+                IDeleteGroupBackend,
+                IGetDisplayNameBackend,
+                IGroupDetailsBackend,
+                IRemoveFromGroupBackend,
+                ISetDisplayNameBackend {
+
+    /** @var string[] */
+    private $groupCache = [];
+
+    /** @var IDBConnection */
+    private $dbConn;
+
+    /**
+     * \OC\Group\Database constructor.
+     *
+     * @param IDBConnection|null $dbConn
+     */
+    public function __construct(IDBConnection $dbConn = null) {
+        $this->dbConn = $dbConn;
+    }
+
+    /**
+     * FIXME: This function should not be required!
+     */
+    private function fixDI() {
+        if ($this->dbConn === null) {
+            $this->dbConn = \OC::$server->getDatabaseConnection();
+        }
+    }
+
+    /**
+     * Try to create a new group
+     * @param string $gid The name of the group to create
+     * @return bool
+     *
+     * Tries to create a new group. If the group name already exists, false will
+     * be returned.
+     */
+    public function createGroup(string $gid): bool {
+        $this->fixDI();
+
+        try {
+            // Add group
+            $builder = $this->dbConn->getQueryBuilder();
+            $result = $builder->insert('groups')
+                ->setValue('gid', $builder->createNamedParameter($gid))
+                ->setValue('displayname', $builder->createNamedParameter($gid))
+                ->execute();
+        } catch(UniqueConstraintViolationException $e) {
+            $result = 0;
+        }
+
+        // Add to cache
+        $this->groupCache[$gid] = $gid;
+
+        return $result === 1;
+    }
+
+    /**
+     * delete a group
+     * @param string $gid gid of the group to delete
+     * @return bool
+     *
+     * Deletes a group and removes it from the group_user-table
+     */
+    public function deleteGroup(string $gid): bool {
+        $this->fixDI();
+
+        // Delete the group
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('groups')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+
+        // Delete the group-user relation
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_user')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+
+        // Delete the group-groupadmin relation
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+
+        // Delete from cache
+        unset($this->groupCache[$gid]);
+
+        return true;
+    }
+
+    /**
+     * is user in group?
+     * @param string $uid uid of the user
+     * @param string $gid gid of the group
+     * @return bool
+     *
+     * Checks whether the user is member of a group or not.
+     */
+    public function inGroup($uid, $gid) {
+        $this->fixDI();
+
+        // check
+        $qb = $this->dbConn->getQueryBuilder();
+        $cursor = $qb->select('uid')
+            ->from('group_user')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->execute();
+
+        $result = $cursor->fetch();
+        $cursor->closeCursor();
+
+        return $result ? true : false;
+    }
+
+    /**
+     * Add a user to a group
+     * @param string $uid Name of the user to add to group
+     * @param string $gid Name of the group in which add the user
+     * @return bool
+     *
+     * Adds a user to a group.
+     */
+    public function addToGroup(string $uid, string $gid): bool {
+        $this->fixDI();
+
+        // No duplicate entries!
+        if( !$this->inGroup( $uid, $gid )) {
+            $qb = $this->dbConn->getQueryBuilder();
+            $qb->insert('group_user')
+                ->setValue('uid', $qb->createNamedParameter($uid))
+                ->setValue('gid', $qb->createNamedParameter($gid))
+                ->execute();
+            return true;
+        }else{
+            return false;
+        }
+    }
+
+    /**
+     * Removes a user from a group
+     * @param string $uid Name of the user to remove from group
+     * @param string $gid Name of the group from which remove the user
+     * @return bool
+     *
+     * removes the user from a group.
+     */
+    public function removeFromGroup(string $uid, string $gid): bool {
+        $this->fixDI();
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_user')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->andWhere($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+
+        return true;
+    }
+
+    /**
+     * Get all groups a user belongs to
+     * @param string $uid Name of the user
+     * @return array an array of group names
+     *
+     * This function fetches all groups a user belongs to. It does not check
+     * if the user exists at all.
+     */
+    public function getUserGroups($uid) {
+        //guests has empty or null $uid
+        if ($uid === null || $uid === '') {
+            return [];
+        }
+
+        $this->fixDI();
+
+        // No magic!
+        $qb = $this->dbConn->getQueryBuilder();
+        $cursor = $qb->select('gid')
+            ->from('group_user')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->execute();
+
+        $groups = [];
+        while( $row = $cursor->fetch()) {
+            $groups[] = $row['gid'];
+            $this->groupCache[$row['gid']] = $row['gid'];
+        }
+        $cursor->closeCursor();
+
+        return $groups;
+    }
+
+    /**
+     * get a list of all groups
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of group names
+     *
+     * Returns a list with all groups
+     */
+    public function getGroups($search = '', $limit = null, $offset = null) {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('gid')
+            ->from('groups')
+            ->orderBy('gid', 'ASC');
+
+        if ($search !== '') {
+            $query->where($query->expr()->iLike('gid', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+        }
+
+        $query->setMaxResults($limit)
+            ->setFirstResult($offset);
+        $result = $query->execute();
+
+        $groups = [];
+        while ($row = $result->fetch()) {
+            $groups[] = $row['gid'];
+        }
+        $result->closeCursor();
+
+        return $groups;
+    }
+
+    /**
+     * check if a group exists
+     * @param string $gid
+     * @return bool
+     */
+    public function groupExists($gid) {
+        $this->fixDI();
+
+        // Check cache first
+        if (isset($this->groupCache[$gid])) {
+            return true;
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $cursor = $qb->select('gid')
+            ->from('groups')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+        $result = $cursor->fetch();
+        $cursor->closeCursor();
+
+        if ($result !== false) {
+            $this->groupCache[$gid] = $gid;
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * get a list of all users in a group
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of user ids
+     */
+    public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('uid')
+            ->from('group_user')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
+            ->orderBy('uid', 'ASC');
+
+        if ($search !== '') {
+            $query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+        }
+
+        if ($limit !== -1) {
+            $query->setMaxResults($limit);
+        }
+        if ($offset !== 0) {
+            $query->setFirstResult($offset);
+        }
+
+        $result = $query->execute();
+
+        $users = [];
+        while ($row = $result->fetch()) {
+            $users[] = $row['uid'];
+        }
+        $result->closeCursor();
+
+        return $users;
+    }
+
+    /**
+     * get the number of all users matching the search string in a group
+     * @param string $gid
+     * @param string $search
+     * @return int
+     */
+    public function countUsersInGroup(string $gid, string $search = ''): int {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select($query->func()->count('*', 'num_users'))
+            ->from('group_user')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
+
+        if ($search !== '') {
+            $query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+        }
+
+        $result = $query->execute();
+        $count = $result->fetchColumn();
+        $result->closeCursor();
+
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
+
+    /**
+     * get the number of disabled users in a group
+     *
+     * @param string $search
+     *
+     * @return int
+     */
+    public function countDisabledInGroup(string $gid): int {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
+            ->from('preferences', 'p')
+            ->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
+            ->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
+            ->andWhere($query->expr()->eq('configkey', $query->createNamedParameter('enabled')))
+            ->andWhere($query->expr()->eq('configvalue', $query->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
+            ->andWhere($query->expr()->eq('gid', $query->createNamedParameter($gid), IQueryBuilder::PARAM_STR));
+
+        $result = $query->execute();
+        $count = $result->fetchColumn();
+        $result->closeCursor();
+
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
+
+    public function getDisplayName(string $gid): string {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('displayname')
+            ->from('groups')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
+
+        $result = $query->execute();
+        $displayName = $result->fetchColumn();
+        $result->closeCursor();
+
+        return (string) $displayName;
+    }
+
+    public function getGroupDetails(string $gid): array {
+        $displayName = $this->getDisplayName($gid);
+        if ($displayName !== '') {
+            return ['displayName' => $displayName];
+        }
+
+        return [];
+    }
+
+    public function setDisplayName(string $gid, string $displayName): bool {
+        if (!$this->groupExists($gid)) {
+            return false;
+        }
+
+        $this->fixDI();
+
+        $displayName = trim($displayName);
+        if ($displayName === '') {
+            $displayName = $gid;
+        }
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->update('groups')
+            ->set('displayname', $query->createNamedParameter($displayName))
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
+        $query->execute();
+
+        return true;
+    }
 
 }

Spacing +10 added lines, -10 removed lines

@@ -113,7 +113,7 @@ 
 				->setValue('gid', $builder->createNamedParameter($gid))
 				->setValue('displayname', $builder->createNamedParameter($gid))
 				->execute();
-		} catch(UniqueConstraintViolationException $e) {
+		} catch (UniqueConstraintViolationException $e) {
 			$result = 0;
 		}
 
@@ -194,14 +194,14 @@ 
 		$this->fixDI();
 
 		// No duplicate entries!
-		if( !$this->inGroup( $uid, $gid )) {
+		if (!$this->inGroup($uid, $gid)) {
 			$qb = $this->dbConn->getQueryBuilder();
 			$qb->insert('group_user')
 				->setValue('uid', $qb->createNamedParameter($uid))
 				->setValue('gid', $qb->createNamedParameter($gid))
 				->execute();
 			return true;
-		}else{
+		} else {
 			return false;
 		}
 	}
@@ -250,7 +250,7 @@ 
 			->execute();
 
 		$groups = [];
-		while( $row = $cursor->fetch()) {
+		while ($row = $cursor->fetch()) {
 			$groups[] = $row['gid'];
 			$this->groupCache[$row['gid']] = $row['gid'];
 		}
@@ -278,7 +278,7 @@ 
 
 		if ($search !== '') {
 			$query->where($query->expr()->iLike('gid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
 			)));
 		}
 
@@ -342,7 +342,7 @@ 
 
 		if ($search !== '') {
 			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
 			)));
 		}
 
@@ -380,7 +380,7 @@ 
 
 		if ($search !== '') {
 			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
 			)));
 		}
 
@@ -389,7 +389,7 @@ 
 		$result->closeCursor();
 
 		if ($count !== false) {
-			$count = (int)$count;
+			$count = (int) $count;
 		} else {
 			$count = 0;
 		}
@@ -408,7 +408,7 @@ 
 		$this->fixDI();
 
 		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
+		$query->select($query->createFunction('COUNT(DISTINCT '.$query->getColumnName('uid').')'))
 			->from('preferences', 'p')
 			->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
 			->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
@@ -421,7 +421,7 @@ 
 		$result->closeCursor();
 
 		if ($count !== false) {
-			$count = (int)$count;
+			$count = (int) $count;
 		} else {
 			$count = 0;
 		}