nextcloud / server

core/Command/Db/ConvertMysqlToMB4.php

Indentation +45 added lines, -45 removed lines

@@ -34,59 +34,59 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class ConvertMysqlToMB4 extends Command {
-	/** @var IConfig */
-	private $config;
+    /** @var IConfig */
+    private $config;
 
-	/** @var IDBConnection */
-	private $connection;
+    /** @var IDBConnection */
+    private $connection;
 
-	/** @var IURLGenerator */
-	private $urlGenerator;
+    /** @var IURLGenerator */
+    private $urlGenerator;
 
-	/** @var ILogger */
-	private $logger;
+    /** @var ILogger */
+    private $logger;
 
-	/**
-	 * @param IConfig $config
-	 * @param IDBConnection $connection
-	 * @param IURLGenerator $urlGenerator
-	 * @param ILogger $logger
-	 */
-	public function __construct(IConfig $config, IDBConnection $connection, IURLGenerator $urlGenerator, ILogger $logger) {
-		$this->config = $config;
-		$this->connection = $connection;
-		$this->urlGenerator = $urlGenerator;
-		$this->logger = $logger;
-		parent::__construct();
-	}
+    /**
+     * @param IConfig $config
+     * @param IDBConnection $connection
+     * @param IURLGenerator $urlGenerator
+     * @param ILogger $logger
+     */
+    public function __construct(IConfig $config, IDBConnection $connection, IURLGenerator $urlGenerator, ILogger $logger) {
+        $this->config = $config;
+        $this->connection = $connection;
+        $this->urlGenerator = $urlGenerator;
+        $this->logger = $logger;
+        parent::__construct();
+    }
 
-	protected function configure() {
-		$this
-			->setName('db:convert-mysql-charset')
-			->setDescription('Convert charset of MySQL/MariaDB to use utf8mb4');
-	}
+    protected function configure() {
+        $this
+            ->setName('db:convert-mysql-charset')
+            ->setDescription('Convert charset of MySQL/MariaDB to use utf8mb4');
+    }
 
-	protected function execute(InputInterface $input, OutputInterface $output) {
-		if (!$this->connection->getDatabasePlatform() instanceof MySqlPlatform) {
-			$output->writeln("This command is only valid for MySQL/MariaDB databases.");
-			return 1;
-		}
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        if (!$this->connection->getDatabasePlatform() instanceof MySqlPlatform) {
+            $output->writeln("This command is only valid for MySQL/MariaDB databases.");
+            return 1;
+        }
 
-		$tools = new MySqlTools();
-		if (!$tools->supports4ByteCharset($this->connection)) {
-			$url = $this->urlGenerator->linkToDocs('admin-mysql-utf8mb4');
-			$output->writeln("The database is not properly setup to use the charset utf8mb4.");
-			$output->writeln("For more information please read the documentation at $url");
-			return 1;
-		}
+        $tools = new MySqlTools();
+        if (!$tools->supports4ByteCharset($this->connection)) {
+            $url = $this->urlGenerator->linkToDocs('admin-mysql-utf8mb4');
+            $output->writeln("The database is not properly setup to use the charset utf8mb4.");
+            $output->writeln("For more information please read the documentation at $url");
+            return 1;
+        }
 
-		// enable charset
-		$this->config->setSystemValue('mysql.utf8mb4', true);
+        // enable charset
+        $this->config->setSystemValue('mysql.utf8mb4', true);
 
-		// run conversion
-		$coll = new Collation($this->config, $this->logger, $this->connection, false);
-		$coll->run(new ConsoleOutput($output));
+        // run conversion
+        $coll = new Collation($this->config, $this->logger, $this->connection, false);
+        $coll->run(new ConsoleOutput($output));
 
-		return 0;
-	}
+        return 0;
+    }
 }

lib/private/Repair/Collation.php

Indentation +118 added lines, -118 removed lines

@@ -33,123 +33,123 @@
 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');
-		}
-		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*%\"",
-			array($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');
+        }
+        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*%\"",
+            array($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/DB/MySqlTools.php

Indentation +18 added lines, -18 removed lines

@@ -28,22 +28,22 @@
 */
 class MySqlTools {
 
-	/**
-	 * @param Connection $connection
-	 * @return bool
-	 */
-	public function supports4ByteCharset(IDBConnection $connection) {
-		foreach (['innodb_file_format' => 'Barracuda', 'innodb_large_prefix' => 'ON', 'innodb_file_per_table' => 'ON'] as $var => $val) {
-			$result = $connection->executeQuery("SHOW VARIABLES LIKE '$var'");
-			$rows = $result->fetch();
-			$result->closeCursor();
-			if ($rows === false) {
-				return false;
-			}
-			if (strcasecmp($rows['Value'], $val) !== 0) {
-				return false;
-			}
-		}
-		return true;
-	}
+    /**
+     * @param Connection $connection
+     * @return bool
+     */
+    public function supports4ByteCharset(IDBConnection $connection) {
+        foreach (['innodb_file_format' => 'Barracuda', 'innodb_large_prefix' => 'ON', 'innodb_file_per_table' => 'ON'] as $var => $val) {
+            $result = $connection->executeQuery("SHOW VARIABLES LIKE '$var'");
+            $rows = $result->fetch();
+            $result->closeCursor();
+            if ($rows === false) {
+                return false;
+            }
+            if (strcasecmp($rows['Value'], $val) !== 0) {
+                return false;
+            }
+        }
+        return true;
+    }
 }

lib/private/Setup/MySQL.php

Indentation +136 added lines, -136 removed lines

@@ -31,143 +31,143 @@
 use OCP\IDBConnection;
 
 class MySQL extends AbstractDatabase {
-	public $dbprettyname = 'MySQL/MariaDB';
-
-	public function setupDatabase($username) {
-		//check if the database user has admin right
-		$connection = $this->connect(['dbname' => null]);
-
-		// detect mb4
-		$tools = new MySqlTools();
-		if ($tools->supports4ByteCharset($connection)) {
-			$this->config->setValue('mysql.utf8mb4', true);
-			$connection = $this->connect();
-		}
-
-		$this->createSpecificUser($username, $connection);
-
-		//create the database
-		$this->createDatabase($connection);
-
-		//fill the database if needed
-		$query='select count(*) from information_schema.tables where table_schema=? AND table_name = ?';
-		$result = $connection->executeQuery($query, [$this->dbName, $this->tablePrefix.'users']);
-		$row = $result->fetch();
-		if (!$row or $row['count(*)'] === '0') {
-			\OC_DB::createDbFromStructure($this->dbDefinitionFile);
-		}
-	}
-
-	/**
-	 * @param \OC\DB\Connection $connection
-	 */
-	private function createDatabase($connection) {
-		try{
-			$name = $this->dbName;
-			$user = $this->dbUser;
-			//we can't use OC_DB functions here because we need to connect as the administrative user.
-			$characterSet = $this->config->getValue('mysql.utf8mb4', false) ? 'utf8mb4' : 'utf8';
-			$query = "CREATE DATABASE IF NOT EXISTS `$name` CHARACTER SET $characterSet COLLATE ${characterSet}_bin;";
-			$connection->executeUpdate($query);
-		} catch (\Exception $ex) {
-			$this->logger->error('Database creation failed: {error}', [
-				'app' => 'mysql.setup',
-				'error' => $ex->getMessage()
-			]);
-			return;
-		}
-
-		try {
-			//this query will fail if there aren't the right permissions, ignore the error
-			$query="GRANT ALL PRIVILEGES ON `$name` . * TO '$user'";
-			$connection->executeUpdate($query);
-		} catch (\Exception $ex) {
-			$this->logger->debug('Could not automatically grant privileges, this can be ignored if database user already had privileges: {error}', [
-				'app' => 'mysql.setup',
-				'error' => $ex->getMessage()
-			]);
-		}
-	}
-
-	/**
-	 * @param IDBConnection $connection
-	 * @throws \OC\DatabaseSetupException
-	 */
-	private function createDBUser($connection) {
-		try{
-			$name = $this->dbUser;
-			$password = $this->dbPassword;
-			// we need to create 2 accounts, one for global use and one for local user. if we don't specify the local one,
-			// the anonymous user would take precedence when there is one.
-			$query = "CREATE USER '$name'@'localhost' IDENTIFIED BY '$password'";
-			$connection->executeUpdate($query);
-			$query = "CREATE USER '$name'@'%' IDENTIFIED BY '$password'";
-			$connection->executeUpdate($query);
-		}
-		catch (\Exception $ex){
-			$this->logger->error('Database User creation failed: {error}', [
+    public $dbprettyname = 'MySQL/MariaDB';
+
+    public function setupDatabase($username) {
+        //check if the database user has admin right
+        $connection = $this->connect(['dbname' => null]);
+
+        // detect mb4
+        $tools = new MySqlTools();
+        if ($tools->supports4ByteCharset($connection)) {
+            $this->config->setValue('mysql.utf8mb4', true);
+            $connection = $this->connect();
+        }
+
+        $this->createSpecificUser($username, $connection);
+
+        //create the database
+        $this->createDatabase($connection);
+
+        //fill the database if needed
+        $query='select count(*) from information_schema.tables where table_schema=? AND table_name = ?';
+        $result = $connection->executeQuery($query, [$this->dbName, $this->tablePrefix.'users']);
+        $row = $result->fetch();
+        if (!$row or $row['count(*)'] === '0') {
+            \OC_DB::createDbFromStructure($this->dbDefinitionFile);
+        }
+    }
+
+    /**
+     * @param \OC\DB\Connection $connection
+     */
+    private function createDatabase($connection) {
+        try{
+            $name = $this->dbName;
+            $user = $this->dbUser;
+            //we can't use OC_DB functions here because we need to connect as the administrative user.
+            $characterSet = $this->config->getValue('mysql.utf8mb4', false) ? 'utf8mb4' : 'utf8';
+            $query = "CREATE DATABASE IF NOT EXISTS `$name` CHARACTER SET $characterSet COLLATE ${characterSet}_bin;";
+            $connection->executeUpdate($query);
+        } catch (\Exception $ex) {
+            $this->logger->error('Database creation failed: {error}', [
+                'app' => 'mysql.setup',
+                'error' => $ex->getMessage()
+            ]);
+            return;
+        }
+
+        try {
+            //this query will fail if there aren't the right permissions, ignore the error
+            $query="GRANT ALL PRIVILEGES ON `$name` . * TO '$user'";
+            $connection->executeUpdate($query);
+        } catch (\Exception $ex) {
+            $this->logger->debug('Could not automatically grant privileges, this can be ignored if database user already had privileges: {error}', [
+                'app' => 'mysql.setup',
+                'error' => $ex->getMessage()
+            ]);
+        }
+    }
+
+    /**
+     * @param IDBConnection $connection
+     * @throws \OC\DatabaseSetupException
+     */
+    private function createDBUser($connection) {
+        try{
+            $name = $this->dbUser;
+            $password = $this->dbPassword;
+            // we need to create 2 accounts, one for global use and one for local user. if we don't specify the local one,
+            // the anonymous user would take precedence when there is one.
+            $query = "CREATE USER '$name'@'localhost' IDENTIFIED BY '$password'";
+            $connection->executeUpdate($query);
+            $query = "CREATE USER '$name'@'%' IDENTIFIED BY '$password'";
+            $connection->executeUpdate($query);
+        }
+        catch (\Exception $ex){
+            $this->logger->error('Database User creation failed: {error}', [
                                 'app' => 'mysql.setup',
                                 'error' => $ex->getMessage()
                         ]);
-		}
-	}
-
-	/**
-	 * @param $username
-	 * @param IDBConnection $connection
-	 * @return array
-	 */
-	private function createSpecificUser($username, $connection) {
-		try {
-			//user already specified in config
-			$oldUser = $this->config->getValue('dbuser', false);
-
-			//we don't have a dbuser specified in config
-			if ($this->dbUser !== $oldUser) {
-				//add prefix to the admin username to prevent collisions
-				$adminUser = substr('oc_' . $username, 0, 16);
-
-				$i = 1;
-				while (true) {
-					//this should be enough to check for admin rights in mysql
-					$query = 'SELECT user FROM mysql.user WHERE user=?';
-					$result = $connection->executeQuery($query, [$adminUser]);
-
-					//current dbuser has admin rights
-					if ($result) {
-						$data = $result->fetchAll();
-						//new dbuser does not exist
-						if (count($data) === 0) {
-							//use the admin login data for the new database user
-							$this->dbUser = $adminUser;
-
-							//create a random password so we don't need to store the admin password in the config file
-							$this->dbPassword =  $this->random->generate(30);
-
-							$this->createDBUser($connection);
-
-							break;
-						} else {
-							//repeat with different username
-							$length = strlen((string)$i);
-							$adminUser = substr('oc_' . $username, 0, 16 - $length) . $i;
-							$i++;
-						}
-					} else {
-						break;
-					}
-				};
-			}
-		} catch (\Exception $ex) {
-			$this->logger->info('Can not create a new MySQL user, will continue with the provided user: {error}', [
-				'app' => 'mysql.setup',
-				'error' => $ex->getMessage()
-			]);
-		}
-
-		$this->config->setValues([
-			'dbuser' => $this->dbUser,
-			'dbpassword' => $this->dbPassword,
-		]);
-	}
+        }
+    }
+
+    /**
+     * @param $username
+     * @param IDBConnection $connection
+     * @return array
+     */
+    private function createSpecificUser($username, $connection) {
+        try {
+            //user already specified in config
+            $oldUser = $this->config->getValue('dbuser', false);
+
+            //we don't have a dbuser specified in config
+            if ($this->dbUser !== $oldUser) {
+                //add prefix to the admin username to prevent collisions
+                $adminUser = substr('oc_' . $username, 0, 16);
+
+                $i = 1;
+                while (true) {
+                    //this should be enough to check for admin rights in mysql
+                    $query = 'SELECT user FROM mysql.user WHERE user=?';
+                    $result = $connection->executeQuery($query, [$adminUser]);
+
+                    //current dbuser has admin rights
+                    if ($result) {
+                        $data = $result->fetchAll();
+                        //new dbuser does not exist
+                        if (count($data) === 0) {
+                            //use the admin login data for the new database user
+                            $this->dbUser = $adminUser;
+
+                            //create a random password so we don't need to store the admin password in the config file
+                            $this->dbPassword =  $this->random->generate(30);
+
+                            $this->createDBUser($connection);
+
+                            break;
+                        } else {
+                            //repeat with different username
+                            $length = strlen((string)$i);
+                            $adminUser = substr('oc_' . $username, 0, 16 - $length) . $i;
+                            $i++;
+                        }
+                    } else {
+                        break;
+                    }
+                };
+            }
+        } catch (\Exception $ex) {
+            $this->logger->info('Can not create a new MySQL user, will continue with the provided user: {error}', [
+                'app' => 'mysql.setup',
+                'error' => $ex->getMessage()
+            ]);
+        }
+
+        $this->config->setValues([
+            'dbuser' => $this->dbUser,
+            'dbpassword' => $this->dbPassword,
+        ]);
+    }
 }