nextcloud / server

lib/private/DB/Migrator.php

Indentation +250 added lines, -250 removed lines

@@ -48,254 +48,254 @@
 
 class Migrator {
 
-	/** @var \Doctrine\DBAL\Connection */
-	protected $connection;
-
-	/** @var ISecureRandom */
-	private $random;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var EventDispatcherInterface  */
-	private $dispatcher;
-
-	/** @var bool */
-	private $noEmit = false;
-
-	/**
-	 * @param \Doctrine\DBAL\Connection $connection
-	 * @param ISecureRandom $random
-	 * @param IConfig $config
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(\Doctrine\DBAL\Connection $connection,
-								ISecureRandom $random,
-								IConfig $config,
-								EventDispatcherInterface $dispatcher = null) {
-		$this->connection = $connection;
-		$this->random = $random;
-		$this->config = $config;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 */
-	public function migrate(Schema $targetSchema) {
-		$this->noEmit = true;
-		$this->applySchema($targetSchema);
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 * @return string
-	 */
-	public function generateChangeScript(Schema $targetSchema) {
-		$schemaDiff = $this->getDiff($targetSchema, $this->connection);
-
-		$script = '';
-		$sqls = $schemaDiff->toSql($this->connection->getDatabasePlatform());
-		foreach ($sqls as $sql) {
-			$script .= $this->convertStatementToScript($sql);
-		}
-
-		return $script;
-	}
-
-	/**
-	 * Create a unique name for the temporary table
-	 *
-	 * @param string $name
-	 * @return string
-	 */
-	protected function generateTemporaryTableName($name) {
-		return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
-	}
-
-	/**
-	 * Check the migration of a table on a copy so we can detect errors before messing with the real table
-	 *
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @throws \OC\DB\MigrationException
-	 */
-	protected function checkTableMigrate(Table $table) {
-		$name = $table->getName();
-		$tmpName = $this->generateTemporaryTableName($name);
-
-		$this->copyTable($name, $tmpName);
-
-		//create the migration schema for the temporary table
-		$tmpTable = $this->renameTableSchema($table, $tmpName);
-		$schemaConfig = new SchemaConfig();
-		$schemaConfig->setName($this->connection->getDatabase());
-		$schema = new Schema([$tmpTable], [], $schemaConfig);
-
-		try {
-			$this->applySchema($schema);
-			$this->dropTable($tmpName);
-		} catch (Exception $e) {
-			// pgsql needs to commit it's failed transaction before doing anything else
-			if ($this->connection->isTransactionActive()) {
-				$this->connection->commit();
-			}
-			$this->dropTable($tmpName);
-			throw new MigrationException($table->getName(), $e->getMessage());
-		}
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @param string $newName
-	 * @return \Doctrine\DBAL\Schema\Table
-	 */
-	protected function renameTableSchema(Table $table, $newName) {
-		/**
-		 * @var \Doctrine\DBAL\Schema\Index[] $indexes
-		 */
-		$indexes = $table->getIndexes();
-		$newIndexes = [];
-		foreach ($indexes as $index) {
-			if ($index->isPrimary()) {
-				// do not rename primary key
-				$indexName = $index->getName();
-			} else {
-				// avoid conflicts in index names
-				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
-			}
-			$newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
-		}
-
-		// foreign keys are not supported so we just set it to an empty array
-		return new Table($newName, $table->getColumns(), $newIndexes, [], [], $table->getOptions());
-	}
-
-	public function createSchema() {
-		$this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
-			/** @var string|AbstractAsset $asset */
-			$filterExpression = $this->getFilterExpression();
-			if ($asset instanceof AbstractAsset) {
-				return preg_match($filterExpression, $asset->getName()) !== false;
-			}
-			return preg_match($filterExpression, $asset) !== false;
-		});
-		return $this->connection->getSchemaManager()->createSchema();
-	}
-
-	/**
-	 * @param Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 * @return \Doctrine\DBAL\Schema\SchemaDiff
-	 */
-	protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
-		// adjust varchar columns with a length higher then getVarcharMaxLength to clob
-		foreach ($targetSchema->getTables() as $table) {
-			foreach ($table->getColumns() as $column) {
-				if ($column->getType() instanceof StringType) {
-					if ($column->getLength() > $connection->getDatabasePlatform()->getVarcharMaxLength()) {
-						$column->setType(Type::getType('text'));
-						$column->setLength(null);
-					}
-				}
-			}
-		}
-
-		$this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
-			/** @var string|AbstractAsset $asset */
-			$filterExpression = $this->getFilterExpression();
-			if ($asset instanceof AbstractAsset) {
-				return preg_match($filterExpression, $asset->getName()) !== false;
-			}
-			return preg_match($filterExpression, $asset) !== false;
-		});
-		$sourceSchema = $connection->getSchemaManager()->createSchema();
-
-		// remove tables we don't know about
-		foreach ($sourceSchema->getTables() as $table) {
-			if (!$targetSchema->hasTable($table->getName())) {
-				$sourceSchema->dropTable($table->getName());
-			}
-		}
-		// remove sequences we don't know about
-		foreach ($sourceSchema->getSequences() as $table) {
-			if (!$targetSchema->hasSequence($table->getName())) {
-				$sourceSchema->dropSequence($table->getName());
-			}
-		}
-
-		$comparator = new Comparator();
-		return $comparator->compare($sourceSchema, $targetSchema);
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 */
-	protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
-		if (is_null($connection)) {
-			$connection = $this->connection;
-		}
-
-		$schemaDiff = $this->getDiff($targetSchema, $connection);
-
-		$connection->beginTransaction();
-		$sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
-		$step = 0;
-		foreach ($sqls as $sql) {
-			$this->emit($sql, $step++, count($sqls));
-			$connection->query($sql);
-		}
-		$connection->commit();
-	}
-
-	/**
-	 * @param string $sourceName
-	 * @param string $targetName
-	 */
-	protected function copyTable($sourceName, $targetName) {
-		$quotedSource = $this->connection->quoteIdentifier($sourceName);
-		$quotedTarget = $this->connection->quoteIdentifier($targetName);
-
-		$this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
-		$this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
-	}
-
-	/**
-	 * @param string $name
-	 */
-	protected function dropTable($name) {
-		$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
-	}
-
-	/**
-	 * @param $statement
-	 * @return string
-	 */
-	protected function convertStatementToScript($statement) {
-		$script = $statement . ';';
-		$script .= PHP_EOL;
-		$script .= PHP_EOL;
-		return $script;
-	}
-
-	protected function getFilterExpression() {
-		return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
-	}
-
-	protected function emit($sql, $step, $max) {
-		if ($this->noEmit) {
-			return;
-		}
-		if (is_null($this->dispatcher)) {
-			return;
-		}
-		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step + 1, $max]));
-	}
-
-	private function emitCheckStep($tableName, $step, $max) {
-		if (is_null($this->dispatcher)) {
-			return;
-		}
-		$this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step + 1, $max]));
-	}
+    /** @var \Doctrine\DBAL\Connection */
+    protected $connection;
+
+    /** @var ISecureRandom */
+    private $random;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var EventDispatcherInterface  */
+    private $dispatcher;
+
+    /** @var bool */
+    private $noEmit = false;
+
+    /**
+     * @param \Doctrine\DBAL\Connection $connection
+     * @param ISecureRandom $random
+     * @param IConfig $config
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(\Doctrine\DBAL\Connection $connection,
+                                ISecureRandom $random,
+                                IConfig $config,
+                                EventDispatcherInterface $dispatcher = null) {
+        $this->connection = $connection;
+        $this->random = $random;
+        $this->config = $config;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     */
+    public function migrate(Schema $targetSchema) {
+        $this->noEmit = true;
+        $this->applySchema($targetSchema);
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     * @return string
+     */
+    public function generateChangeScript(Schema $targetSchema) {
+        $schemaDiff = $this->getDiff($targetSchema, $this->connection);
+
+        $script = '';
+        $sqls = $schemaDiff->toSql($this->connection->getDatabasePlatform());
+        foreach ($sqls as $sql) {
+            $script .= $this->convertStatementToScript($sql);
+        }
+
+        return $script;
+    }
+
+    /**
+     * Create a unique name for the temporary table
+     *
+     * @param string $name
+     * @return string
+     */
+    protected function generateTemporaryTableName($name) {
+        return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
+    }
+
+    /**
+     * Check the migration of a table on a copy so we can detect errors before messing with the real table
+     *
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @throws \OC\DB\MigrationException
+     */
+    protected function checkTableMigrate(Table $table) {
+        $name = $table->getName();
+        $tmpName = $this->generateTemporaryTableName($name);
+
+        $this->copyTable($name, $tmpName);
+
+        //create the migration schema for the temporary table
+        $tmpTable = $this->renameTableSchema($table, $tmpName);
+        $schemaConfig = new SchemaConfig();
+        $schemaConfig->setName($this->connection->getDatabase());
+        $schema = new Schema([$tmpTable], [], $schemaConfig);
+
+        try {
+            $this->applySchema($schema);
+            $this->dropTable($tmpName);
+        } catch (Exception $e) {
+            // pgsql needs to commit it's failed transaction before doing anything else
+            if ($this->connection->isTransactionActive()) {
+                $this->connection->commit();
+            }
+            $this->dropTable($tmpName);
+            throw new MigrationException($table->getName(), $e->getMessage());
+        }
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @param string $newName
+     * @return \Doctrine\DBAL\Schema\Table
+     */
+    protected function renameTableSchema(Table $table, $newName) {
+        /**
+         * @var \Doctrine\DBAL\Schema\Index[] $indexes
+         */
+        $indexes = $table->getIndexes();
+        $newIndexes = [];
+        foreach ($indexes as $index) {
+            if ($index->isPrimary()) {
+                // do not rename primary key
+                $indexName = $index->getName();
+            } else {
+                // avoid conflicts in index names
+                $indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
+            }
+            $newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
+        }
+
+        // foreign keys are not supported so we just set it to an empty array
+        return new Table($newName, $table->getColumns(), $newIndexes, [], [], $table->getOptions());
+    }
+
+    public function createSchema() {
+        $this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+            /** @var string|AbstractAsset $asset */
+            $filterExpression = $this->getFilterExpression();
+            if ($asset instanceof AbstractAsset) {
+                return preg_match($filterExpression, $asset->getName()) !== false;
+            }
+            return preg_match($filterExpression, $asset) !== false;
+        });
+        return $this->connection->getSchemaManager()->createSchema();
+    }
+
+    /**
+     * @param Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     * @return \Doctrine\DBAL\Schema\SchemaDiff
+     */
+    protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
+        // adjust varchar columns with a length higher then getVarcharMaxLength to clob
+        foreach ($targetSchema->getTables() as $table) {
+            foreach ($table->getColumns() as $column) {
+                if ($column->getType() instanceof StringType) {
+                    if ($column->getLength() > $connection->getDatabasePlatform()->getVarcharMaxLength()) {
+                        $column->setType(Type::getType('text'));
+                        $column->setLength(null);
+                    }
+                }
+            }
+        }
+
+        $this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+            /** @var string|AbstractAsset $asset */
+            $filterExpression = $this->getFilterExpression();
+            if ($asset instanceof AbstractAsset) {
+                return preg_match($filterExpression, $asset->getName()) !== false;
+            }
+            return preg_match($filterExpression, $asset) !== false;
+        });
+        $sourceSchema = $connection->getSchemaManager()->createSchema();
+
+        // remove tables we don't know about
+        foreach ($sourceSchema->getTables() as $table) {
+            if (!$targetSchema->hasTable($table->getName())) {
+                $sourceSchema->dropTable($table->getName());
+            }
+        }
+        // remove sequences we don't know about
+        foreach ($sourceSchema->getSequences() as $table) {
+            if (!$targetSchema->hasSequence($table->getName())) {
+                $sourceSchema->dropSequence($table->getName());
+            }
+        }
+
+        $comparator = new Comparator();
+        return $comparator->compare($sourceSchema, $targetSchema);
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     */
+    protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
+        if (is_null($connection)) {
+            $connection = $this->connection;
+        }
+
+        $schemaDiff = $this->getDiff($targetSchema, $connection);
+
+        $connection->beginTransaction();
+        $sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
+        $step = 0;
+        foreach ($sqls as $sql) {
+            $this->emit($sql, $step++, count($sqls));
+            $connection->query($sql);
+        }
+        $connection->commit();
+    }
+
+    /**
+     * @param string $sourceName
+     * @param string $targetName
+     */
+    protected function copyTable($sourceName, $targetName) {
+        $quotedSource = $this->connection->quoteIdentifier($sourceName);
+        $quotedTarget = $this->connection->quoteIdentifier($targetName);
+
+        $this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
+        $this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
+    }
+
+    /**
+     * @param string $name
+     */
+    protected function dropTable($name) {
+        $this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
+    }
+
+    /**
+     * @param $statement
+     * @return string
+     */
+    protected function convertStatementToScript($statement) {
+        $script = $statement . ';';
+        $script .= PHP_EOL;
+        $script .= PHP_EOL;
+        return $script;
+    }
+
+    protected function getFilterExpression() {
+        return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+    }
+
+    protected function emit($sql, $step, $max) {
+        if ($this->noEmit) {
+            return;
+        }
+        if (is_null($this->dispatcher)) {
+            return;
+        }
+        $this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step + 1, $max]));
+    }
+
+    private function emitCheckStep($tableName, $step, $max) {
+        if (is_null($this->dispatcher)) {
+            return;
+        }
+        $this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step + 1, $max]));
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -110,7 +110,7 @@ 
 	 * @return string
 	 */
 	protected function generateTemporaryTableName($name) {
-		return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
+		return $this->config->getSystemValue('dbtableprefix', 'oc_').$name.'_'.$this->random->generate(13, ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_DIGITS);
 	}
 
 	/**
@@ -161,7 +161,7 @@ 
 				$indexName = $index->getName();
 			} else {
 				// avoid conflicts in index names
-				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
+				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_').$this->random->generate(13, ISecureRandom::CHAR_LOWER);
 			}
 			$newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
 		}
@@ -171,7 +171,7 @@ 
 	}
 
 	public function createSchema() {
-		$this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+		$this->connection->getConfiguration()->setSchemaAssetsFilter(function($asset) {
 			/** @var string|AbstractAsset $asset */
 			$filterExpression = $this->getFilterExpression();
 			if ($asset instanceof AbstractAsset) {
@@ -200,7 +200,7 @@ 
 			}
 		}
 
-		$this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+		$this->connection->getConfiguration()->setSchemaAssetsFilter(function($asset) {
 			/** @var string|AbstractAsset $asset */
 			$filterExpression = $this->getFilterExpression();
 			if ($asset instanceof AbstractAsset) {
@@ -256,15 +256,15 @@ 
 		$quotedSource = $this->connection->quoteIdentifier($sourceName);
 		$quotedTarget = $this->connection->quoteIdentifier($targetName);
 
-		$this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
-		$this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
+		$this->connection->exec('CREATE TABLE '.$quotedTarget.' (LIKE '.$quotedSource.')');
+		$this->connection->exec('INSERT INTO '.$quotedTarget.' SELECT * FROM '.$quotedSource);
 	}
 
 	/**
 	 * @param string $name
 	 */
 	protected function dropTable($name) {
-		$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
+		$this->connection->exec('DROP TABLE '.$this->connection->quoteIdentifier($name));
 	}
 
 	/**
@@ -272,14 +272,14 @@ 
 	 * @return string
 	 */
 	protected function convertStatementToScript($statement) {
-		$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_')).'/';
 	}
 
 	protected function emit($sql, $step, $max) {

lib/private/DB/MDB2SchemaReader.php

Indentation +300 added lines, -300 removed lines

@@ -36,320 +36,320 @@
 
 class MDB2SchemaReader {
 
-	/**
-	 * @var string $DBTABLEPREFIX
-	 */
-	protected $DBTABLEPREFIX;
+    /**
+     * @var string $DBTABLEPREFIX
+     */
+    protected $DBTABLEPREFIX;
 
-	/**
-	 * @var \Doctrine\DBAL\Platforms\AbstractPlatform $platform
-	 */
-	protected $platform;
+    /**
+     * @var \Doctrine\DBAL\Platforms\AbstractPlatform $platform
+     */
+    protected $platform;
 
-	/** @var IConfig */
-	protected $config;
+    /** @var IConfig */
+    protected $config;
 
-	/**
-	 * @param \OCP\IConfig $config
-	 * @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform
-	 */
-	public function __construct(IConfig $config, AbstractPlatform $platform) {
-		$this->platform = $platform;
-		$this->config = $config;
-		$this->DBTABLEPREFIX = $config->getSystemValue('dbtableprefix', 'oc_');
-	}
+    /**
+     * @param \OCP\IConfig $config
+     * @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform
+     */
+    public function __construct(IConfig $config, AbstractPlatform $platform) {
+        $this->platform = $platform;
+        $this->config = $config;
+        $this->DBTABLEPREFIX = $config->getSystemValue('dbtableprefix', 'oc_');
+    }
 
-	/**
-	 * @param string $file
-	 * @param Schema $schema
-	 * @return Schema
-	 * @throws \DomainException
-	 */
-	public function loadSchemaFromFile($file, Schema $schema) {
-		$loadEntities = libxml_disable_entity_loader(false);
-		$xml = simplexml_load_file($file);
-		libxml_disable_entity_loader($loadEntities);
-		foreach ($xml->children() as $child) {
-			/**
-			 * @var \SimpleXMLElement $child
-			 */
-			switch ($child->getName()) {
-				case 'name':
-				case 'create':
-				case 'overwrite':
-				case 'charset':
-					break;
-				case 'table':
-					$this->loadTable($schema, $child);
-					break;
-				default:
-					throw new \DomainException('Unknown element: ' . $child->getName());
+    /**
+     * @param string $file
+     * @param Schema $schema
+     * @return Schema
+     * @throws \DomainException
+     */
+    public function loadSchemaFromFile($file, Schema $schema) {
+        $loadEntities = libxml_disable_entity_loader(false);
+        $xml = simplexml_load_file($file);
+        libxml_disable_entity_loader($loadEntities);
+        foreach ($xml->children() as $child) {
+            /**
+             * @var \SimpleXMLElement $child
+             */
+            switch ($child->getName()) {
+                case 'name':
+                case 'create':
+                case 'overwrite':
+                case 'charset':
+                    break;
+                case 'table':
+                    $this->loadTable($schema, $child);
+                    break;
+                default:
+                    throw new \DomainException('Unknown element: ' . $child->getName());
 
-			}
-		}
-		return $schema;
-	}
+            }
+        }
+        return $schema;
+    }
 
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $schema
-	 * @param \SimpleXMLElement $xml
-	 * @throws \DomainException
-	 */
-	private function loadTable($schema, $xml) {
-		$table = null;
-		foreach ($xml->children() as $child) {
-			/**
-			 * @var \SimpleXMLElement $child
-			 */
-			switch ($child->getName()) {
-				case 'name':
-					$name = (string)$child;
-					$name = str_replace('*dbprefix*', $this->DBTABLEPREFIX, $name);
-					$name = $this->platform->quoteIdentifier($name);
-					$table = $schema->createTable($name);
-					break;
-				case 'create':
-				case 'overwrite':
-				case 'charset':
-					break;
-				case 'declaration':
-					if (is_null($table)) {
-						throw new \DomainException('Table declaration before table name');
-					}
-					$this->loadDeclaration($table, $child);
-					break;
-				default:
-					throw new \DomainException('Unknown element: ' . $child->getName());
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $schema
+     * @param \SimpleXMLElement $xml
+     * @throws \DomainException
+     */
+    private function loadTable($schema, $xml) {
+        $table = null;
+        foreach ($xml->children() as $child) {
+            /**
+             * @var \SimpleXMLElement $child
+             */
+            switch ($child->getName()) {
+                case 'name':
+                    $name = (string)$child;
+                    $name = str_replace('*dbprefix*', $this->DBTABLEPREFIX, $name);
+                    $name = $this->platform->quoteIdentifier($name);
+                    $table = $schema->createTable($name);
+                    break;
+                case 'create':
+                case 'overwrite':
+                case 'charset':
+                    break;
+                case 'declaration':
+                    if (is_null($table)) {
+                        throw new \DomainException('Table declaration before table name');
+                    }
+                    $this->loadDeclaration($table, $child);
+                    break;
+                default:
+                    throw new \DomainException('Unknown element: ' . $child->getName());
 
-			}
-		}
-	}
+            }
+        }
+    }
 
-	/**
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @param \SimpleXMLElement $xml
-	 * @throws \DomainException
-	 */
-	private function loadDeclaration($table, $xml) {
-		foreach ($xml->children() as $child) {
-			/**
-			 * @var \SimpleXMLElement $child
-			 */
-			switch ($child->getName()) {
-				case 'field':
-					$this->loadField($table, $child);
-					break;
-				case 'index':
-					$this->loadIndex($table, $child);
-					break;
-				default:
-					throw new \DomainException('Unknown element: ' . $child->getName());
+    /**
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @param \SimpleXMLElement $xml
+     * @throws \DomainException
+     */
+    private function loadDeclaration($table, $xml) {
+        foreach ($xml->children() as $child) {
+            /**
+             * @var \SimpleXMLElement $child
+             */
+            switch ($child->getName()) {
+                case 'field':
+                    $this->loadField($table, $child);
+                    break;
+                case 'index':
+                    $this->loadIndex($table, $child);
+                    break;
+                default:
+                    throw new \DomainException('Unknown element: ' . $child->getName());
 
-			}
-		}
-	}
+            }
+        }
+    }
 
-	/**
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @param \SimpleXMLElement $xml
-	 * @throws \DomainException
-	 */
-	private function loadField($table, $xml) {
-		$options = [ 'notnull' => false ];
-		foreach ($xml->children() as $child) {
-			/**
-			 * @var \SimpleXMLElement $child
-			 */
-			switch ($child->getName()) {
-				case 'name':
-					$name = (string)$child;
-					$name = $this->platform->quoteIdentifier($name);
-					break;
-				case 'type':
-					$type = (string)$child;
-					switch ($type) {
-						case 'text':
-							$type = 'string';
-							break;
-						case 'clob':
-							$type = 'text';
-							break;
-						case 'timestamp':
-							$type = 'datetime';
-							break;
-						case 'numeric':
-							$type = 'decimal';
-							break;
-					}
-					break;
-				case 'length':
-					$length = (string)$child;
-					$options['length'] = $length;
-					break;
-				case 'unsigned':
-					$unsigned = $this->asBool($child);
-					$options['unsigned'] = $unsigned;
-					break;
-				case 'notnull':
-					$notnull = $this->asBool($child);
-					$options['notnull'] = $notnull;
-					break;
-				case 'autoincrement':
-					$autoincrement = $this->asBool($child);
-					$options['autoincrement'] = $autoincrement;
-					break;
-				case 'default':
-					$default = (string)$child;
-					$options['default'] = $default;
-					break;
-				case 'comments':
-					$comment = (string)$child;
-					$options['comment'] = $comment;
-					break;
-				case 'primary':
-					$primary = $this->asBool($child);
-					$options['primary'] = $primary;
-					break;
-				case 'precision':
-					$precision = (string)$child;
-					$options['precision'] = $precision;
-					break;
-				case 'scale':
-					$scale = (string)$child;
-					$options['scale'] = $scale;
-					break;
-				default:
-					throw new \DomainException('Unknown element: ' . $child->getName());
+    /**
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @param \SimpleXMLElement $xml
+     * @throws \DomainException
+     */
+    private function loadField($table, $xml) {
+        $options = [ 'notnull' => false ];
+        foreach ($xml->children() as $child) {
+            /**
+             * @var \SimpleXMLElement $child
+             */
+            switch ($child->getName()) {
+                case 'name':
+                    $name = (string)$child;
+                    $name = $this->platform->quoteIdentifier($name);
+                    break;
+                case 'type':
+                    $type = (string)$child;
+                    switch ($type) {
+                        case 'text':
+                            $type = 'string';
+                            break;
+                        case 'clob':
+                            $type = 'text';
+                            break;
+                        case 'timestamp':
+                            $type = 'datetime';
+                            break;
+                        case 'numeric':
+                            $type = 'decimal';
+                            break;
+                    }
+                    break;
+                case 'length':
+                    $length = (string)$child;
+                    $options['length'] = $length;
+                    break;
+                case 'unsigned':
+                    $unsigned = $this->asBool($child);
+                    $options['unsigned'] = $unsigned;
+                    break;
+                case 'notnull':
+                    $notnull = $this->asBool($child);
+                    $options['notnull'] = $notnull;
+                    break;
+                case 'autoincrement':
+                    $autoincrement = $this->asBool($child);
+                    $options['autoincrement'] = $autoincrement;
+                    break;
+                case 'default':
+                    $default = (string)$child;
+                    $options['default'] = $default;
+                    break;
+                case 'comments':
+                    $comment = (string)$child;
+                    $options['comment'] = $comment;
+                    break;
+                case 'primary':
+                    $primary = $this->asBool($child);
+                    $options['primary'] = $primary;
+                    break;
+                case 'precision':
+                    $precision = (string)$child;
+                    $options['precision'] = $precision;
+                    break;
+                case 'scale':
+                    $scale = (string)$child;
+                    $options['scale'] = $scale;
+                    break;
+                default:
+                    throw new \DomainException('Unknown element: ' . $child->getName());
 
-			}
-		}
-		if (isset($name) && isset($type)) {
-			if (isset($options['default']) && empty($options['default'])) {
-				if (empty($options['notnull']) || !$options['notnull']) {
-					unset($options['default']);
-					$options['notnull'] = false;
-				} else {
-					$options['default'] = '';
-				}
-				if ($type == 'integer' || $type == 'decimal') {
-					$options['default'] = 0;
-				} elseif ($type == 'boolean') {
-					$options['default'] = false;
-				}
-				if (!empty($options['autoincrement']) && $options['autoincrement']) {
-					unset($options['default']);
-				}
-			}
-			if ($type === 'integer' && isset($options['default'])) {
-				$options['default'] = (int)$options['default'];
-			}
-			if ($type === 'integer' && isset($options['length'])) {
-				$length = $options['length'];
-				if ($length < 4) {
-					$type = 'smallint';
-				} elseif ($length > 4) {
-					$type = 'bigint';
-				}
-			}
-			if ($type === 'boolean' && isset($options['default'])) {
-				$options['default'] = $this->asBool($options['default']);
-			}
-			if (!empty($options['autoincrement'])
-				&& !empty($options['notnull'])
-			) {
-				$options['primary'] = true;
-			}
+            }
+        }
+        if (isset($name) && isset($type)) {
+            if (isset($options['default']) && empty($options['default'])) {
+                if (empty($options['notnull']) || !$options['notnull']) {
+                    unset($options['default']);
+                    $options['notnull'] = false;
+                } else {
+                    $options['default'] = '';
+                }
+                if ($type == 'integer' || $type == 'decimal') {
+                    $options['default'] = 0;
+                } elseif ($type == 'boolean') {
+                    $options['default'] = false;
+                }
+                if (!empty($options['autoincrement']) && $options['autoincrement']) {
+                    unset($options['default']);
+                }
+            }
+            if ($type === 'integer' && isset($options['default'])) {
+                $options['default'] = (int)$options['default'];
+            }
+            if ($type === 'integer' && isset($options['length'])) {
+                $length = $options['length'];
+                if ($length < 4) {
+                    $type = 'smallint';
+                } elseif ($length > 4) {
+                    $type = 'bigint';
+                }
+            }
+            if ($type === 'boolean' && isset($options['default'])) {
+                $options['default'] = $this->asBool($options['default']);
+            }
+            if (!empty($options['autoincrement'])
+                && !empty($options['notnull'])
+            ) {
+                $options['primary'] = true;
+            }
 
-			# not used anymore in the options argument
-			# see https://github.com/doctrine/dbal/commit/138eb85234a1faeaa2e6a32cd7bcc66bb51c64e8#diff-300f55366adb50a32a40882ebdc95c163b141f64cba5f45f20bda04a907b3eb3L82
-			# therefore it's read before and then unset right before the addColumn call
-			$setPrimaryKey = false;
-			if (!empty($options['primary']) && $options['primary']) {
-				$setPrimaryKey = true;
-			}
-			unset($options['primary']);
-			$table->addColumn($name, $type, $options);
-			if ($setPrimaryKey) {
-				$table->setPrimaryKey([$name]);
-			}
-		}
-	}
+            # not used anymore in the options argument
+            # see https://github.com/doctrine/dbal/commit/138eb85234a1faeaa2e6a32cd7bcc66bb51c64e8#diff-300f55366adb50a32a40882ebdc95c163b141f64cba5f45f20bda04a907b3eb3L82
+            # therefore it's read before and then unset right before the addColumn call
+            $setPrimaryKey = false;
+            if (!empty($options['primary']) && $options['primary']) {
+                $setPrimaryKey = true;
+            }
+            unset($options['primary']);
+            $table->addColumn($name, $type, $options);
+            if ($setPrimaryKey) {
+                $table->setPrimaryKey([$name]);
+            }
+        }
+    }
 
-	/**
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @param \SimpleXMLElement $xml
-	 * @throws \DomainException
-	 */
-	private function loadIndex($table, $xml) {
-		$name = null;
-		$fields = [];
-		foreach ($xml->children() as $child) {
-			/**
-			 * @var \SimpleXMLElement $child
-			 */
-			switch ($child->getName()) {
-				case 'name':
-					$name = (string)$child;
-					break;
-				case 'primary':
-					$primary = $this->asBool($child);
-					break;
-				case 'unique':
-					$unique = $this->asBool($child);
-					break;
-				case 'field':
-					foreach ($child->children() as $field) {
-						/**
-						 * @var \SimpleXMLElement $field
-						 */
-						switch ($field->getName()) {
-							case 'name':
-								$field_name = (string)$field;
-								$field_name = $this->platform->quoteIdentifier($field_name);
-								$fields[] = $field_name;
-								break;
-							case 'sorting':
-								break;
-							default:
-								throw new \DomainException('Unknown element: ' . $field->getName());
+    /**
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @param \SimpleXMLElement $xml
+     * @throws \DomainException
+     */
+    private function loadIndex($table, $xml) {
+        $name = null;
+        $fields = [];
+        foreach ($xml->children() as $child) {
+            /**
+             * @var \SimpleXMLElement $child
+             */
+            switch ($child->getName()) {
+                case 'name':
+                    $name = (string)$child;
+                    break;
+                case 'primary':
+                    $primary = $this->asBool($child);
+                    break;
+                case 'unique':
+                    $unique = $this->asBool($child);
+                    break;
+                case 'field':
+                    foreach ($child->children() as $field) {
+                        /**
+                         * @var \SimpleXMLElement $field
+                         */
+                        switch ($field->getName()) {
+                            case 'name':
+                                $field_name = (string)$field;
+                                $field_name = $this->platform->quoteIdentifier($field_name);
+                                $fields[] = $field_name;
+                                break;
+                            case 'sorting':
+                                break;
+                            default:
+                                throw new \DomainException('Unknown element: ' . $field->getName());
 
-						}
-					}
-					break;
-				default:
-					throw new \DomainException('Unknown element: ' . $child->getName());
+                        }
+                    }
+                    break;
+                default:
+                    throw new \DomainException('Unknown element: ' . $child->getName());
 
-			}
-		}
-		if (!empty($fields)) {
-			if (isset($primary) && $primary) {
-				if ($table->hasPrimaryKey()) {
-					return;
-				}
-				$table->setPrimaryKey($fields, $name);
-			} else {
-				if (isset($unique) && $unique) {
-					$table->addUniqueIndex($fields, $name);
-				} else {
-					$table->addIndex($fields, $name);
-				}
-			}
-		} else {
-			throw new \DomainException('Empty index definition: ' . $name . ' options:' . print_r($fields, true));
-		}
-	}
+            }
+        }
+        if (!empty($fields)) {
+            if (isset($primary) && $primary) {
+                if ($table->hasPrimaryKey()) {
+                    return;
+                }
+                $table->setPrimaryKey($fields, $name);
+            } else {
+                if (isset($unique) && $unique) {
+                    $table->addUniqueIndex($fields, $name);
+                } else {
+                    $table->addIndex($fields, $name);
+                }
+            }
+        } else {
+            throw new \DomainException('Empty index definition: ' . $name . ' options:' . print_r($fields, true));
+        }
+    }
 
-	/**
-	 * @param \SimpleXMLElement|string $xml
-	 * @return bool
-	 */
-	private function asBool($xml) {
-		$result = (string)$xml;
-		if ($result == 'true') {
-			$result = true;
-		} elseif ($result == 'false') {
-			$result = false;
-		}
-		return (bool)$result;
-	}
+    /**
+     * @param \SimpleXMLElement|string $xml
+     * @return bool
+     */
+    private function asBool($xml) {
+        $result = (string)$xml;
+        if ($result == 'true') {
+            $result = true;
+        } elseif ($result == 'false') {
+            $result = false;
+        }
+        return (bool)$result;
+    }
 }

lib/private/DB/SchemaWrapper.php

Indentation +101 added lines, -101 removed lines

@@ -29,105 +29,105 @@
 
 class SchemaWrapper implements ISchemaWrapper {
 
-	/** @var Connection */
-	protected $connection;
-
-	/** @var Schema */
-	protected $schema;
-
-	/** @var array */
-	protected $tablesToDelete = [];
-
-	public function __construct(Connection $connection) {
-		$this->connection = $connection;
-		$this->schema = $this->connection->createSchema();
-	}
-
-	public function getWrappedSchema() {
-		return $this->schema;
-	}
-
-	public function performDropTableCalls() {
-		foreach ($this->tablesToDelete as $tableName => $true) {
-			$this->connection->dropTable($tableName);
-			unset($this->tablesToDelete[$tableName]);
-		}
-	}
-
-	/**
-	 * Gets all table names
-	 *
-	 * @return array
-	 */
-	public function getTableNamesWithoutPrefix() {
-		$tableNames = $this->schema->getTableNames();
-		return array_map(function ($tableName) {
-			if (strpos($tableName, $this->connection->getPrefix()) === 0) {
-				return substr($tableName, strlen($this->connection->getPrefix()));
-			}
-
-			return $tableName;
-		}, $tableNames);
-	}
-
-	// Overwritten methods
-
-	/**
-	 * @return array
-	 */
-	public function getTableNames() {
-		return $this->schema->getTableNames();
-	}
-
-	/**
-	 * @param string $tableName
-	 *
-	 * @return \Doctrine\DBAL\Schema\Table
-	 * @throws \Doctrine\DBAL\Schema\SchemaException
-	 */
-	public function getTable($tableName) {
-		return $this->schema->getTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Does this schema have a table with the given name?
-	 *
-	 * @param string $tableName
-	 *
-	 * @return boolean
-	 */
-	public function hasTable($tableName) {
-		return $this->schema->hasTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Creates a new table.
-	 *
-	 * @param string $tableName
-	 * @return \Doctrine\DBAL\Schema\Table
-	 */
-	public function createTable($tableName) {
-		unset($this->tablesToDelete[$tableName]);
-		return $this->schema->createTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Drops a table from the schema.
-	 *
-	 * @param string $tableName
-	 * @return \Doctrine\DBAL\Schema\Schema
-	 */
-	public function dropTable($tableName) {
-		$this->tablesToDelete[$tableName] = true;
-		return $this->schema->dropTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Gets all tables of this schema.
-	 *
-	 * @return \Doctrine\DBAL\Schema\Table[]
-	 */
-	public function getTables() {
-		return $this->schema->getTables();
-	}
+    /** @var Connection */
+    protected $connection;
+
+    /** @var Schema */
+    protected $schema;
+
+    /** @var array */
+    protected $tablesToDelete = [];
+
+    public function __construct(Connection $connection) {
+        $this->connection = $connection;
+        $this->schema = $this->connection->createSchema();
+    }
+
+    public function getWrappedSchema() {
+        return $this->schema;
+    }
+
+    public function performDropTableCalls() {
+        foreach ($this->tablesToDelete as $tableName => $true) {
+            $this->connection->dropTable($tableName);
+            unset($this->tablesToDelete[$tableName]);
+        }
+    }
+
+    /**
+     * Gets all table names
+     *
+     * @return array
+     */
+    public function getTableNamesWithoutPrefix() {
+        $tableNames = $this->schema->getTableNames();
+        return array_map(function ($tableName) {
+            if (strpos($tableName, $this->connection->getPrefix()) === 0) {
+                return substr($tableName, strlen($this->connection->getPrefix()));
+            }
+
+            return $tableName;
+        }, $tableNames);
+    }
+
+    // Overwritten methods
+
+    /**
+     * @return array
+     */
+    public function getTableNames() {
+        return $this->schema->getTableNames();
+    }
+
+    /**
+     * @param string $tableName
+     *
+     * @return \Doctrine\DBAL\Schema\Table
+     * @throws \Doctrine\DBAL\Schema\SchemaException
+     */
+    public function getTable($tableName) {
+        return $this->schema->getTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Does this schema have a table with the given name?
+     *
+     * @param string $tableName
+     *
+     * @return boolean
+     */
+    public function hasTable($tableName) {
+        return $this->schema->hasTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Creates a new table.
+     *
+     * @param string $tableName
+     * @return \Doctrine\DBAL\Schema\Table
+     */
+    public function createTable($tableName) {
+        unset($this->tablesToDelete[$tableName]);
+        return $this->schema->createTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Drops a table from the schema.
+     *
+     * @param string $tableName
+     * @return \Doctrine\DBAL\Schema\Schema
+     */
+    public function dropTable($tableName) {
+        $this->tablesToDelete[$tableName] = true;
+        return $this->schema->dropTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Gets all tables of this schema.
+     *
+     * @return \Doctrine\DBAL\Schema\Table[]
+     */
+    public function getTables() {
+        return $this->schema->getTables();
+    }
 }

lib/private/DB/AdapterSqlite.php

Indentation +61 added lines, -61 removed lines

@@ -31,70 +31,70 @@
 
 class AdapterSqlite extends Adapter {
 
-	/**
-	 * @param string $tableName
-	 */
-	public function lockTable($tableName) {
-		$this->conn->executeUpdate('BEGIN EXCLUSIVE TRANSACTION');
-	}
+    /**
+     * @param string $tableName
+     */
+    public function lockTable($tableName) {
+        $this->conn->executeUpdate('BEGIN EXCLUSIVE TRANSACTION');
+    }
 
-	public function unlockTable() {
-		$this->conn->executeUpdate('COMMIT TRANSACTION');
-	}
+    public function unlockTable() {
+        $this->conn->executeUpdate('COMMIT TRANSACTION');
+    }
 
-	public function fixupStatement($statement) {
-		$statement = preg_replace('/`(\w+)` ILIKE \?/', 'LOWER($1) LIKE LOWER(?)', $statement);
-		$statement = str_replace('`', '"', $statement);
-		$statement = str_ireplace('NOW()', 'datetime(\'now\')', $statement);
-		$statement = str_ireplace('GREATEST(', 'MAX(', $statement);
-		$statement = str_ireplace('UNIX_TIMESTAMP()', 'strftime(\'%s\',\'now\')', $statement);
-		return $statement;
-	}
+    public function fixupStatement($statement) {
+        $statement = preg_replace('/`(\w+)` ILIKE \?/', 'LOWER($1) LIKE LOWER(?)', $statement);
+        $statement = str_replace('`', '"', $statement);
+        $statement = str_ireplace('NOW()', 'datetime(\'now\')', $statement);
+        $statement = str_ireplace('GREATEST(', 'MAX(', $statement);
+        $statement = str_ireplace('UNIX_TIMESTAMP()', 'strftime(\'%s\',\'now\')', $statement);
+        return $statement;
+    }
 
-	/**
-	 * 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\Exception
-	 * @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) {
-		if (empty($compare)) {
-			$compare = array_keys($input);
-		}
-		$fieldList = '`' . implode('`,`', array_keys($input)) . '`';
-		$query = "INSERT INTO `$table` ($fieldList) SELECT "
-			. str_repeat('?,', count($input) - 1).'? '
-			. " WHERE NOT EXISTS (SELECT 1 FROM `$table` WHERE ";
+    /**
+     * 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\Exception
+     * @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) {
+        if (empty($compare)) {
+            $compare = array_keys($input);
+        }
+        $fieldList = '`' . implode('`,`', array_keys($input)) . '`';
+        $query = "INSERT INTO `$table` ($fieldList) SELECT "
+            . str_repeat('?,', count($input) - 1).'? '
+            . " WHERE NOT EXISTS (SELECT 1 FROM `$table` WHERE ";
 
-		$inserts = array_values($input);
-		foreach ($compare as $key) {
-			$query .= '`' . $key . '`';
-			if (is_null($input[$key])) {
-				$query .= ' IS NULL AND ';
-			} else {
-				$inserts[] = $input[$key];
-				$query .= ' = ? AND ';
-			}
-		}
-		$query = substr($query, 0, -5);
-		$query .= ')';
+        $inserts = array_values($input);
+        foreach ($compare as $key) {
+            $query .= '`' . $key . '`';
+            if (is_null($input[$key])) {
+                $query .= ' IS NULL AND ';
+            } else {
+                $inserts[] = $input[$key];
+                $query .= ' = ? AND ';
+            }
+        }
+        $query = substr($query, 0, -5);
+        $query .= ')';
 
-		try {
-			return $this->conn->executeUpdate($query, $inserts);
-		} catch (UniqueConstraintViolationException $e) {
-			// if this is thrown then a concurrent insert happened between the insert and the sub-select in the insert, that should have avoided it
-			// it's fine to ignore this then
-			//
-			// more discussions about this can be found at https://github.com/nextcloud/server/pull/12315
-			return 0;
-		}
-	}
+        try {
+            return $this->conn->executeUpdate($query, $inserts);
+        } catch (UniqueConstraintViolationException $e) {
+            // if this is thrown then a concurrent insert happened between the insert and the sub-select in the insert, that should have avoided it
+            // it's fine to ignore this then
+            //
+            // more discussions about this can be found at https://github.com/nextcloud/server/pull/12315
+            return 0;
+        }
+    }
 }

lib/private/Updater.php

Indentation +528 added lines, -528 removed lines

@@ -58,532 +58,532 @@
  */
 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]) ||
-			isset($allowedPreviousVersions['owncloud'][$majorMinor])
-		)) {
-			$currentVendor = 'owncloud';
-			$this->config->setAppValue('core', 'vendor', $currentVendor);
-		}
-
-		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->get(Connection::class));
-		$ms->migrate();
-
-		$this->emit('\OC\Updater', 'dbUpgrade');
-	}
-
-	/**
-	 * 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 Nextcloud
-			$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]) ||
+            isset($allowedPreviousVersions['owncloud'][$majorMinor])
+        )) {
+            $currentVendor = 'owncloud';
+            $this->config->setAppValue('core', 'vendor', $currentVendor);
+        }
+
+        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->get(Connection::class));
+        $ms->migrate();
+
+        $this->emit('\OC\Updater', 'dbUpgrade');
+    }
+
+    /**
+     * 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 Nextcloud
+            $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']);
+        });
+    }
 }

lib/private/Tags.php

Indentation +784 added lines, -784 removed lines

@@ -51,788 +51,788 @@
 
 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;
-
-	public const TAG_TABLE = '*PREFIX*vcategory';
-	public 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.
-	 *
-	 * since 20.0.0 $includeShared isn't used anymore
-	 */
-	public function __construct(TagMapper $mapper, $user, $type, $defaultTags = []) {
-		$this->mapper = $mapper;
-		$this->user = $user;
-		$this->type = $type;
-		$this->owners = [$this->user];
-		$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'];
-				}
-			}
-		} 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) {
-				$stmt->closeCursor();
-				\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()) {
-				$ids[] = (int)$row['objid'];
-			}
-			$result->closeCursor();
-		}
-
-		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',
-						]);
-					}
-				}
-				$result->closeCursor();
-			} 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;
+
+    public const TAG_TABLE = '*PREFIX*vcategory';
+    public 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.
+     *
+     * since 20.0.0 $includeShared isn't used anymore
+     */
+    public function __construct(TagMapper $mapper, $user, $type, $defaultTags = []) {
+        $this->mapper = $mapper;
+        $this->user = $user;
+        $this->type = $type;
+        $this->owners = [$this->user];
+        $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'];
+                }
+            }
+        } 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) {
+                $stmt->closeCursor();
+                \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()) {
+                $ids[] = (int)$row['objid'];
+            }
+            $result->closeCursor();
+        }
+
+        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',
+                        ]);
+                    }
+                }
+                $result->closeCursor();
+            } 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 +28 added lines, -28 removed lines

@@ -174,7 +174,7 @@ 
 			return [];
 		}
 
-		usort($this->tags, function ($a, $b) {
+		usort($this->tags, function($a, $b) {
 			return strnatcasecmp($a->getName(), $b->getName());
 		});
 		$tagMap = [];
@@ -196,7 +196,7 @@ 
 	 */
 	public function getTagsForUser($user) {
 		return array_filter($this->tags,
-			function ($tag) use ($user) {
+			function($tag) use ($user) {
 				return $tag->getOwner() === $user;
 			}
 		);
@@ -217,14 +217,14 @@ 
 			$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] = [];
 					}
@@ -274,7 +274,7 @@ 
 		}
 
 		$ids = [];
-		$sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
+		$sql = 'SELECT `objid` FROM `'.self::RELATION_TABLE
 			. '` WHERE `categoryid` = ?';
 
 		try {
@@ -282,7 +282,7 @@ 
 			$result = $stmt->execute([$tagId]);
 			if ($result === null) {
 				$stmt->closeCursor();
-				\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) {
@@ -296,7 +296,7 @@ 
 
 		if (!is_null($result)) {
 			while ($row = $result->fetchRow()) {
-				$ids[] = (int)$row['objid'];
+				$ids[] = (int) $row['objid'];
 			}
 			$result->closeCursor();
 		}
@@ -341,7 +341,7 @@ 
 			return false;
 		}
 		if ($this->userHasTag($name, $this->user)) {
-			\OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', ILogger::DEBUG);
+			\OCP\Util::writeLog('core', __METHOD__.', name: '.$name.' exists already', ILogger::DEBUG);
 			return false;
 		}
 		try {
@@ -356,7 +356,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();
 	}
 
@@ -382,13 +382,13 @@ 
 			$key = $this->getTagByName($from);
 		}
 		if ($key === false) {
-			\OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', ILogger::DEBUG);
+			\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);
+			\OCP\Util::writeLog('core', __METHOD__.', A tag named '.$to.' already exists for user '.$tag->getOwner().'.', ILogger::DEBUG);
 			return false;
 		}
 
@@ -461,7 +461,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.
@@ -471,7 +471,7 @@ 
 			$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);
+				\OCP\Util::writeLog('core', __METHOD__.'catid, '.$relation['tag'].' '.$tagId, ILogger::DEBUG);
 				if ($tagId) {
 					try {
 						$dbConnection->insertIfNotExist(self::RELATION_TABLE,
@@ -507,11 +507,11 @@ 
 		// 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) {
 			\OC::$server->getLogger()->logException($e, [
@@ -523,7 +523,7 @@ 
 
 		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()) {
 					try {
@@ -546,11 +546,11 @@ 
 			}
 		}
 		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) {
 			\OC::$server->getLogger()->logException($e, [
@@ -574,14 +574,14 @@ 
 		}
 		$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) {
@@ -699,7 +699,7 @@ 
 		}
 
 		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]);
@@ -728,7 +728,7 @@ 
 		$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) {
 			$id = null;
@@ -744,18 +744,18 @@ 
 				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) {
 				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;
 					}
@@ -778,7 +778,7 @@ 
 			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/Database.php

Indentation +441 added lines, -441 removed lines

@@ -61,445 +61,445 @@
  * 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' => $gid,
-			'displayname' => $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('gu.gid', 'g.displayname')
-			->from('group_user', 'gu')
-			->leftJoin('gu', 'groups', 'g', $qb->expr()->eq('gu.gid', 'g.gid'))
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->execute();
-
-		$groups = [];
-		while ($row = $cursor->fetch()) {
-			$groups[] = $row['gid'];
-			$this->groupCache[$row['gid']] = [
-				'gid' => $row['gid'],
-				'displayname' => $row['displayname'],
-			];
-		}
-		$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->orWhere($query->expr()->iLike('displayname', $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', 'displayname')
-			->from('groups')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-		$result = $cursor->fetch();
-		$cursor->closeCursor();
-
-		if ($result !== false) {
-			$this->groupCache[$gid] = [
-				'gid' => $gid,
-				'displayname' => $result['displayname'],
-			];
-			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('g.uid')
-			->from('group_user', 'g')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
-			->orderBy('g.uid', 'ASC');
-
-		if ($search !== '') {
-			$query->leftJoin('g', 'users', 'u', $query->expr()->eq('g.uid', 'u.uid'))
-				->leftJoin('u', 'preferences', 'p', $query->expr()->andX(
-					$query->expr()->eq('p.userid', 'u.uid'),
-					$query->expr()->eq('p.appid', $query->expr()->literal('settings')),
-					$query->expr()->eq('p.configkey', $query->expr()->literal('email')))
-				)
-				// sqlite doesn't like re-using a single named parameter here
-				->andWhere(
-					$query->expr()->orX(
-						$query->expr()->ilike('g.uid', $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')),
-						$query->expr()->ilike('u.displayname', $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')),
-						$query->expr()->ilike('p.configvalue', $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%'))
-					)
-				)
-				->orderBy('u.uid_lower', 'ASC');
-		}
-
-		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->fetchOne();
-		$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->fetchOne();
-		$result->closeCursor();
-
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
-
-	public function getDisplayName(string $gid): string {
-		if (isset($this->groupCache[$gid])) {
-			return $this->groupCache[$gid]['displayname'];
-		}
-
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('displayname')
-			->from('groups')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
-
-		$result = $query->execute();
-		$displayName = $result->fetchOne();
-		$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;
-	}
+    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' => $gid,
+            'displayname' => $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('gu.gid', 'g.displayname')
+            ->from('group_user', 'gu')
+            ->leftJoin('gu', 'groups', 'g', $qb->expr()->eq('gu.gid', 'g.gid'))
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->execute();
+
+        $groups = [];
+        while ($row = $cursor->fetch()) {
+            $groups[] = $row['gid'];
+            $this->groupCache[$row['gid']] = [
+                'gid' => $row['gid'],
+                'displayname' => $row['displayname'],
+            ];
+        }
+        $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->orWhere($query->expr()->iLike('displayname', $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', 'displayname')
+            ->from('groups')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+        $result = $cursor->fetch();
+        $cursor->closeCursor();
+
+        if ($result !== false) {
+            $this->groupCache[$gid] = [
+                'gid' => $gid,
+                'displayname' => $result['displayname'],
+            ];
+            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('g.uid')
+            ->from('group_user', 'g')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
+            ->orderBy('g.uid', 'ASC');
+
+        if ($search !== '') {
+            $query->leftJoin('g', 'users', 'u', $query->expr()->eq('g.uid', 'u.uid'))
+                ->leftJoin('u', 'preferences', 'p', $query->expr()->andX(
+                    $query->expr()->eq('p.userid', 'u.uid'),
+                    $query->expr()->eq('p.appid', $query->expr()->literal('settings')),
+                    $query->expr()->eq('p.configkey', $query->expr()->literal('email')))
+                )
+                // sqlite doesn't like re-using a single named parameter here
+                ->andWhere(
+                    $query->expr()->orX(
+                        $query->expr()->ilike('g.uid', $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')),
+                        $query->expr()->ilike('u.displayname', $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')),
+                        $query->expr()->ilike('p.configvalue', $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%'))
+                    )
+                )
+                ->orderBy('u.uid_lower', 'ASC');
+        }
+
+        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->fetchOne();
+        $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->fetchOne();
+        $result->closeCursor();
+
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
+
+    public function getDisplayName(string $gid): string {
+        if (isset($this->groupCache[$gid])) {
+            return $this->groupCache[$gid]['displayname'];
+        }
+
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('displayname')
+            ->from('groups')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
+
+        $result = $query->execute();
+        $displayName = $result->fetchOne();
+        $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;
+    }
 }

lib/private/Repair/Collation.php

Indentation +115 added lines, -115 removed lines

@@ -36,119 +36,119 @@
 use OCP\Migration\IRepairStep;
 
 class Collation implements IRepairStep {
-	/**  @var IConfig */
-	protected $config;
-
-	/** @var ILogger */
-	protected $logger;
-
-	/** @var IDBConnection */
-	protected $connection;
-
-	/** @var bool */
-	protected $ignoreFailures;
-
-	/**
-	 * @param IConfig $config
-	 * @param ILogger $logger
-	 * @param IDBConnection $connection
-	 * @param bool $ignoreFailures
-	 */
-	public function __construct(IConfig $config, ILogger $logger, IDBConnection $connection, $ignoreFailures) {
-		$this->connection = $connection;
-		$this->config = $config;
-		$this->logger = $logger;
-		$this->ignoreFailures = $ignoreFailures;
-	}
-
-	public function getName() {
-		return 'Repair MySQL collation';
-	}
-
-	/**
-	 * Fix mime types
-	 */
-	public function run(IOutput $output) {
-		if (!$this->connection->getDatabasePlatform() instanceof MySQLPlatform) {
-			$output->info('Not a mysql database -> nothing to do');
-			return;
-		}
-
-		$characterSet = $this->config->getSystemValue('mysql.utf8mb4', false) ? 'utf8mb4' : 'utf8';
-
-		$tables = $this->getAllNonUTF8BinTables($this->connection);
-		foreach ($tables as $table) {
-			$output->info("Change row format for $table ...");
-			$query = $this->connection->prepare('ALTER TABLE `' . $table . '` ROW_FORMAT = DYNAMIC;');
-			try {
-				$query->execute();
-			} catch (DriverException $e) {
-				// Just log this
-				$this->logger->logException($e);
-				if (!$this->ignoreFailures) {
-					throw $e;
-				}
-			}
-
-			$output->info("Change collation for $table ...");
-			if ($characterSet === 'utf8mb4') {
-				// need to set row compression first
-				$query = $this->connection->prepare('ALTER TABLE `' . $table . '` ROW_FORMAT=COMPRESSED;');
-				$query->execute();
-			}
-			$query = $this->connection->prepare('ALTER TABLE `' . $table . '` CONVERT TO CHARACTER SET ' . $characterSet . ' COLLATE ' . $characterSet . '_bin;');
-			try {
-				$query->execute();
-			} catch (DriverException $e) {
-				// Just log this
-				$this->logger->logException($e);
-				if (!$this->ignoreFailures) {
-					throw $e;
-				}
-			}
-		}
-		if (empty($tables)) {
-			$output->info('All tables already have the correct collation -> nothing to do');
-		}
-	}
-
-	/**
-	 * @param IDBConnection $connection
-	 * @return string[]
-	 */
-	protected function getAllNonUTF8BinTables(IDBConnection $connection) {
-		$dbName = $this->config->getSystemValue("dbname");
-		$characterSet = $this->config->getSystemValue('mysql.utf8mb4', false) ? 'utf8mb4' : 'utf8';
-
-		// fetch tables by columns
-		$statement = $connection->executeQuery(
-			"SELECT DISTINCT(TABLE_NAME) AS `table`" .
-			"	FROM INFORMATION_SCHEMA . COLUMNS" .
-			"	WHERE TABLE_SCHEMA = ?" .
-			"	AND (COLLATION_NAME <> '" . $characterSet . "_bin' OR CHARACTER_SET_NAME <> '" . $characterSet . "')" .
-			"	AND TABLE_NAME LIKE '*PREFIX*%'",
-			[$dbName]
-		);
-		$rows = $statement->fetchAll();
-		$result = [];
-		foreach ($rows as $row) {
-			$result[$row['table']] = true;
-		}
-
-		// fetch tables by collation
-		$statement = $connection->executeQuery(
-			"SELECT DISTINCT(TABLE_NAME) AS `table`" .
-			"	FROM INFORMATION_SCHEMA . TABLES" .
-			"	WHERE TABLE_SCHEMA = ?" .
-			"	AND TABLE_COLLATION <> '" . $characterSet . "_bin'" .
-			"	AND TABLE_NAME LIKE '*PREFIX*%'",
-			[$dbName]
-		);
-		$rows = $statement->fetchAll();
-		foreach ($rows as $row) {
-			$result[$row['table']] = true;
-		}
-
-		return array_keys($result);
-	}
+    /**  @var IConfig */
+    protected $config;
+
+    /** @var ILogger */
+    protected $logger;
+
+    /** @var IDBConnection */
+    protected $connection;
+
+    /** @var bool */
+    protected $ignoreFailures;
+
+    /**
+     * @param IConfig $config
+     * @param ILogger $logger
+     * @param IDBConnection $connection
+     * @param bool $ignoreFailures
+     */
+    public function __construct(IConfig $config, ILogger $logger, IDBConnection $connection, $ignoreFailures) {
+        $this->connection = $connection;
+        $this->config = $config;
+        $this->logger = $logger;
+        $this->ignoreFailures = $ignoreFailures;
+    }
+
+    public function getName() {
+        return 'Repair MySQL collation';
+    }
+
+    /**
+     * Fix mime types
+     */
+    public function run(IOutput $output) {
+        if (!$this->connection->getDatabasePlatform() instanceof MySQLPlatform) {
+            $output->info('Not a mysql database -> nothing to do');
+            return;
+        }
+
+        $characterSet = $this->config->getSystemValue('mysql.utf8mb4', false) ? 'utf8mb4' : 'utf8';
+
+        $tables = $this->getAllNonUTF8BinTables($this->connection);
+        foreach ($tables as $table) {
+            $output->info("Change row format for $table ...");
+            $query = $this->connection->prepare('ALTER TABLE `' . $table . '` ROW_FORMAT = DYNAMIC;');
+            try {
+                $query->execute();
+            } catch (DriverException $e) {
+                // Just log this
+                $this->logger->logException($e);
+                if (!$this->ignoreFailures) {
+                    throw $e;
+                }
+            }
+
+            $output->info("Change collation for $table ...");
+            if ($characterSet === 'utf8mb4') {
+                // need to set row compression first
+                $query = $this->connection->prepare('ALTER TABLE `' . $table . '` ROW_FORMAT=COMPRESSED;');
+                $query->execute();
+            }
+            $query = $this->connection->prepare('ALTER TABLE `' . $table . '` CONVERT TO CHARACTER SET ' . $characterSet . ' COLLATE ' . $characterSet . '_bin;');
+            try {
+                $query->execute();
+            } catch (DriverException $e) {
+                // Just log this
+                $this->logger->logException($e);
+                if (!$this->ignoreFailures) {
+                    throw $e;
+                }
+            }
+        }
+        if (empty($tables)) {
+            $output->info('All tables already have the correct collation -> nothing to do');
+        }
+    }
+
+    /**
+     * @param IDBConnection $connection
+     * @return string[]
+     */
+    protected function getAllNonUTF8BinTables(IDBConnection $connection) {
+        $dbName = $this->config->getSystemValue("dbname");
+        $characterSet = $this->config->getSystemValue('mysql.utf8mb4', false) ? 'utf8mb4' : 'utf8';
+
+        // fetch tables by columns
+        $statement = $connection->executeQuery(
+            "SELECT DISTINCT(TABLE_NAME) AS `table`" .
+            "	FROM INFORMATION_SCHEMA . COLUMNS" .
+            "	WHERE TABLE_SCHEMA = ?" .
+            "	AND (COLLATION_NAME <> '" . $characterSet . "_bin' OR CHARACTER_SET_NAME <> '" . $characterSet . "')" .
+            "	AND TABLE_NAME LIKE '*PREFIX*%'",
+            [$dbName]
+        );
+        $rows = $statement->fetchAll();
+        $result = [];
+        foreach ($rows as $row) {
+            $result[$row['table']] = true;
+        }
+
+        // fetch tables by collation
+        $statement = $connection->executeQuery(
+            "SELECT DISTINCT(TABLE_NAME) AS `table`" .
+            "	FROM INFORMATION_SCHEMA . TABLES" .
+            "	WHERE TABLE_SCHEMA = ?" .
+            "	AND TABLE_COLLATION <> '" . $characterSet . "_bin'" .
+            "	AND TABLE_NAME LIKE '*PREFIX*%'",
+            [$dbName]
+        );
+        $rows = $statement->fetchAll();
+        foreach ($rows as $row) {
+            $result[$row['table']] = true;
+        }
+
+        return array_keys($result);
+    }
 }

lib/private/Repair/RepairMimeTypes.php

Indentation +206 added lines, -206 removed lines

@@ -41,210 +41,210 @@
 use OCP\Migration\IRepairStep;
 
 class RepairMimeTypes implements IRepairStep {
-	/** @var IConfig */
-	protected $config;
-	/** @var IDBConnection */
-	protected $connection;
-
-	/** @var int */
-	protected $folderMimeTypeId;
-
-	public function __construct(IConfig $config,
-								IDBConnection $connection) {
-		$this->config = $config;
-		$this->connection = $connection;
-	}
-
-	public function getName() {
-		return 'Repair mime types';
-	}
-
-	private function updateMimetypes($updatedMimetypes) {
-		$query = $this->connection->getQueryBuilder();
-		$query->select('id')
-			->from('mimetypes')
-			->where($query->expr()->eq('mimetype', $query->createParameter('mimetype'), IQueryBuilder::PARAM_INT));
-		$insert = $this->connection->getQueryBuilder();
-		$insert->insert('mimetypes')
-			->setValue('mimetype', $insert->createParameter('mimetype'));
-
-		if (empty($this->folderMimeTypeId)) {
-			$query->setParameter('mimetype', 'httpd/unix-directory');
-			$result = $query->execute();
-			$this->folderMimeTypeId = (int)$result->fetchOne();
-			$result->closeCursor();
-		}
-
-		$update = $this->connection->getQueryBuilder();
-		$update->update('filecache')
-			->set('mimetype', $update->createParameter('mimetype'))
-			->where($update->expr()->neq('mimetype', $update->createParameter('mimetype'), IQueryBuilder::PARAM_INT))
-			->andWhere($update->expr()->neq('mimetype', $update->createParameter('folder'), IQueryBuilder::PARAM_INT))
-			->andWhere($update->expr()->iLike('name', $update->createParameter('name')))
-			->setParameter('folder', $this->folderMimeTypeId);
-
-		$count = 0;
-		foreach ($updatedMimetypes as $extension => $mimetype) {
-			// get target mimetype id
-			$query->setParameter('mimetype', $mimetype);
-			$result = $query->execute();
-			$mimetypeId = (int)$result->fetchOne();
-			$result->closeCursor();
-
-			if (!$mimetypeId) {
-				// insert mimetype
-				$insert->setParameter('mimetype', $mimetype);
-				$insert->execute();
-				$mimetypeId = $insert->getLastInsertId();
-			}
-
-			// change mimetype for files with x extension
-			$update->setParameter('mimetype', $mimetypeId)
-				->setParameter('name', '%' . $this->connection->escapeLikeParameter('.' . $extension));
-			$count += $update->execute();
-		}
-
-		return $count;
-	}
-
-	private function introduceImageTypes() {
-		$updatedMimetypes = [
-			'jp2' => 'image/jp2',
-			'webp' => 'image/webp',
-		];
-
-		return $this->updateMimetypes($updatedMimetypes);
-	}
-
-	private function introduceWindowsProgramTypes() {
-		$updatedMimetypes = [
-			'htaccess' => 'text/plain',
-			'bat' => 'application/x-msdos-program',
-			'cmd' => 'application/cmd',
-		];
-
-		return $this->updateMimetypes($updatedMimetypes);
-	}
-
-	private function introduceLocationTypes() {
-		$updatedMimetypes = [
-			'gpx' => 'application/gpx+xml',
-			'kml' => 'application/vnd.google-earth.kml+xml',
-			'kmz' => 'application/vnd.google-earth.kmz',
-			'tcx' => 'application/vnd.garmin.tcx+xml',
-		];
-
-		return $this->updateMimetypes($updatedMimetypes);
-	}
-
-	private function introduceInternetShortcutTypes() {
-		$updatedMimetypes = [
-			'url' => 'application/internet-shortcut',
-			'webloc' => 'application/internet-shortcut'
-		];
-
-		return $this->updateMimetypes($updatedMimetypes);
-	}
-
-	private function introduceStreamingTypes() {
-		$updatedMimetypes = [
-			'm3u' => 'audio/mpegurl',
-			'm3u8' => 'audio/mpegurl',
-			'pls' => 'audio/x-scpls'
-		];
-
-		return $this->updateMimetypes($updatedMimetypes);
-	}
-
-	private function introduceVisioTypes() {
-		$updatedMimetypes = [
-			'vsdm' => 'application/vnd.visio',
-			'vsdx' => 'application/vnd.visio',
-			'vssm' => 'application/vnd.visio',
-			'vssx' => 'application/vnd.visio',
-			'vstm' => 'application/vnd.visio',
-			'vstx' => 'application/vnd.visio',
-		];
-
-		return $this->updateMimetypes($updatedMimetypes);
-	}
-
-	private function introduceComicbookTypes() {
-		$updatedMimetypes = [
-			'cb7' => 'application/comicbook+7z',
-			'cba' => 'application/comicbook+ace',
-			'cbr' => 'application/comicbook+rar',
-			'cbt' => 'application/comicbook+tar',
-			'cbtc' => 'application/comicbook+truecrypt',
-			'cbz' => 'application/comicbook+zip',
-		];
-
-		return $this->updateMimetypes($updatedMimetypes);
-	}
-
-	private function introduceOpenDocumentTemplates() {
-		$updatedMimetypes = [
-			'ott' => 'application/vnd.oasis.opendocument.text-template',
-			'ots' => 'application/vnd.oasis.opendocument.spreadsheet-template',
-			'otp' => 'application/vnd.oasis.opendocument.presentation-template',
-			'otg' => 'application/vnd.oasis.opendocument.graphics-template',
-		];
-
-		return $this->updateMimetypes($updatedMimetypes);
-	}
-
-	private function introduceOrgModeType() {
-		$updatedMimetypes = [
-			'org' => 'text/org'
-		];
-
-		return $this->updateMimetypes($updatedMimetypes);
-	}
-
-
-	/**
-	 * Fix mime types
-	 */
-	public function run(IOutput $out) {
-		$ocVersionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0');
-
-		// NOTE TO DEVELOPERS: when adding new mime types, please make sure to
-		// add a version comparison to avoid doing it every time
-
-		if (version_compare($ocVersionFromBeforeUpdate, '12.0.0.14', '<') && $this->introduceImageTypes()) {
-			$out->info('Fixed image mime types');
-		}
-
-		if (version_compare($ocVersionFromBeforeUpdate, '12.0.0.13', '<') && $this->introduceWindowsProgramTypes()) {
-			$out->info('Fixed windows program mime types');
-		}
-
-		if (version_compare($ocVersionFromBeforeUpdate, '13.0.0.0', '<') && $this->introduceLocationTypes()) {
-			$out->info('Fixed geospatial mime types');
-		}
-
-		if (version_compare($ocVersionFromBeforeUpdate, '13.0.0.3', '<') && $this->introduceInternetShortcutTypes()) {
-			$out->info('Fixed internet-shortcut mime types');
-		}
-
-		if (version_compare($ocVersionFromBeforeUpdate, '13.0.0.6', '<') && $this->introduceStreamingTypes()) {
-			$out->info('Fixed streaming mime types');
-		}
-
-		if (version_compare($ocVersionFromBeforeUpdate, '14.0.0.8', '<') && $this->introduceVisioTypes()) {
-			$out->info('Fixed visio mime types');
-		}
-
-		if (version_compare($ocVersionFromBeforeUpdate, '14.0.0.10', '<') && $this->introduceComicbookTypes()) {
-			$out->info('Fixed comicbook mime types');
-		}
-
-		if (version_compare($ocVersionFromBeforeUpdate, '20.0.0.5', '<') && $this->introduceOpenDocumentTemplates()) {
-			$out->info('Fixed OpenDocument template mime types');
-		}
-
-		if (version_compare($ocVersionFromBeforeUpdate, '21.0.0.7', '<') && $this->introduceOrgModeType()) {
-			$out->info('Fixed orgmode mime types');
-		}
-	}
+    /** @var IConfig */
+    protected $config;
+    /** @var IDBConnection */
+    protected $connection;
+
+    /** @var int */
+    protected $folderMimeTypeId;
+
+    public function __construct(IConfig $config,
+                                IDBConnection $connection) {
+        $this->config = $config;
+        $this->connection = $connection;
+    }
+
+    public function getName() {
+        return 'Repair mime types';
+    }
+
+    private function updateMimetypes($updatedMimetypes) {
+        $query = $this->connection->getQueryBuilder();
+        $query->select('id')
+            ->from('mimetypes')
+            ->where($query->expr()->eq('mimetype', $query->createParameter('mimetype'), IQueryBuilder::PARAM_INT));
+        $insert = $this->connection->getQueryBuilder();
+        $insert->insert('mimetypes')
+            ->setValue('mimetype', $insert->createParameter('mimetype'));
+
+        if (empty($this->folderMimeTypeId)) {
+            $query->setParameter('mimetype', 'httpd/unix-directory');
+            $result = $query->execute();
+            $this->folderMimeTypeId = (int)$result->fetchOne();
+            $result->closeCursor();
+        }
+
+        $update = $this->connection->getQueryBuilder();
+        $update->update('filecache')
+            ->set('mimetype', $update->createParameter('mimetype'))
+            ->where($update->expr()->neq('mimetype', $update->createParameter('mimetype'), IQueryBuilder::PARAM_INT))
+            ->andWhere($update->expr()->neq('mimetype', $update->createParameter('folder'), IQueryBuilder::PARAM_INT))
+            ->andWhere($update->expr()->iLike('name', $update->createParameter('name')))
+            ->setParameter('folder', $this->folderMimeTypeId);
+
+        $count = 0;
+        foreach ($updatedMimetypes as $extension => $mimetype) {
+            // get target mimetype id
+            $query->setParameter('mimetype', $mimetype);
+            $result = $query->execute();
+            $mimetypeId = (int)$result->fetchOne();
+            $result->closeCursor();
+
+            if (!$mimetypeId) {
+                // insert mimetype
+                $insert->setParameter('mimetype', $mimetype);
+                $insert->execute();
+                $mimetypeId = $insert->getLastInsertId();
+            }
+
+            // change mimetype for files with x extension
+            $update->setParameter('mimetype', $mimetypeId)
+                ->setParameter('name', '%' . $this->connection->escapeLikeParameter('.' . $extension));
+            $count += $update->execute();
+        }
+
+        return $count;
+    }
+
+    private function introduceImageTypes() {
+        $updatedMimetypes = [
+            'jp2' => 'image/jp2',
+            'webp' => 'image/webp',
+        ];
+
+        return $this->updateMimetypes($updatedMimetypes);
+    }
+
+    private function introduceWindowsProgramTypes() {
+        $updatedMimetypes = [
+            'htaccess' => 'text/plain',
+            'bat' => 'application/x-msdos-program',
+            'cmd' => 'application/cmd',
+        ];
+
+        return $this->updateMimetypes($updatedMimetypes);
+    }
+
+    private function introduceLocationTypes() {
+        $updatedMimetypes = [
+            'gpx' => 'application/gpx+xml',
+            'kml' => 'application/vnd.google-earth.kml+xml',
+            'kmz' => 'application/vnd.google-earth.kmz',
+            'tcx' => 'application/vnd.garmin.tcx+xml',
+        ];
+
+        return $this->updateMimetypes($updatedMimetypes);
+    }
+
+    private function introduceInternetShortcutTypes() {
+        $updatedMimetypes = [
+            'url' => 'application/internet-shortcut',
+            'webloc' => 'application/internet-shortcut'
+        ];
+
+        return $this->updateMimetypes($updatedMimetypes);
+    }
+
+    private function introduceStreamingTypes() {
+        $updatedMimetypes = [
+            'm3u' => 'audio/mpegurl',
+            'm3u8' => 'audio/mpegurl',
+            'pls' => 'audio/x-scpls'
+        ];
+
+        return $this->updateMimetypes($updatedMimetypes);
+    }
+
+    private function introduceVisioTypes() {
+        $updatedMimetypes = [
+            'vsdm' => 'application/vnd.visio',
+            'vsdx' => 'application/vnd.visio',
+            'vssm' => 'application/vnd.visio',
+            'vssx' => 'application/vnd.visio',
+            'vstm' => 'application/vnd.visio',
+            'vstx' => 'application/vnd.visio',
+        ];
+
+        return $this->updateMimetypes($updatedMimetypes);
+    }
+
+    private function introduceComicbookTypes() {
+        $updatedMimetypes = [
+            'cb7' => 'application/comicbook+7z',
+            'cba' => 'application/comicbook+ace',
+            'cbr' => 'application/comicbook+rar',
+            'cbt' => 'application/comicbook+tar',
+            'cbtc' => 'application/comicbook+truecrypt',
+            'cbz' => 'application/comicbook+zip',
+        ];
+
+        return $this->updateMimetypes($updatedMimetypes);
+    }
+
+    private function introduceOpenDocumentTemplates() {
+        $updatedMimetypes = [
+            'ott' => 'application/vnd.oasis.opendocument.text-template',
+            'ots' => 'application/vnd.oasis.opendocument.spreadsheet-template',
+            'otp' => 'application/vnd.oasis.opendocument.presentation-template',
+            'otg' => 'application/vnd.oasis.opendocument.graphics-template',
+        ];
+
+        return $this->updateMimetypes($updatedMimetypes);
+    }
+
+    private function introduceOrgModeType() {
+        $updatedMimetypes = [
+            'org' => 'text/org'
+        ];
+
+        return $this->updateMimetypes($updatedMimetypes);
+    }
+
+
+    /**
+     * Fix mime types
+     */
+    public function run(IOutput $out) {
+        $ocVersionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0');
+
+        // NOTE TO DEVELOPERS: when adding new mime types, please make sure to
+        // add a version comparison to avoid doing it every time
+
+        if (version_compare($ocVersionFromBeforeUpdate, '12.0.0.14', '<') && $this->introduceImageTypes()) {
+            $out->info('Fixed image mime types');
+        }
+
+        if (version_compare($ocVersionFromBeforeUpdate, '12.0.0.13', '<') && $this->introduceWindowsProgramTypes()) {
+            $out->info('Fixed windows program mime types');
+        }
+
+        if (version_compare($ocVersionFromBeforeUpdate, '13.0.0.0', '<') && $this->introduceLocationTypes()) {
+            $out->info('Fixed geospatial mime types');
+        }
+
+        if (version_compare($ocVersionFromBeforeUpdate, '13.0.0.3', '<') && $this->introduceInternetShortcutTypes()) {
+            $out->info('Fixed internet-shortcut mime types');
+        }
+
+        if (version_compare($ocVersionFromBeforeUpdate, '13.0.0.6', '<') && $this->introduceStreamingTypes()) {
+            $out->info('Fixed streaming mime types');
+        }
+
+        if (version_compare($ocVersionFromBeforeUpdate, '14.0.0.8', '<') && $this->introduceVisioTypes()) {
+            $out->info('Fixed visio mime types');
+        }
+
+        if (version_compare($ocVersionFromBeforeUpdate, '14.0.0.10', '<') && $this->introduceComicbookTypes()) {
+            $out->info('Fixed comicbook mime types');
+        }
+
+        if (version_compare($ocVersionFromBeforeUpdate, '20.0.0.5', '<') && $this->introduceOpenDocumentTemplates()) {
+            $out->info('Fixed OpenDocument template mime types');
+        }
+
+        if (version_compare($ocVersionFromBeforeUpdate, '21.0.0.7', '<') && $this->introduceOrgModeType()) {
+            $out->info('Fixed orgmode mime types');
+        }
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -71,7 +71,7 @@ 
 		if (empty($this->folderMimeTypeId)) {
 			$query->setParameter('mimetype', 'httpd/unix-directory');
 			$result = $query->execute();
-			$this->folderMimeTypeId = (int)$result->fetchOne();
+			$this->folderMimeTypeId = (int) $result->fetchOne();
 			$result->closeCursor();
 		}
 
@@ -88,7 +88,7 @@ 
 			// get target mimetype id
 			$query->setParameter('mimetype', $mimetype);
 			$result = $query->execute();
-			$mimetypeId = (int)$result->fetchOne();
+			$mimetypeId = (int) $result->fetchOne();
 			$result->closeCursor();
 
 			if (!$mimetypeId) {
@@ -100,7 +100,7 @@ 
 
 			// change mimetype for files with x extension
 			$update->setParameter('mimetype', $mimetypeId)
-				->setParameter('name', '%' . $this->connection->escapeLikeParameter('.' . $extension));
+				->setParameter('name', '%'.$this->connection->escapeLikeParameter('.'.$extension));
 			$count += $update->execute();
 		}