1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
<?php
/**
* UserFrosting (http://www.userfrosting.com)
*
* @link https://github.com/userfrosting/UserFrosting
* @license https://github.com/userfrosting/UserFrosting/blob/master/licenses/UserFrosting.md (MIT License)
*/
namespace UserFrosting\System\Bakery\Command;
use Illuminate\Database\Capsule\Manager as Capsule;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use UserFrosting\System\Bakery\BaseCommand;
/**
* Setup wizard CLI Tools.
* Helper command to setup .env file
*
* @author Alex Weissman (https://alexanderweissman.com)
*/
class Setup extends BaseCommand
{
/**
* envfile path
*/
protected $envPath = \UserFrosting\APP_DIR. '/.env';
/**
* {@inheritDoc}
*/
protected function configure()
{
$this->setName("setup")
->setDescription("UserFrosting configuration wizard")
->setHelp("Helper command to setup the database and email configuration. This can also be done manually by editing the <comment>app/.env</comment> file or using global server environment variables.")
->addOption("force", "f", InputOption::VALUE_NONE, "If `.env` file exist, force setup to run again");
}
/**
* {@inheritDoc}
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
// Get config
$config = $this->ci->config;
// Get options
$force = $input->getOption('force');
// Display header,
$this->io->title("UserFrosting's Setup Wizard");
// Check if the .env file exist.
if (!$force && file_exists($this->envPath)) {
$this->io->note("File `{$this->envPath}` already exist. Use the `php bakery setup -f` command to force setup to run again.");
return;
}
// There might not be any `.env` file because there may be some custom config or global env values defined on the server.
// We'll check for that. If the configs are empty, we'll assume nothing is defined and go strait to setup.
if (!$force && $config["db.default.host"] != "" && $config["db.default.database"] != "" && $config["db.default.username"] != "") {
$this->io->note("File `{$this->envPath}` was not found, but some database configuration variables are present. Global system environment variables might be defined. If this is not right, use -f option to force setup to run.");
return;
}
//Goto setup
$this->setupEnv();
}
/**
* Setup the `.env` file.
*
* @access public
* @return void
*/
public function setupEnv()
{
// Get config
$config = $this->ci->config;
// Get the db driver choices
$drivers = $this->databaseDrivers();
// Ask the questions
$this->io->section("Setting up database");
$this->io->note("Database credentials will be saved in `app/.env`");
$driver = $this->io->choice("Database type", $drivers->pluck('name')->toArray());
$driver = $drivers->where('name', $driver)->first();
$driverName = $driver['driver'];
$defaultDBName = $driver['defaultDBName'];
if ($driverName == 'sqlite') {
$name = $this->io->ask("Database name", $defaultDBName);
$dbParams = [
'driver' => $driverName,
'database' => $name
];
} else {
$defaultPort = $driver['defaultPort'];
$host = $this->io->ask("Hostname", "localhost");
$port = $this->io->ask("Port", $defaultPort);
$name = $this->io->ask("Database name", $defaultDBName);
$user = $this->io->ask("Username", "userfrosting");
$password = $this->io->askHidden("Password", function ($password) {
// Use custom validator to accept empty password
return $password;
});
$dbParams = [
'driver' => $driverName,
'host' => $host,
'port' => $port,
'database' => $name,
'username' => $user,
'password' => $password,
'charset' => $config['db.default.charset']
];
}
// Setup a new db connection
$capsule = new Capsule;
$capsule->addConnection($dbParams);
// Test the db connexion.
try {
$conn = $capsule->getConnection();
$conn->getPdo();
$this->io->success("Database connection successful");
$success = true;
} catch (\PDOException $e) {
$message = "Could not connect to the database '{$dbParams['username']}@{$dbParams['host']}/{$dbParams['database']}':".PHP_EOL;
$message .= "Exception: " . $e->getMessage() . PHP_EOL.PHP_EOL;
$message .= "Please check your database configuration and/or google the exception shown above and run the command again.";
$this->io->error($message);
exit(1);
}
// Ask for the smtp values now
$this->io->section("Enter your SMTP credentials");
$this->io->write("This is used to send emails from the system. Edit `app/.env` if you have problems with this later.");
$smtpHost = $this->io->ask("SMTP Host", "host.example.com");
$smtpUser = $this->io->ask("SMTP User", "relay@example.com");
$smtpPassword = $this->io->askHidden("SMTP Password", function ($password) {
// Use custom validator to accept empty password
return $password;
});
if ($driverName == 'sqlite') {
$fileContent = [
"UF_MODE=\"\"\n",
"DB_DRIVER=\"{$dbParams['driver']}\"\n",
"DB_NAME=\"{$dbParams['database']}\"\n",
"SMTP_HOST=\"$smtpHost\"\n",
"SMTP_USER=\"$smtpUser\"\n",
"SMTP_PASSWORD=\"$smtpPassword\"\n"
];
} else {
$fileContent = [
"UF_MODE=\"\"\n",
"DB_DRIVER=\"{$dbParams['driver']}\"\n",
"DB_HOST=\"{$dbParams['host']}\"\n",
"DB_PORT=\"{$dbParams['port']}\"\n",
"DB_NAME=\"{$dbParams['database']}\"\n",
"DB_USER=\"{$dbParams['username']}\"\n",
"DB_PASSWORD=\"{$dbParams['password']}\"\n",
"SMTP_HOST=\"$smtpHost\"\n",
"SMTP_USER=\"$smtpUser\"\n",
"SMTP_PASSWORD=\"$smtpPassword\"\n"
];
}
// Let's save this config
file_put_contents($this->envPath, $fileContent);
// At this point, `$this->uf` is still using the old configs.
// We need to refresh the `db.default` config values
$newConfig = array_merge($config['db.default'], $dbParams);
$this->ci->config->set("db.default", $newConfig);
}
/**
* Return the database choices for the env setup.
*
* @access protected
* @return void
*/
protected function databaseDrivers()
{
return collect([
[
"driver" => "mysql",
"name" => "MySQL / MariaDB",
"defaultDBName" => "userfrosting",
"defaultPort" => 3306
],
[
"driver" => "pgsql",
"name" => "ProgreSQL",
"defaultDBName" => "userfrosting",
"defaultPort" => 5432
],
[
"driver" => "sqlsrv",
"name" => "SQL Server",
"defaultDBName" => "userfrosting",
"defaultPort" => 1433
],
[
"driver" => "sqlite",
"name" => "SQLite",
"defaultDBName" => \UserFrosting\DB_DIR . \UserFrosting\DS . 'userfrosting.db',
"defaultPort" => null
]
]);
}
}
|
