713f684a8b
* success on SQLite and Postgres * failure on MySQL due to the limited charset that only supports up to 3 bytes Add config option to update charset of mysql to utf8mb4 * fully optional * requires additional options set in the database only disable unicode test on mysql Fixing ctor call Adding docker based unit test execution for mysql utf8mb4 Add mysqlmb4 test configuration to Jenkinsfile fix collation on utf8mb4 Properly setup charset and collation in the doctrine connection Allow files containing 4-byte chars in case the database supports it During setup of a mysql database we try to detect if charset 'utf8mb4' can be used Fix mysql settings Add console command to migrate the charset Set ROW_FORMAT before setting collation to mb4 Also select tables with wrong collation Faster MySQL docker Signed-off-by: Morris Jobke <hey@morrisjobke.de>
221 lines
6.8 KiB
PHP
221 lines
6.8 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
*
|
|
* @author Andreas Fischer <bantu@owncloud.com>
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Robin Appelman <robin@icewind.nl>
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
*
|
|
* @license AGPL-3.0
|
|
*
|
|
* This code is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*/
|
|
|
|
namespace OC\DB;
|
|
use Doctrine\Common\EventManager;
|
|
use Doctrine\DBAL\Configuration;
|
|
use Doctrine\DBAL\DriverManager;
|
|
use Doctrine\DBAL\Event\Listeners\OracleSessionInit;
|
|
use Doctrine\DBAL\Event\Listeners\SQLSessionInit;
|
|
use OC\SystemConfig;
|
|
|
|
/**
|
|
* Takes care of creating and configuring Doctrine connections.
|
|
*/
|
|
class ConnectionFactory {
|
|
/**
|
|
* @var array
|
|
*
|
|
* Array mapping DBMS type to default connection parameters passed to
|
|
* \Doctrine\DBAL\DriverManager::getConnection().
|
|
*/
|
|
protected $defaultConnectionParams = [
|
|
'mysql' => [
|
|
'adapter' => '\OC\DB\AdapterMySQL',
|
|
'charset' => 'UTF8',
|
|
'driver' => 'pdo_mysql',
|
|
'wrapperClass' => 'OC\DB\Connection',
|
|
],
|
|
'oci' => [
|
|
'adapter' => '\OC\DB\AdapterOCI8',
|
|
'charset' => 'AL32UTF8',
|
|
'driver' => 'oci8',
|
|
'wrapperClass' => 'OC\DB\OracleConnection',
|
|
],
|
|
'pgsql' => [
|
|
'adapter' => '\OC\DB\AdapterPgSql',
|
|
'driver' => 'pdo_pgsql',
|
|
'wrapperClass' => 'OC\DB\Connection',
|
|
],
|
|
'sqlite3' => [
|
|
'adapter' => '\OC\DB\AdapterSqlite',
|
|
'driver' => 'pdo_sqlite',
|
|
'wrapperClass' => 'OC\DB\Connection',
|
|
],
|
|
];
|
|
|
|
/** @var SystemConfig */
|
|
private $config;
|
|
|
|
/**
|
|
* ConnectionFactory constructor.
|
|
*
|
|
* @param SystemConfig $systemConfig
|
|
*/
|
|
public function __construct(SystemConfig $systemConfig) {
|
|
$this->config = $systemConfig;
|
|
if($this->config->getValue('mysql.utf8mb4', false)) {
|
|
$this->defaultConnectionParams['mysql']['charset'] = 'utf8mb4';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @brief Get default connection parameters for a given DBMS.
|
|
* @param string $type DBMS type
|
|
* @throws \InvalidArgumentException If $type is invalid
|
|
* @return array Default connection parameters.
|
|
*/
|
|
public function getDefaultConnectionParams($type) {
|
|
$normalizedType = $this->normalizeType($type);
|
|
if (!isset($this->defaultConnectionParams[$normalizedType])) {
|
|
throw new \InvalidArgumentException("Unsupported type: $type");
|
|
}
|
|
$result = $this->defaultConnectionParams[$normalizedType];
|
|
// \PDO::MYSQL_ATTR_FOUND_ROWS may not be defined, e.g. when the MySQL
|
|
// driver is missing. In this case, we won't be able to connect anyway.
|
|
if ($normalizedType === 'mysql' && defined('\PDO::MYSQL_ATTR_FOUND_ROWS')) {
|
|
$result['driverOptions'] = array(
|
|
\PDO::MYSQL_ATTR_FOUND_ROWS => true,
|
|
);
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @brief Get default connection parameters for a given DBMS.
|
|
* @param string $type DBMS type
|
|
* @param array $additionalConnectionParams Additional connection parameters
|
|
* @return \OC\DB\Connection
|
|
*/
|
|
public function getConnection($type, $additionalConnectionParams) {
|
|
$normalizedType = $this->normalizeType($type);
|
|
$eventManager = new EventManager();
|
|
switch ($normalizedType) {
|
|
case 'mysql':
|
|
$eventManager->addEventSubscriber(
|
|
new SQLSessionInit("SET SESSION AUTOCOMMIT=1"));
|
|
break;
|
|
case 'oci':
|
|
$eventManager->addEventSubscriber(new OracleSessionInit);
|
|
// the driverOptions are unused in dbal and need to be mapped to the parameters
|
|
if (isset($additionalConnectionParams['driverOptions'])) {
|
|
$additionalConnectionParams = array_merge($additionalConnectionParams, $additionalConnectionParams['driverOptions']);
|
|
}
|
|
break;
|
|
case 'sqlite3':
|
|
$journalMode = $additionalConnectionParams['sqlite.journal_mode'];
|
|
$additionalConnectionParams['platform'] = new OCSqlitePlatform();
|
|
$eventManager->addEventSubscriber(new SQLiteSessionInit(true, $journalMode));
|
|
break;
|
|
}
|
|
/** @var Connection $connection */
|
|
$connection = DriverManager::getConnection(
|
|
array_merge($this->getDefaultConnectionParams($type), $additionalConnectionParams),
|
|
new Configuration(),
|
|
$eventManager
|
|
);
|
|
return $connection;
|
|
}
|
|
|
|
/**
|
|
* @brief Normalize DBMS type
|
|
* @param string $type DBMS type
|
|
* @return string Normalized DBMS type
|
|
*/
|
|
public function normalizeType($type) {
|
|
return $type === 'sqlite' ? 'sqlite3' : $type;
|
|
}
|
|
|
|
/**
|
|
* Checks whether the specified DBMS type is valid.
|
|
*
|
|
* @param string $type
|
|
* @return bool
|
|
*/
|
|
public function isValidType($type) {
|
|
$normalizedType = $this->normalizeType($type);
|
|
return isset($this->defaultConnectionParams[$normalizedType]);
|
|
}
|
|
|
|
/**
|
|
* Create the connection parameters for the config
|
|
*
|
|
* @return array
|
|
*/
|
|
public function createConnectionParams() {
|
|
$type = $this->config->getValue('dbtype', 'sqlite');
|
|
|
|
$connectionParams = [
|
|
'user' => $this->config->getValue('dbuser', ''),
|
|
'password' => $this->config->getValue('dbpassword', ''),
|
|
];
|
|
$name = $this->config->getValue('dbname', 'owncloud');
|
|
|
|
if ($this->normalizeType($type) === 'sqlite3') {
|
|
$dataDir = $this->config->getValue("datadirectory", \OC::$SERVERROOT . '/data');
|
|
$connectionParams['path'] = $dataDir . '/' . $name . '.db';
|
|
} else {
|
|
$host = $this->config->getValue('dbhost', '');
|
|
if (strpos($host, ':')) {
|
|
// Host variable may carry a port or socket.
|
|
list($host, $portOrSocket) = explode(':', $host, 2);
|
|
if (ctype_digit($portOrSocket)) {
|
|
$connectionParams['port'] = $portOrSocket;
|
|
} else {
|
|
$connectionParams['unix_socket'] = $portOrSocket;
|
|
}
|
|
}
|
|
$connectionParams['host'] = $host;
|
|
$connectionParams['dbname'] = $name;
|
|
}
|
|
|
|
$connectionParams['tablePrefix'] = $this->config->getValue('dbtableprefix', 'oc_');
|
|
$connectionParams['sqlite.journal_mode'] = $this->config->getValue('sqlite.journal_mode', 'WAL');
|
|
|
|
//additional driver options, eg. for mysql ssl
|
|
$driverOptions = $this->config->getValue('dbdriveroptions', null);
|
|
if ($driverOptions) {
|
|
$connectionParams['driverOptions'] = $driverOptions;
|
|
}
|
|
|
|
// set default table creation options
|
|
$connectionParams['defaultTableOptions'] = [
|
|
'collate' => 'utf8_bin',
|
|
'tablePrefix' => $connectionParams['tablePrefix']
|
|
];
|
|
|
|
if($this->config->getValue('mysql.utf8mb4', false)) {
|
|
$connectionParams['defaultTableOptions'] = [
|
|
'collate' => 'utf8mb4_bin',
|
|
'charset' => 'utf8mb4',
|
|
'row_format' => 'compressed',
|
|
'tablePrefix' => $connectionParams['tablePrefix']
|
|
];
|
|
}
|
|
|
|
return $connectionParams;
|
|
}
|
|
}
|