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\Output\BufferedOutput;
use Symfony\Component\Console\Output\OutputInterface;
-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
{
+ /**
+ * @var InputInterface
+ */
+ protected $defaultInput;
+
+ /**
+ * @var SymfonyStyle
+ */
+ protected $io;
+
+ /**
+ * @var array
+ */
+ protected $functionExists = [
+ 'curl_exec',
+ 'curl_multi_init',
+ ];
+
protected function configure()
{
$this
->setName('wallabag:install')
- ->setDescription('Wallabag installer.')
+ ->setDescription('wallabag installer.')
+ ->addOption(
+ 'reset',
+ null,
+ InputOption::VALUE_NONE,
+ 'Reset current database'
+ )
;
}
protected function execute(InputInterface $input, OutputInterface $output)
{
- $output->writeln('<info>Installing Wallabag.</info>');
- $output->writeln('');
+ $this->defaultInput = $input;
+
+ $this->io = new SymfonyStyle($input, $output);
+
+ $this->io->title('Wallabag installer');
$this
- ->checkStep($output)
- ->setupStep($input, $output)
+ ->checkRequirements()
+ ->setupDatabase()
+ ->setupAdmin()
+ ->setupConfig()
;
- $output->writeln('<info>Wallabag has been successfully installed.</info>');
- $output->writeln('<comment>Just execute `php app/console server:run` for using wallabag: http://localhost:8000</comment>');
+ $this->io->success('Wallabag has been successfully installed.');
+ $this->io->success('You can now configure your web server, see https://doc.wallabag.org');
}
- protected function checkStep(OutputInterface $output)
+ protected function checkRequirements()
{
- $output->writeln('<info>Checking system requirements.</info>');
+ $this->io->section('Step 1 of 4: Checking system requirements.');
+ $doctrineManager = $this->getContainer()->get('doctrine')->getManager();
+
+ $rows = [];
+
+ // testing if database driver exists
$fulfilled = true;
+ $label = '<comment>PDO Driver (%s)</comment>';
+ $status = '<info>OK!</info>';
+ $help = '';
- // @TODO: find a better way to check requirements
- $output->writeln('<comment>Check PCRE</comment>');
- if (extension_loaded('pcre')) {
- $output->writeln(' <info>OK</info>');
- } else {
+ if (!\extension_loaded($this->getContainer()->getParameter('database_driver'))) {
$fulfilled = false;
- $output->writeln(' <error>ERROR</error>');
- $output->writeln('<comment>You should enabled PCRE extension</comment>');
+ $status = '<error>ERROR!</error>';
+ $help = 'Database driver "' . $this->getContainer()->getParameter('database_driver') . '" is not installed.';
}
- $output->writeln('<comment>Check DOM</comment>');
- if (extension_loaded('DOM')) {
- $output->writeln(' <info>OK</info>');
- } else {
- $fulfilled = false;
- $output->writeln(' <error>ERROR</error>');
- $output->writeln('<comment>You should enabled DOM extension</comment>');
+ $rows[] = [sprintf($label, $this->getContainer()->getParameter('database_driver')), $status, $help];
+
+ // testing if connection to the database can be etablished
+ $label = '<comment>Database connection</comment>';
+ $status = '<info>OK!</info>';
+ $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>ERROR!</error>';
+ $help = 'Can\'t connect to the database: ' . $e->getMessage();
+ }
+ }
+
+ $rows[] = [$label, $status, $help];
+
+ // check MySQL & PostgreSQL version
+ $label = '<comment>Database version</comment>';
+ $status = '<info>OK!</info>';
+ $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>ERROR!</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>ERROR!</error>';
+ $help = 'PostgreSQL should be greater than 9.1 (actual version: ' . $matches[1] . ')';
+ }
+ }
+
+ $rows[] = [$label, $status, $help];
+
+ foreach ($this->functionExists as $functionRequired) {
+ $label = '<comment>' . $functionRequired . '</comment>';
+ $status = '<info>OK!</info>';
+ $help = '';
+
+ if (!\function_exists($functionRequired)) {
+ $fulfilled = false;
+ $status = '<error>ERROR!</error>';
+ $help = 'You need the ' . $functionRequired . ' function activated';
+ }
+
+ $rows[] = [$label, $status, $help];
}
+ $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.');
+ throw new \RuntimeException('Some system requirements are not fulfilled. Please check output messages and fix them.');
}
- $output->writeln('');
+ $this->io->success('Success! Your system can run wallabag properly.');
return $this;
}
- protected function setupStep(InputInterface $input, OutputInterface $output)
+ protected function setupDatabase()
{
- $output->writeln('<info>Setting up database.</info>');
+ $this->io->section('Step 2 of 4: Setting up database.');
- $this->setupDatabase($input, $output);
+ // user want to reset everything? Don't care about what is already here
+ if (true === $this->defaultInput->getOption('reset')) {
+ $this->io->text('Dropping database, creating database and schema, clearing the cache');
- // if ($this->getHelperSet()->get('dialog')->askConfirmation($output, '<question>Load fixtures (Y/N)?</question>', false)) {
- // $this->setupFixtures($input, $output);
- // }
+ $this
+ ->runCommand('doctrine:database:drop', ['--force' => true])
+ ->runCommand('doctrine:database:create')
+ ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true])
+ ->runCommand('cache:clear')
+ ;
- $output->writeln('');
- $output->writeln('<info>Administration setup.</info>');
+ $this->io->newLine();
- $this->setupAdmin($output);
+ return $this;
+ }
- $output->writeln('');
+ if (!$this->isDatabasePresent()) {
+ $this->io->text('Creating database and schema, clearing the cache');
- return $this;
- }
+ $this
+ ->runCommand('doctrine:database:create')
+ ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true])
+ ->runCommand('cache:clear')
+ ;
- protected function setupDatabase(InputInterface $input, OutputInterface $output)
- {
- if ($this->getHelperSet()->get('dialog')->askConfirmation($output, '<question>Drop current database (Y/N)?</question>', true)) {
- $connection = $this->getContainer()->get('doctrine')->getConnection();
- $params = $connection->getParams();
+ $this->io->newLine();
- $name = isset($params['path']) ? $params['path'] : (isset($params['dbname']) ? $params['dbname'] : false);
- unset($params['dbname']);
+ return $this;
+ }
- if (!isset($params['path'])) {
- $name = $connection->getDatabasePlatform()->quoteSingleIdentifier($name);
+ 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', ['--force' => true])
+ ->runCommand('doctrine:database:create')
+ ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true])
+ ;
+ } elseif ($this->isSchemaPresent()) {
+ 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', ['--force' => true])
+ ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true])
+ ;
}
-
- $connection->getSchemaManager()->dropDatabase($name);
} else {
- throw new \Exception("Install setup stopped, database need to be dropped. Please backup your current one and re-launch the install command.");
+ $this->io->text('Creating schema...');
+
+ $this
+ ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true])
+ ;
}
- $this
- ->runCommand('doctrine:database:create', $input, $output)
- ->runCommand('doctrine:schema:create', $input, $output)
- ->runCommand('cache:clear', $input, $output)
- ->runCommand('assets:install', $input, $output)
- ->runCommand('assetic:dump', $input, $output)
- ;
+ $this->io->text('Clearing the cache...');
+ $this->runCommand('cache:clear');
+
+ $this->io->newLine();
+ $this->io->text('<info>Database successfully setup.</info>');
+
+ return $this;
}
- protected function setupFixtures(InputInterface $input, OutputInterface $output)
+ protected function setupAdmin()
{
- $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', $input, $output);
- $doctrineConfig->setSQLLogger($logger);
+ $this->io->section('Step 3 of 4: Administration setup.');
+
+ 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');
+
+ $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);
+
+ // 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);
+
+ $this->io->text('<info>Administration successfully setup.</info>');
+
+ return $this;
}
- protected function setupAdmin(OutputInterface $output)
+ protected function setupConfig()
{
- $dialog = $this->getHelperSet()->get('dialog');
+ $this->io->section('Step 4 of 4: Config setup.');
$em = $this->getContainer()->get('doctrine.orm.entity_manager');
- $user = new User();
- $user->setUsername($dialog->ask($output, '<question>Username</question> <comment>(default: wallabag)</comment> :', 'wallabag'));
- $user->setPassword($dialog->ask($output, '<question>Password</question> <comment>(default: wallabag)</comment> :', 'wallabag'));
- $user->setEmail($dialog->ask($output, '<question>Email:</question>', ''));
+ // cleanup before insert new stuff
+ $em->createQuery('DELETE FROM CraueConfigBundle:Setting')->execute();
- $em->persist($user);
+ 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();
- $config = new Config($user);
- $config->setTheme($this->getContainer()->getParameter('theme'));
- $config->setItemsPerPage($this->getContainer()->getParameter('items_on_page'));
- $config->setLanguage($this->getContainer()->getParameter('language'));
+ $this->io->text('<info>Config successfully setup.</info>');
- $em->persist($config);
+ return $this;
}
- protected function runCommand($command, InputInterface $input, OutputInterface $output)
+ /**
+ * Run a command.
+ *
+ * @param string $command
+ * @param array $parameters Parameters to this command (usually 'force' => true)
+ */
+ protected function runCommand($command, $parameters = [])
{
- $this
- ->getApplication()
- ->find($command)
- ->run($input, $output)
- ;
+ $parameters = array_merge(
+ ['command' => $command],
+ $parameters,
+ [
+ '--no-debug' => true,
+ '--env' => $this->defaultInput->getOption('env') ?: 'dev',
+ ]
+ );
+
+ if ($this->defaultInput->getOption('no-interaction')) {
+ $parameters = array_merge($parameters, ['--no-interaction' => true]);
+ }
+
+ $this->getApplication()->setAutoExit(false);
+
+ $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.
+ *
+ * @return bool
+ */
+ private function isDatabasePresent()
+ {
+ $connection = $this->getContainer()->get('doctrine')->getManager()->getConnection();
+ $databaseName = $connection->getDatabase();
+
+ try {
+ $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()) {
+ $params = $this->getContainer()->get('doctrine.dbal.default_connection')->getParams();
+
+ if (isset($params['path']) && file_exists($params['path'])) {
+ return true;
+ }
+
+ return false;
+ }
+
+ 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.
+ * If we found at least oen table, it means the schema exists.
+ *
+ * @return bool
+ */
+ private function isSchemaPresent()
+ {
+ $schemaManager = $this->getContainer()->get('doctrine')->getManager()->getConnection()->getSchemaManager();
+
+ return \count($schemaManager->listTableNames()) > 0 ? true : false;
+ }
}
projects / github / wallabag / wallabag.git / blobdiff