2013-04-02 20:01:23 +00:00
|
|
|
<?php
|
2015-03-26 10:44:34 +00:00
|
|
|
/**
|
2016-07-21 15:07:57 +00:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
2016-07-21 15:07:57 +00:00
|
|
|
* @author Joas Schilling <coding@schilljs.com>
|
2016-05-26 17:56:05 +00:00
|
|
|
* @author Manish Bisht <manish.bisht490@gmail.com>
|
2016-07-21 16:13:36 +00:00
|
|
|
* @author Robin Appelman <robin@icewind.nl>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
2016-07-21 15:07:57 +00:00
|
|
|
* @author Thomas Pulzer <t.pulzer@kniel.de>
|
2015-03-26 10:44:34 +00:00
|
|
|
*
|
|
|
|
* @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/>
|
|
|
|
*
|
|
|
|
*/
|
2013-04-02 20:01:23 +00:00
|
|
|
namespace OC\Setup;
|
|
|
|
|
2016-07-12 11:11:44 +00:00
|
|
|
use OC\DB\ConnectionFactory;
|
2017-03-17 22:37:48 +00:00
|
|
|
use OC\SystemConfig;
|
2016-10-28 19:46:28 +00:00
|
|
|
use OCP\IL10N;
|
2015-07-29 22:04:30 +00:00
|
|
|
use OCP\ILogger;
|
|
|
|
use OCP\Security\ISecureRandom;
|
2015-07-29 16:09:23 +00:00
|
|
|
|
2013-04-02 20:01:23 +00:00
|
|
|
abstract class AbstractDatabase {
|
2013-12-02 07:42:28 +00:00
|
|
|
|
2016-10-28 19:46:28 +00:00
|
|
|
/** @var IL10N */
|
2013-04-02 20:01:23 +00:00
|
|
|
protected $trans;
|
2015-07-29 16:09:23 +00:00
|
|
|
/** @var string */
|
2013-06-27 18:19:51 +00:00
|
|
|
protected $dbDefinitionFile;
|
2015-07-29 16:09:23 +00:00
|
|
|
/** @var string */
|
|
|
|
protected $dbUser;
|
|
|
|
/** @var string */
|
|
|
|
protected $dbPassword;
|
|
|
|
/** @var string */
|
|
|
|
protected $dbName;
|
|
|
|
/** @var string */
|
|
|
|
protected $dbHost;
|
|
|
|
/** @var string */
|
2016-07-06 07:58:38 +00:00
|
|
|
protected $dbPort;
|
|
|
|
/** @var string */
|
2015-07-29 16:09:23 +00:00
|
|
|
protected $tablePrefix;
|
2017-03-17 22:37:48 +00:00
|
|
|
/** @var SystemConfig */
|
2015-07-29 16:09:23 +00:00
|
|
|
protected $config;
|
2015-07-29 22:04:30 +00:00
|
|
|
/** @var ILogger */
|
|
|
|
protected $logger;
|
|
|
|
/** @var ISecureRandom */
|
|
|
|
protected $random;
|
2013-04-02 20:01:23 +00:00
|
|
|
|
2017-03-17 22:37:48 +00:00
|
|
|
public function __construct(IL10N $trans, $dbDefinitionFile, SystemConfig $config, ILogger $logger, ISecureRandom $random) {
|
2013-04-02 20:01:23 +00:00
|
|
|
$this->trans = $trans;
|
2013-06-27 18:19:51 +00:00
|
|
|
$this->dbDefinitionFile = $dbDefinitionFile;
|
2015-07-29 16:09:23 +00:00
|
|
|
$this->config = $config;
|
2015-07-29 22:04:30 +00:00
|
|
|
$this->logger = $logger;
|
|
|
|
$this->random = $random;
|
2013-04-03 15:52:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public function validate($config) {
|
|
|
|
$errors = array();
|
2016-03-14 16:00:59 +00:00
|
|
|
if(empty($config['dbuser']) && empty($config['dbname'])) {
|
|
|
|
$errors[] = $this->trans->t("%s enter the database username and name.", array($this->dbprettyname));
|
|
|
|
} else if(empty($config['dbuser'])) {
|
2013-04-03 15:52:18 +00:00
|
|
|
$errors[] = $this->trans->t("%s enter the database username.", array($this->dbprettyname));
|
2016-03-14 16:00:59 +00:00
|
|
|
} else if(empty($config['dbname'])) {
|
2013-04-03 15:52:18 +00:00
|
|
|
$errors[] = $this->trans->t("%s enter the database name.", array($this->dbprettyname));
|
|
|
|
}
|
|
|
|
if(substr_count($config['dbname'], '.') >= 1) {
|
|
|
|
$errors[] = $this->trans->t("%s you may not use dots in the database name", array($this->dbprettyname));
|
|
|
|
}
|
|
|
|
return $errors;
|
2013-04-02 20:01:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public function initialize($config) {
|
2015-01-26 11:59:25 +00:00
|
|
|
$dbUser = $config['dbuser'];
|
|
|
|
$dbPass = $config['dbpass'];
|
|
|
|
$dbName = $config['dbname'];
|
|
|
|
$dbHost = !empty($config['dbhost']) ? $config['dbhost'] : 'localhost';
|
2016-07-06 07:58:38 +00:00
|
|
|
$dbPort = !empty($config['dbport']) ? $config['dbport'] : '';
|
2015-01-26 11:59:25 +00:00
|
|
|
$dbTablePrefix = isset($config['dbtableprefix']) ? $config['dbtableprefix'] : 'oc_';
|
2013-04-02 20:01:23 +00:00
|
|
|
|
2017-03-17 22:37:48 +00:00
|
|
|
$this->config->setValues([
|
2015-01-26 11:59:25 +00:00
|
|
|
'dbname' => $dbName,
|
|
|
|
'dbhost' => $dbHost,
|
2016-07-06 07:58:38 +00:00
|
|
|
'dbport' => $dbPort,
|
2015-01-26 11:59:25 +00:00
|
|
|
'dbtableprefix' => $dbTablePrefix,
|
2015-01-23 10:13:47 +00:00
|
|
|
]);
|
2013-04-02 20:01:23 +00:00
|
|
|
|
2015-07-29 16:09:23 +00:00
|
|
|
$this->dbUser = $dbUser;
|
|
|
|
$this->dbPassword = $dbPass;
|
|
|
|
$this->dbName = $dbName;
|
|
|
|
$this->dbHost = $dbHost;
|
2016-07-06 07:58:38 +00:00
|
|
|
$this->dbPort = $dbPort;
|
2015-07-29 16:09:23 +00:00
|
|
|
$this->tablePrefix = $dbTablePrefix;
|
2013-04-02 20:01:23 +00:00
|
|
|
}
|
2015-01-26 11:59:25 +00:00
|
|
|
|
2016-07-12 11:11:44 +00:00
|
|
|
/**
|
2016-07-12 11:50:54 +00:00
|
|
|
* @param array $configOverwrite
|
2016-07-12 11:11:44 +00:00
|
|
|
* @return \OC\DB\Connection
|
|
|
|
*/
|
2016-07-12 11:50:54 +00:00
|
|
|
protected function connect(array $configOverwrite = []) {
|
2016-07-26 09:44:15 +00:00
|
|
|
$connectionParams = array(
|
|
|
|
'host' => $this->dbHost,
|
|
|
|
'user' => $this->dbUser,
|
|
|
|
'password' => $this->dbPassword,
|
|
|
|
'tablePrefix' => $this->tablePrefix,
|
2016-07-21 10:44:02 +00:00
|
|
|
'dbname' => $this->dbName
|
2016-07-26 09:44:15 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
// adding port support through installer
|
|
|
|
if (!empty($this->dbPort)) {
|
|
|
|
if (ctype_digit($this->dbPort)) {
|
|
|
|
$connectionParams['port'] = $this->dbPort;
|
|
|
|
} else {
|
|
|
|
$connectionParams['unix_socket'] = $this->dbPort;
|
|
|
|
}
|
|
|
|
} else if (strpos($this->dbHost, ':')) {
|
|
|
|
// Host variable may carry a port or socket.
|
|
|
|
list($host, $portOrSocket) = explode(':', $this->dbHost, 2);
|
|
|
|
if (ctype_digit($portOrSocket)) {
|
|
|
|
$connectionParams['port'] = $portOrSocket;
|
|
|
|
} else {
|
|
|
|
$connectionParams['unix_socket'] = $portOrSocket;
|
|
|
|
}
|
|
|
|
$connectionParams['host'] = $host;
|
2016-07-12 11:11:44 +00:00
|
|
|
}
|
2016-07-26 09:44:15 +00:00
|
|
|
|
2016-07-12 11:50:54 +00:00
|
|
|
$connectionParams = array_merge($connectionParams, $configOverwrite);
|
2016-02-09 16:25:12 +00:00
|
|
|
$cf = new ConnectionFactory($this->config);
|
2017-03-17 22:37:48 +00:00
|
|
|
return $cf->getConnection($this->config->getValue('dbtype', 'sqlite'), $connectionParams);
|
2016-07-12 11:11:44 +00:00
|
|
|
}
|
|
|
|
|
2016-02-08 15:43:39 +00:00
|
|
|
/**
|
|
|
|
* @param string $userName
|
|
|
|
*/
|
2015-01-26 11:59:25 +00:00
|
|
|
abstract public function setupDatabase($userName);
|
2013-04-02 20:01:23 +00:00
|
|
|
}
|