386 lines
9.4 KiB
PHP
386 lines
9.4 KiB
PHP
<?php
|
|
/**
|
|
* The DbConfig Task handles creating and updating the database.php
|
|
*
|
|
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
|
|
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
|
*
|
|
* Licensed under The MIT License
|
|
* For full copyright and license information, please see the LICENSE.txt
|
|
* Redistributions of files must retain the above copyright notice.
|
|
*
|
|
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
|
* @link https://cakephp.org CakePHP(tm) Project
|
|
* @since CakePHP(tm) v 1.2
|
|
* @license https://opensource.org/licenses/mit-license.php MIT License
|
|
*/
|
|
|
|
App::uses('AppShell', 'Console/Command');
|
|
|
|
/**
|
|
* Task class for creating and updating the database configuration file.
|
|
*
|
|
* @package Cake.Console.Command.Task
|
|
*/
|
|
class DbConfigTask extends AppShell {
|
|
|
|
/**
|
|
* path to CONFIG directory
|
|
*
|
|
* @var string
|
|
*/
|
|
public $path = null;
|
|
|
|
/**
|
|
* Default configuration settings to use
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_defaultConfig = array(
|
|
'name' => 'default',
|
|
'datasource' => 'Database/Mysql',
|
|
'persistent' => 'false',
|
|
'host' => 'localhost',
|
|
'login' => 'root',
|
|
'password' => 'password',
|
|
'database' => 'project_name',
|
|
'schema' => null,
|
|
'prefix' => null,
|
|
'encoding' => null,
|
|
'port' => null
|
|
);
|
|
|
|
/**
|
|
* String name of the database config class name.
|
|
* Used for testing.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $databaseClassName = 'DATABASE_CONFIG';
|
|
|
|
/**
|
|
* initialization callback
|
|
*
|
|
* @return void
|
|
*/
|
|
public function initialize() {
|
|
$this->path = CONFIG;
|
|
}
|
|
|
|
/**
|
|
* Execution method always used for tasks
|
|
*
|
|
* @return void
|
|
*/
|
|
public function execute() {
|
|
if (empty($this->args)) {
|
|
$this->_interactive();
|
|
return $this->_stop();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Interactive interface
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function _interactive() {
|
|
$this->hr();
|
|
$this->out(__d('cake_console', 'Database Configuration:'));
|
|
$this->hr();
|
|
$done = false;
|
|
$dbConfigs = array();
|
|
|
|
while (!$done) {
|
|
$name = '';
|
|
|
|
while (!$name) {
|
|
$name = $this->in(__d('cake_console', "Name:"), null, 'default');
|
|
if (preg_match('/[^a-z0-9_]/i', $name)) {
|
|
$name = '';
|
|
$this->out(__d('cake_console', 'The name may only contain unaccented latin characters, numbers or underscores'));
|
|
} elseif (preg_match('/^[^a-z_]/i', $name)) {
|
|
$name = '';
|
|
$this->out(__d('cake_console', 'The name must start with an unaccented latin character or an underscore'));
|
|
}
|
|
}
|
|
|
|
$datasource = $this->in(__d('cake_console', 'Datasource:'), array('Mysql', 'Postgres', 'Sqlite', 'Sqlserver'), 'Mysql');
|
|
|
|
$persistent = $this->in(__d('cake_console', 'Persistent Connection?'), array('y', 'n'), 'n');
|
|
if (strtolower($persistent) === 'n') {
|
|
$persistent = 'false';
|
|
} else {
|
|
$persistent = 'true';
|
|
}
|
|
|
|
$host = '';
|
|
while (!$host) {
|
|
$host = $this->in(__d('cake_console', 'Database Host:'), null, 'localhost');
|
|
}
|
|
|
|
$port = '';
|
|
while (!$port) {
|
|
$port = $this->in(__d('cake_console', 'Port?'), null, 'n');
|
|
}
|
|
|
|
if (strtolower($port) === 'n') {
|
|
$port = null;
|
|
}
|
|
|
|
$login = '';
|
|
while (!$login) {
|
|
$login = $this->in(__d('cake_console', 'User:'), null, 'root');
|
|
}
|
|
$password = '';
|
|
$blankPassword = false;
|
|
|
|
while (!$password && !$blankPassword) {
|
|
$password = $this->in(__d('cake_console', 'Password:'));
|
|
|
|
if (!$password) {
|
|
$blank = $this->in(__d('cake_console', 'The password you supplied was empty. Use an empty password?'), array('y', 'n'), 'n');
|
|
if ($blank === 'y') {
|
|
$blankPassword = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
$database = '';
|
|
while (!$database) {
|
|
$database = $this->in(__d('cake_console', 'Database Name:'), null, 'cake');
|
|
}
|
|
|
|
$prefix = '';
|
|
while (!$prefix) {
|
|
$prefix = $this->in(__d('cake_console', 'Table Prefix?'), null, 'n');
|
|
}
|
|
if (strtolower($prefix) === 'n') {
|
|
$prefix = null;
|
|
}
|
|
|
|
$encoding = '';
|
|
while (!$encoding) {
|
|
$encoding = $this->in(__d('cake_console', 'Table encoding?'), null, 'n');
|
|
}
|
|
if (strtolower($encoding) === 'n') {
|
|
$encoding = null;
|
|
}
|
|
|
|
$schema = '';
|
|
if ($datasource === 'postgres') {
|
|
while (!$schema) {
|
|
$schema = $this->in(__d('cake_console', 'Table schema?'), null, 'n');
|
|
}
|
|
}
|
|
if (strtolower($schema) === 'n') {
|
|
$schema = null;
|
|
}
|
|
|
|
$config = compact('name', 'datasource', 'persistent', 'host', 'login', 'password', 'database', 'prefix', 'encoding', 'port', 'schema');
|
|
|
|
while (!$this->_verify($config)) {
|
|
$this->_interactive();
|
|
}
|
|
|
|
$dbConfigs[] = $config;
|
|
$doneYet = $this->in(__d('cake_console', 'Do you wish to add another database configuration?'), null, 'n');
|
|
|
|
if (strtolower($doneYet === 'n')) {
|
|
$done = true;
|
|
}
|
|
}
|
|
|
|
$this->bake($dbConfigs);
|
|
config('database');
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Output verification message and bake if it looks good
|
|
*
|
|
* @param array $config The config data.
|
|
* @return bool True if user says it looks good, false otherwise
|
|
*/
|
|
protected function _verify($config) {
|
|
$config += $this->_defaultConfig;
|
|
extract($config);
|
|
$this->out();
|
|
$this->hr();
|
|
$this->out(__d('cake_console', 'The following database configuration will be created:'));
|
|
$this->hr();
|
|
$this->out(__d('cake_console', "Name: %s", $name));
|
|
$this->out(__d('cake_console', "Datasource: %s", $datasource));
|
|
$this->out(__d('cake_console', "Persistent: %s", $persistent));
|
|
$this->out(__d('cake_console', "Host: %s", $host));
|
|
|
|
if ($port) {
|
|
$this->out(__d('cake_console', "Port: %s", $port));
|
|
}
|
|
|
|
$this->out(__d('cake_console', "User: %s", $login));
|
|
$this->out(__d('cake_console', "Pass: %s", str_repeat('*', strlen($password))));
|
|
$this->out(__d('cake_console', "Database: %s", $database));
|
|
|
|
if ($prefix) {
|
|
$this->out(__d('cake_console', "Table prefix: %s", $prefix));
|
|
}
|
|
|
|
if ($schema) {
|
|
$this->out(__d('cake_console', "Schema: %s", $schema));
|
|
}
|
|
|
|
if ($encoding) {
|
|
$this->out(__d('cake_console', "Encoding: %s", $encoding));
|
|
}
|
|
|
|
$this->hr();
|
|
$looksGood = $this->in(__d('cake_console', 'Look okay?'), array('y', 'n'), 'y');
|
|
|
|
if (strtolower($looksGood) === 'y') {
|
|
return $config;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Assembles and writes database.php
|
|
*
|
|
* @param array $configs Configuration settings to use
|
|
* @return bool Success
|
|
*/
|
|
public function bake($configs) {
|
|
if (!is_dir($this->path)) {
|
|
$this->err(__d('cake_console', '%s not found', $this->path));
|
|
return false;
|
|
}
|
|
|
|
$filename = $this->path . 'database.php';
|
|
$oldConfigs = array();
|
|
|
|
if (file_exists($filename)) {
|
|
config('database');
|
|
$db = new $this->databaseClassName;
|
|
$temp = get_class_vars(get_class($db));
|
|
|
|
foreach ($temp as $configName => $info) {
|
|
$info += $this->_defaultConfig;
|
|
|
|
if (!isset($info['schema'])) {
|
|
$info['schema'] = null;
|
|
}
|
|
if (!isset($info['encoding'])) {
|
|
$info['encoding'] = null;
|
|
}
|
|
if (!isset($info['port'])) {
|
|
$info['port'] = null;
|
|
}
|
|
|
|
$info['persistent'] = var_export((bool)$info['persistent'], true);
|
|
|
|
$oldConfigs[] = array(
|
|
'name' => $configName,
|
|
'datasource' => $info['datasource'],
|
|
'persistent' => $info['persistent'],
|
|
'host' => $info['host'],
|
|
'port' => $info['port'],
|
|
'login' => $info['login'],
|
|
'password' => $info['password'],
|
|
'database' => $info['database'],
|
|
'prefix' => $info['prefix'],
|
|
'schema' => $info['schema'],
|
|
'encoding' => $info['encoding']
|
|
);
|
|
}
|
|
}
|
|
|
|
foreach ($oldConfigs as $key => $oldConfig) {
|
|
foreach ($configs as $config) {
|
|
if ($oldConfig['name'] === $config['name']) {
|
|
unset($oldConfigs[$key]);
|
|
}
|
|
}
|
|
}
|
|
|
|
$configs = array_merge($oldConfigs, $configs);
|
|
$out = "<?php\n";
|
|
$out .= "class DATABASE_CONFIG {\n\n";
|
|
|
|
foreach ($configs as $config) {
|
|
$config += $this->_defaultConfig;
|
|
extract($config);
|
|
|
|
if (strpos($datasource, 'Database/') === false) {
|
|
$datasource = "Database/{$datasource}";
|
|
}
|
|
$out .= "\tpublic \${$name} = array(\n";
|
|
$out .= "\t\t'datasource' => '{$datasource}',\n";
|
|
$out .= "\t\t'persistent' => {$persistent},\n";
|
|
$out .= "\t\t'host' => '{$host}',\n";
|
|
|
|
if ($port) {
|
|
$out .= "\t\t'port' => {$port},\n";
|
|
}
|
|
|
|
$out .= "\t\t'login' => '{$login}',\n";
|
|
$out .= "\t\t'password' => '{$password}',\n";
|
|
$out .= "\t\t'database' => '{$database}',\n";
|
|
|
|
if ($schema) {
|
|
$out .= "\t\t'schema' => '{$schema}',\n";
|
|
}
|
|
|
|
if ($prefix) {
|
|
$out .= "\t\t'prefix' => '{$prefix}',\n";
|
|
}
|
|
|
|
if ($encoding) {
|
|
$out .= "\t\t'encoding' => '{$encoding}'\n";
|
|
}
|
|
|
|
$out .= "\t);\n";
|
|
}
|
|
|
|
$out .= "}\n";
|
|
$filename = $this->path . 'database.php';
|
|
return $this->createFile($filename, $out);
|
|
}
|
|
|
|
/**
|
|
* Get a user specified Connection name
|
|
*
|
|
* @return void
|
|
*/
|
|
public function getConfig() {
|
|
App::uses('ConnectionManager', 'Model');
|
|
$configs = ConnectionManager::enumConnectionObjects();
|
|
|
|
$useDbConfig = key($configs);
|
|
if (!is_array($configs) || empty($configs)) {
|
|
return $this->execute();
|
|
}
|
|
$connections = array_keys($configs);
|
|
|
|
if (count($connections) > 1) {
|
|
$useDbConfig = $this->in(__d('cake_console', 'Use Database Config') . ':', $connections, $useDbConfig);
|
|
}
|
|
return $useDbConfig;
|
|
}
|
|
|
|
/**
|
|
* Gets the option parser instance and configures it.
|
|
*
|
|
* @return ConsoleOptionParser
|
|
*/
|
|
public function getOptionParser() {
|
|
$parser = parent::getOptionParser();
|
|
|
|
$parser->description(
|
|
__d('cake_console', 'Bake new database configuration settings.')
|
|
);
|
|
|
|
return $parser;
|
|
}
|
|
|
|
}
|