X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=src%2FWallabag%2FCoreBundle%2FCommand%2FInstallCommand.php;h=8a2439ec7ebb6c3ec242dd3b29eb40c3b5614ba0;hb=1953a872932a63792293b4aec087880265ba89f7;hp=ac7583ea7f7d74770a9fca4761dd6ba207fa9f71;hpb=732c2ad8971f427ec196acfac53dad034cefdef4;p=github%2Fwallabag%2Fwallabag.git diff --git a/src/Wallabag/CoreBundle/Command/InstallCommand.php b/src/Wallabag/CoreBundle/Command/InstallCommand.php index ac7583ea..877dbfa2 100644 --- a/src/Wallabag/CoreBundle/Command/InstallCommand.php +++ b/src/Wallabag/CoreBundle/Command/InstallCommand.php @@ -2,14 +2,17 @@ namespace Wallabag\CoreBundle\Command; +use Craue\ConfigBundle\Entity\Setting; +use FOS\UserBundle\Event\UserEvent; +use FOS\UserBundle\FOSUserEvents; use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand; +use Symfony\Component\Console\Input\ArrayInput; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; -use Symfony\Component\Console\Input\ArrayInput; +use Symfony\Component\Console\Output\BufferedOutput; use Symfony\Component\Console\Output\OutputInterface; -use Symfony\Component\Console\Output\NullOutput; -use Wallabag\CoreBundle\Entity\User; -use Wallabag\CoreBundle\Entity\Config; +use Symfony\Component\Console\Question\Question; +use Symfony\Component\Console\Style\SymfonyStyle; class InstallCommand extends ContainerAwareCommand { @@ -19,15 +22,23 @@ class InstallCommand extends ContainerAwareCommand protected $defaultInput; /** - * @var OutputInterface + * @var SymfonyStyle + */ + protected $io; + + /** + * @var array */ - protected $defaultOutput; + protected $functionExists = [ + 'curl_exec', + 'curl_multi_init', + ]; protected function configure() { $this ->setName('wallabag:install') - ->setDescription('Wallabag installer.') + ->setDescription('wallabag installer.') ->addOption( 'reset', null, @@ -40,86 +51,144 @@ class InstallCommand extends ContainerAwareCommand protected function execute(InputInterface $input, OutputInterface $output) { $this->defaultInput = $input; - $this->defaultOutput = $output; - $output->writeln('Installing Wallabag...'); - $output->writeln(''); + $this->io = new SymfonyStyle($input, $output); + + $this->io->title('Wallabag installer'); $this ->checkRequirements() ->setupDatabase() ->setupAdmin() - ->setupAsset() + ->setupConfig() + ->runMigrations() ; - $output->writeln('Wallabag has been successfully installed.'); - $output->writeln('Just execute `php app/console server:run` for using wallabag: http://localhost:8000'); + $this->io->success('Wallabag has been successfully installed.'); + $this->io->note('Just execute `php bin/console server:run --env=prod` for using wallabag: http://localhost:8000'); } protected function checkRequirements() { - $this->defaultOutput->writeln('Step 1 of 4. Checking system requirements.'); + $this->io->section('Step 1 of 5: Checking system requirements.'); + + $doctrineManager = $this->getContainer()->get('doctrine')->getManager(); + + $rows = []; + // testing if database driver exists $fulfilled = true; + $label = 'PDO Driver (%s)'; + $status = 'OK!'; + $help = ''; - // @TODO: find a better way to check requirements - $label = 'PCRE'; - if (extension_loaded('pcre')) { - $status = 'OK!'; - $help = ''; - } else { + if (!extension_loaded($this->getContainer()->getParameter('database_driver'))) { $fulfilled = false; $status = 'ERROR!'; - $help = 'You should enabled PCRE extension'; + $help = 'Database driver "' . $this->getContainer()->getParameter('database_driver') . '" is not installed.'; + } + + $rows[] = [sprintf($label, $this->getContainer()->getParameter('database_driver')), $status, $help]; + + // testing if connection to the database can be etablished + $label = 'Database connection'; + $status = 'OK!'; + $help = ''; + + try { + $conn = $this->getContainer()->get('doctrine')->getManager()->getConnection(); + $conn->connect(); + } catch (\Exception $e) { + if (false === strpos($e->getMessage(), 'Unknown database') + && false === strpos($e->getMessage(), 'database "' . $this->getContainer()->getParameter('database_name') . '" does not exist')) { + $fulfilled = false; + $status = 'ERROR!'; + $help = 'Can\'t connect to the database: ' . $e->getMessage(); + } + } + + $rows[] = [$label, $status, $help]; + + // check MySQL & PostgreSQL version + $label = 'Database version'; + $status = 'OK!'; + $help = ''; + + // now check if MySQL isn't too old to handle utf8mb4 + if ($conn->isConnected() && 'mysql' === $conn->getDatabasePlatform()->getName()) { + $version = $conn->query('select version()')->fetchColumn(); + $minimalVersion = '5.5.4'; + + if (false === version_compare($version, $minimalVersion, '>')) { + $fulfilled = false; + $status = 'ERROR!'; + $help = 'Your MySQL version (' . $version . ') is too old, consider upgrading (' . $minimalVersion . '+).'; + } + } + + // testing if PostgreSQL > 9.1 + if ($conn->isConnected() && 'postgresql' === $conn->getDatabasePlatform()->getName()) { + // return version should be like "PostgreSQL 9.5.4 on x86_64-apple-darwin15.6.0, compiled by Apple LLVM version 8.0.0 (clang-800.0.38), 64-bit" + $version = $doctrineManager->getConnection()->query('SELECT version();')->fetchColumn(); + + preg_match('/PostgreSQL ([0-9\.]+)/i', $version, $matches); + + if (isset($matches[1]) & version_compare($matches[1], '9.2.0', '<')) { + $fulfilled = false; + $status = 'ERROR!'; + $help = 'PostgreSQL should be greater than 9.1 (actual version: ' . $matches[1] . ')'; + } } - $rows[] = array($label, $status, $help); - $label = 'DOM'; - if (extension_loaded('DOM')) { + $rows[] = [$label, $status, $help]; + + foreach ($this->functionExists as $functionRequired) { + $label = '' . $functionRequired . ''; $status = 'OK!'; $help = ''; - } else { - $fulfilled = false; - $status = 'ERROR!'; - $help = 'You should enabled DOM extension'; + + if (!function_exists($functionRequired)) { + $fulfilled = false; + $status = 'ERROR!'; + $help = 'You need the ' . $functionRequired . ' function activated'; + } + + $rows[] = [$label, $status, $help]; } - $rows[] = array($label, $status, $help); - $this->getHelper('table') - ->setHeaders(array('Checked', 'Status', 'Recommendation')) - ->setRows($rows) - ->render($this->defaultOutput); + $this->io->table(['Checked', 'Status', 'Recommendation'], $rows); if (!$fulfilled) { throw new \RuntimeException('Some system requirements are not fulfilled. Please check output messages and fix them.'); - } else { - $this->defaultOutput->writeln('Success! Your system can run Wallabag properly.'); } - $this->defaultOutput->writeln(''); + $this->io->success('Success! Your system can run wallabag properly.'); return $this; } protected function setupDatabase() { - $this->defaultOutput->writeln('Step 2 of 4. Setting up database.'); + $this->io->section('Step 2 of 5: Setting up database.'); // user want to reset everything? Don't care about what is already here if (true === $this->defaultInput->getOption('reset')) { - $this->defaultOutput->writeln('Droping database, creating database and schema'); + $this->io->text('Dropping database, creating database and schema, clearing the cache'); $this - ->runCommand('doctrine:database:drop', array('--force' => true)) + ->runCommand('doctrine:database:drop', ['--force' => true]) ->runCommand('doctrine:database:create') ->runCommand('doctrine:schema:create') + ->runCommand('cache:clear') ; + $this->io->newLine(); + return $this; } if (!$this->isDatabasePresent()) { - $this->defaultOutput->writeln('Creating database and schema, clearing the cache'); + $this->io->text('Creating database and schema, clearing the cache'); $this ->runCommand('doctrine:database:create') @@ -127,164 +196,184 @@ class InstallCommand extends ContainerAwareCommand ->runCommand('cache:clear') ; + $this->io->newLine(); + return $this; } - $dialog = $this->getHelper('dialog'); - - if ($dialog->askConfirmation($this->defaultOutput, 'It appears that your database already exists. Would you like to reset it? (y/N) ', false)) { - $this->defaultOutput->writeln('Droping database, creating database and schema'); + if ($this->io->confirm('It appears that your database already exists. Would you like to reset it?', false)) { + $this->io->text('Dropping database, creating database and schema...'); $this - ->runCommand('doctrine:database:drop', array('--force' => true)) + ->runCommand('doctrine:database:drop', ['--force' => true]) ->runCommand('doctrine:database:create') ->runCommand('doctrine:schema:create') ; } elseif ($this->isSchemaPresent()) { - if ($dialog->askConfirmation($this->defaultOutput, 'Seems like your database contains schema. Do you want to reset it? (y/N) ', false)) { - $this->defaultOutput->writeln('Droping schema and creating schema'); + if ($this->io->confirm('Seems like your database contains schema. Do you want to reset it?', false)) { + $this->io->text('Dropping schema and creating schema...'); $this - ->runCommand('doctrine:schema:drop', array('--force' => true)) + ->runCommand('doctrine:schema:drop', ['--force' => true]) ->runCommand('doctrine:schema:create') ; } } else { - $this->defaultOutput->writeln('Creating schema'); + $this->io->text('Creating schema...'); $this ->runCommand('doctrine:schema:create') ; } - $this->defaultOutput->writeln('Clearing the cache'); + $this->io->text('Clearing the cache...'); $this->runCommand('cache:clear'); - /* - if ($this->getHelperSet()->get('dialog')->askConfirmation($this->defaultOutput, 'Load fixtures (Y/N)?', false)) { - $doctrineConfig = $this->getContainer()->get('doctrine.orm.entity_manager')->getConnection()->getConfiguration(); - $logger = $doctrineConfig->getSQLLogger(); - // speed up fixture load - $doctrineConfig->setSQLLogger(null); - $this->runCommand('doctrine:fixtures:load'); - $doctrineConfig->setSQLLogger($logger); - } - */ - - $this->defaultOutput->writeln(''); + $this->io->newLine(); + $this->io->text('Database successfully setup.'); return $this; } protected function setupAdmin() { - $this->defaultOutput->writeln('Step 3 of 4. Administration setup.'); - - $dialog = $this->getHelperSet()->get('dialog'); + $this->io->section('Step 3 of 5: Administration setup.'); - if (false === $dialog->askConfirmation($this->defaultOutput, 'Would you like to create a new user ? (y/N)', true)) { + if (!$this->io->confirm('Would you like to create a new admin user (recommended)?', true)) { return $this; } $em = $this->getContainer()->get('doctrine.orm.entity_manager'); - $user = new User(); - $user->setUsername($dialog->ask($this->defaultOutput, 'Username (default: wallabag) :', 'wallabag')); - $user->setPassword($dialog->ask($this->defaultOutput, 'Password (default: wallabag) :', 'wallabag')); - $user->setEmail($dialog->ask($this->defaultOutput, 'Email:', '')); + $userManager = $this->getContainer()->get('fos_user.user_manager'); + $user = $userManager->createUser(); + + $user->setUsername($this->io->ask('Username', 'wallabag')); + + $question = new Question('Password', 'wallabag'); + $question->setHidden(true); + $user->setPlainPassword($this->io->askQuestion($question)); + + $user->setEmail($this->io->ask('Email', '')); + + $user->setEnabled(true); + $user->addRole('ROLE_SUPER_ADMIN'); $em->persist($user); - $config = new Config($user); - $config->setTheme($this->getContainer()->getParameter('theme')); - $config->setItemsPerPage($this->getContainer()->getParameter('items_on_page')); - $config->setLanguage($this->getContainer()->getParameter('language')); + // dispatch a created event so the associated config will be created + $event = new UserEvent($user); + $this->getContainer()->get('event_dispatcher')->dispatch(FOSUserEvents::USER_CREATED, $event); - $em->persist($config); + $this->io->text('Administration successfully setup.'); + + return $this; + } + + protected function setupConfig() + { + $this->io->section('Step 4 of 5: Config setup.'); + $em = $this->getContainer()->get('doctrine.orm.entity_manager'); + + // cleanup before insert new stuff + $em->createQuery('DELETE FROM CraueConfigBundle:Setting')->execute(); + + foreach ($this->getContainer()->getParameter('wallabag_core.default_internal_settings') as $setting) { + $newSetting = new Setting(); + $newSetting->setName($setting['name']); + $newSetting->setValue($setting['value']); + $newSetting->setSection($setting['section']); + $em->persist($newSetting); + } $em->flush(); - $this->defaultOutput->writeln(''); + $this->io->text('Config successfully setup.'); return $this; } - protected function setupAsset() + protected function runMigrations() { - $this->defaultOutput->writeln('Step 4 of 4. Installing assets.'); + $this->io->section('Step 5 of 5: Run migrations.'); $this - ->runCommand('assets:install') - ->runCommand('assetic:dump') - ; + ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true]); - $this->defaultOutput->writeln(''); + $this->io->text('Migrations successfully executed.'); return $this; } /** - * Run a command + * Run a command. * * @param string $command * @param array $parameters Parameters to this command (usually 'force' => true) */ - protected function runCommand($command, $parameters = array()) + protected function runCommand($command, $parameters = []) { $parameters = array_merge( - array('command' => $command), + ['command' => $command], $parameters, - array( + [ '--no-debug' => true, '--env' => $this->defaultInput->getOption('env') ?: 'dev', - ) + ] ); if ($this->defaultInput->getOption('no-interaction')) { - $parameters = array_merge($parameters, array('--no-interaction' => true)); + $parameters = array_merge($parameters, ['--no-interaction' => true]); } $this->getApplication()->setAutoExit(false); - $exitCode = $this->getApplication()->run(new ArrayInput($parameters), new NullOutput()); - - if (0 !== $exitCode) { - $this->getApplication()->setAutoExit(true); - - $errorMessage = sprintf('The command "%s" terminated with an error code: %u.', $command, $exitCode); - $this->defaultOutput->writeln("$errorMessage"); - $exception = new \Exception($errorMessage, $exitCode); - throw $exception; - } + $output = new BufferedOutput(); + $exitCode = $this->getApplication()->run(new ArrayInput($parameters), $output); // PDO does not always close the connection after Doctrine commands. // See https://github.com/symfony/symfony/issues/11750. $this->getContainer()->get('doctrine')->getManager()->getConnection()->close(); + if (0 !== $exitCode) { + $this->getApplication()->setAutoExit(true); + + throw new \RuntimeException( + 'The command "' . $command . "\" generates some errors: \n\n" + . $output->fetch()); + } + return $this; } /** - * Check if the database already exists + * Check if the database already exists. * - * @return boolean + * @return bool */ private function isDatabasePresent() { - $databaseName = $this->getContainer()->getParameter('database_name'); + $connection = $this->getContainer()->get('doctrine')->getManager()->getConnection(); + $databaseName = $connection->getDatabase(); try { - $schemaManager = $this->getContainer()->get('doctrine')->getManager()->getConnection()->getSchemaManager(); + $schemaManager = $connection->getSchemaManager(); } catch (\Exception $exception) { + // mysql & sqlite if (false !== strpos($exception->getMessage(), sprintf("Unknown database '%s'", $databaseName))) { return false; } + // pgsql + if (false !== strpos($exception->getMessage(), sprintf('database "%s" does not exist', $databaseName))) { + return false; + } + throw $exception; } // custom verification for sqlite, since `getListDatabasesSQL` doesn't work for sqlite - if ('sqlite' == $schemaManager->getDatabasePlatform()->getName()) { + if ('sqlite' === $schemaManager->getDatabasePlatform()->getName()) { $params = $this->getContainer()->get('doctrine.dbal.default_connection')->getParams(); if (isset($params['path']) && file_exists($params['path'])) { @@ -294,18 +383,25 @@ class InstallCommand extends ContainerAwareCommand return false; } - return in_array($databaseName, $schemaManager->listDatabases()); + try { + return in_array($databaseName, $schemaManager->listDatabases(), true); + } catch (\Doctrine\DBAL\Exception\DriverException $e) { + // it means we weren't able to get database list, assume the database doesn't exist + + return false; + } } /** - * Check if the schema is already created + * Check if the schema is already created. + * If we found at least oen table, it means the schema exists. * - * @return boolean + * @return bool */ private function isSchemaPresent() { $schemaManager = $this->getContainer()->get('doctrine')->getManager()->getConnection()->getSchemaManager(); - return $schemaManager->tablesExist(array('entry')); + return count($schemaManager->listTableNames()) > 0 ? true : false; } }