Spaces:
No application file
No application file
File size: 16,222 Bytes
d2897cd |
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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 |
<?php
declare(strict_types=1);
namespace Mautic\InstallBundle\Command;
use Doctrine\Persistence\ManagerRegistry;
use Mautic\InstallBundle\Configurator\Step\CheckStep;
use Mautic\InstallBundle\Configurator\Step\DoctrineStep;
use Mautic\InstallBundle\Install\InstallService;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
/**
* CLI Command to install Mautic.
*/
class InstallCommand extends Command
{
public const COMMAND = 'mautic:install';
public function __construct(
private InstallService $installer,
private ManagerRegistry $doctrineRegistry
) {
parent::__construct();
}
/**
* Note: in every option (addOption()), please leave the default value empty to prevent problems with values from local.php being overwritten.
*/
protected function configure()
{
$this
->setName(self::COMMAND)
->setHelp('This command allows you to trigger the install process. It will try to get configuration values both from the local config file and command line options/arguments, where the latter takes precedence.')
->addArgument(
'site_url',
InputArgument::REQUIRED,
'Site URL.',
null
)
->addArgument(
'step',
InputArgument::OPTIONAL,
'Install process start index. 0 for requirements check, 1 for database, 2 for admin, 3 for configuration, 4 for final step. Each successful step will trigger the next until completion.',
0
)
->addOption(
'--force',
'-f',
InputOption::VALUE_NONE,
'Do not ask confirmation if recommendations triggered.',
null
)
->addOption(
'--db_driver',
null,
InputOption::VALUE_REQUIRED,
'Database driver.',
null
)
->addOption(
'--db_host',
null,
InputOption::VALUE_REQUIRED,
'Database host.',
null
)
->addOption(
'--db_port',
null,
InputOption::VALUE_REQUIRED,
'Database port.',
null
)
->addOption(
'--db_name',
null,
InputOption::VALUE_REQUIRED,
'Database name.',
null
)
->addOption(
'--db_user',
null,
InputOption::VALUE_REQUIRED,
'Database user.',
null
)
->addOption(
'--db_password',
null,
InputOption::VALUE_REQUIRED,
'Database password.',
null
)
->addOption(
'--db_table_prefix',
null,
InputOption::VALUE_REQUIRED,
'Database tables prefix.',
null
)
->addOption(
'--db_backup_tables',
null,
InputOption::VALUE_REQUIRED,
'Backup database tables if they exist; otherwise drop them. (true|false)',
null
)
->addOption(
'--db_backup_prefix',
null,
InputOption::VALUE_REQUIRED,
'Database backup tables prefix.',
null
)
->addOption(
'--admin_firstname',
null,
InputOption::VALUE_REQUIRED,
'Admin first name.',
null
)
->addOption(
'--admin_lastname',
null,
InputOption::VALUE_REQUIRED,
'Admin last name.',
null
)
->addOption(
'--admin_username',
null,
InputOption::VALUE_REQUIRED,
'Admin username.',
null
)
->addOption(
'--admin_email',
null,
InputOption::VALUE_REQUIRED,
'Admin email.',
null
)
->addOption(
'--admin_password',
null,
InputOption::VALUE_REQUIRED,
'Admin user.',
null
);
parent::configure();
}
protected function execute(InputInterface $input, OutputInterface $output): int
{
// Check Mautic is not already installed
if ($this->installer->checkIfInstalled()) {
$output->writeln('Mautic already installed');
return Command::SUCCESS;
}
$output->writeln([
'Mautic Install',
'==============',
'',
]);
if (!defined('IS_PHPUNIT')) {
// Prevents querying of database tables that do not exist during the installation process
define('MAUTIC_INSTALLER', 1);
}
// Build objects to pass to the install service from local.php or command line options
$output->writeln('Parsing options and arguments...');
$options = $input->getOptions();
// Convert boolean options to actual booleans.
$options['db_backup_tables'] = (bool) filter_var($options['db_backup_tables'], FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
/**
* We need to have some default database parameters, as it could be the case that the
* user didn't set them both in local.php and the command line options.
*/
$dbParams = [
'driver' => 'pdo_mysql',
'host' => null,
'port' => null,
'name' => null,
'user' => null,
'password' => null,
'table_prefix' => null,
'backup_tables' => true,
'backup_prefix' => 'bak_',
];
$adminParam = [
'firstname' => 'Admin',
'lastname' => 'Mautic',
'username' => 'admin',
];
$allParams = $this->installer->localConfigParameters();
// Initialize DB and admin params from local.php
foreach ((array) $allParams as $opt => $value) {
if (str_starts_with($opt, 'db_')) {
$dbParams[substr($opt, 3)] = $value;
} elseif (str_starts_with($opt, 'admin_')) {
$adminParam[substr($opt, 6)] = $value;
}
}
// Initialize DB and admin params from cli options
foreach ($options as $opt => $value) {
if (isset($value)) {
if (str_starts_with($opt, 'db_')) {
$dbParams[substr($opt, 3)] = $value;
$allParams[$opt] = $value;
} elseif (str_starts_with($opt, 'admin_')) {
$adminParam[substr($opt, 6)] = $value;
}
}
}
if (!empty($allParams['site_url'])) {
$siteUrl = $allParams['site_url'];
} else {
$siteUrl = $input->getArgument('site_url');
$allParams['site_url'] = $siteUrl;
}
$step = (float) $input->getArgument('step');
switch ($step) {
default:
case InstallService::CHECK_STEP:
$output->writeln($step.' - Checking installation requirements...');
$messages = $this->stepAction($this->installer, ['site_url' => $siteUrl], $step);
if (!empty($messages)) {
if (isset($messages['requirements']) && !empty($messages['requirements'])) {
// Stop install if requirements not met
$output->writeln('Missing requirements:');
$this->handleInstallerErrors($output, $messages['requirements']);
$output->writeln('Install canceled');
return (int) -$step;
} elseif (isset($messages['optional']) && !empty($messages['optional'])) {
$output->writeln('Missing optional settings:');
$this->handleInstallerErrors($output, $messages['optional']);
if (empty($options['force'])) {
// Ask user to confirm install when optional settings missing
/** @var QuestionHelper $helper */
$helper = $this->getHelper('question');
$question = new ConfirmationQuestion('Continue with install anyway? [yes/no]', false);
if (!$helper->ask($input, $output, $question)) {
return (int) -$step;
}
}
}
}
$output->writeln('Ready to Install!');
// Keep on with next step
$step = InstallService::DOCTRINE_STEP;
// no break
case InstallService::DOCTRINE_STEP:
$output->writeln($step.' - Creating database...');
/**
* This is needed for installations with database prefixes to work correctly.
*/
$connectionWrapper = $this->doctrineRegistry->getConnection();
$connectionWrapper->initConnection($dbParams);
$messages = $this->stepAction($this->installer, $dbParams, $step);
if (!empty($messages)) {
$output->writeln('Errors in database configuration/installation:');
$this->handleInstallerErrors($output, $messages);
$output->writeln('Install canceled');
return (int) -$step;
}
$step = InstallService::DOCTRINE_STEP + .1;
$output->writeln($step.' - Creating schema...');
$messages = $this->stepAction($this->installer, $dbParams, $step);
if (!empty($messages)) {
$output->writeln('Errors in schema configuration/installation:');
$this->handleInstallerErrors($output, $messages);
$output->writeln('Install canceled');
return -InstallService::DOCTRINE_STEP;
}
$step = InstallService::DOCTRINE_STEP + .2;
$output->writeln($step.' - Loading fixtures...');
$messages = $this->stepAction($this->installer, $dbParams, $step);
if (!empty($messages)) {
$output->writeln('Errors in fixtures configuration/installation:');
$this->handleInstallerErrors($output, $messages);
$output->writeln('Install canceled');
return -InstallService::DOCTRINE_STEP;
}
// Keep on with next step
$step = InstallService::USER_STEP;
// no break
case InstallService::USER_STEP:
$output->writeln($step.' - Creating admin user...');
$messages = $this->stepAction($this->installer, $adminParam, $step);
if (!empty($messages)) {
$output->writeln('Errors in admin user configuration/installation:');
$this->handleInstallerErrors($output, $messages);
$output->writeln('Install canceled');
return (int) -$step;
}
// Keep on with next step
$step = InstallService::FINAL_STEP;
// no break
case InstallService::FINAL_STEP:
$output->writeln($step.' - Final steps...');
$messages = $this->stepAction($this->installer, $allParams, $step);
if (!empty($messages)) {
$output->writeln('Errors in final step:');
$this->handleInstallerErrors($output, $messages);
$output->writeln('Install canceled');
return (int) -$step;
}
}
$output->writeln([
'',
'================',
'Install complete',
'================',
]);
return Command::SUCCESS;
}
/**
* Controller action for install steps.
*
* @param InstallService $installer The install process
* @param array $params The install parameters
* @param float $index The step number to process
*
* @throws \Exception
*/
protected function stepAction(InstallService $installer, array $params, float $index = 0): array
{
if ($index - floor($index) > 0) {
$subIndex = (int) (round($index - floor($index), 1) * 10);
$index = floor($index);
}
$index = (int) $index;
$messages = [];
switch ($index) {
case InstallService::CHECK_STEP:
// Check installation requirements
$step = $installer->getStep($index);
if ($step instanceof CheckStep) {
// Set all step fields based on parameters
$step->site_url = $params['site_url'];
}
$messages['requirements'] = $installer->checkRequirements($step);
$messages['optional'] = $installer->checkOptionalSettings($step);
break;
case InstallService::DOCTRINE_STEP:
$step = $installer->getStep($index);
if ($step instanceof DoctrineStep) {
// Set all step fields based on parameters
foreach ($step as $key => $value) {
if (isset($params[$key])) {
$step->$key = $params[$key];
}
}
}
if (!isset($subIndex)) {
// Install database
$messages = $installer->createDatabaseStep($step, $params);
break;
}
switch ($subIndex) {
case 1:
// Install schema
$messages = $installer->createSchemaStep($params);
break;
case 2:
// Install fixtures
$messages = $installer->createFixturesStep();
break;
}
break;
case InstallService::USER_STEP:
// Create admin user
$messages = $installer->createAdminUserStep($params);
break;
case InstallService::FINAL_STEP:
// Save final configuration
$siteUrl = $params['site_url'];
$messages = $installer->createFinalConfigStep($siteUrl);
if (empty($messages)) {
$installer->finalMigrationStep();
}
break;
}
return $messages;
}
/**
* Handle install command errors.
*
* @param array<string,string> $messages
*/
private function handleInstallerErrors(OutputInterface $output, array $messages): void
{
foreach ($messages as $type => $message) {
$output->writeln(" - [$type] $message");
}
}
protected static $defaultDescription = 'Installs Mautic';
}
|