3 namespace Wallabag\CoreBundle\Command
;
5 use Craue\ConfigBundle\Entity\Setting
;
6 use FOS\UserBundle\Event\UserEvent
;
7 use FOS\UserBundle\FOSUserEvents
;
8 use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand
;
9 use Symfony\Component\Console\Input\ArrayInput
;
10 use Symfony\Component\Console\Input\InputInterface
;
11 use Symfony\Component\Console\Input\InputOption
;
12 use Symfony\Component\Console\Output\BufferedOutput
;
13 use Symfony\Component\Console\Output\OutputInterface
;
14 use Symfony\Component\Console\Question\Question
;
15 use Symfony\Component\Console\Style\SymfonyStyle
;
17 class InstallCommand
extends ContainerAwareCommand
22 protected $defaultInput;
32 protected $functionExists = [
37 protected function configure()
40 ->setName('wallabag:install')
41 ->setDescription('wallabag installer.')
45 InputOption
::VALUE_NONE
,
46 'Reset current database'
51 protected function execute(InputInterface
$input, OutputInterface
$output)
53 $this->defaultInput
= $input;
55 $this->io
= new SymfonyStyle($input, $output);
57 $this->io
->title('Wallabag installer');
66 $this->io
->success('Wallabag has been successfully installed.');
67 $this->io
->success('You can now configure your web server, see https://doc.wallabag.org');
70 protected function checkRequirements()
72 $this->io
->section('Step 1 of 4: Checking system requirements.');
74 $doctrineManager = $this->getContainer()->get('doctrine')->getManager();
78 // testing if database driver exists
80 $label = '<comment>PDO Driver (%s)</comment>';
81 $status = '<info>OK!</info>';
84 if (!\
extension_loaded($this->getContainer()->getParameter('database_driver'))) {
86 $status = '<error>ERROR!</error>';
87 $help = 'Database driver "' . $this->getContainer()->getParameter('database_driver') . '" is not installed.';
90 $rows[] = [sprintf($label, $this->getContainer()->getParameter('database_driver')), $status, $help];
92 // testing if connection to the database can be etablished
93 $label = '<comment>Database connection</comment>';
94 $status = '<info>OK!</info>';
97 $conn = $this->getContainer()->get('doctrine')->getManager()->getConnection();
101 } catch (\Exception
$e) {
102 if (false === strpos($e->getMessage(), 'Unknown database')
103 && false === strpos($e->getMessage(), 'database "' . $this->getContainer()->getParameter('database_name') . '" does not exist')) {
105 $status = '<error>ERROR!</error>';
106 $help = 'Can\'t connect to the database: ' . $e->getMessage();
110 $rows[] = [$label, $status, $help];
112 // check MySQL & PostgreSQL version
113 $label = '<comment>Database version</comment>';
114 $status = '<info>OK!</info>';
117 // now check if MySQL isn't too old to handle utf8mb4
118 if ($conn->isConnected() && 'mysql' === $conn->getDatabasePlatform()->getName()) {
119 $version = $conn->query('select version()')->fetchColumn();
120 $minimalVersion = '5.5.4';
122 if (false === version_compare($version, $minimalVersion, '>')) {
124 $status = '<error>ERROR!</error>';
125 $help = 'Your MySQL version (' . $version . ') is too old, consider upgrading (' . $minimalVersion . '+).';
129 // testing if PostgreSQL > 9.1
130 if ($conn->isConnected() && 'postgresql' === $conn->getDatabasePlatform()->getName()) {
131 // 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"
132 $version = $doctrineManager->getConnection()->query('SELECT version();')->fetchColumn();
134 preg_match('/PostgreSQL ([0-9\.]+)/i', $version, $matches);
136 if (isset($matches[1]) & version_compare($matches[1], '9.2.0', '<')) {
138 $status = '<error>ERROR!</error>';
139 $help = 'PostgreSQL should be greater than 9.1 (actual version: ' . $matches[1] . ')';
143 $rows[] = [$label, $status, $help];
145 foreach ($this->functionExists
as $functionRequired) {
146 $label = '<comment>' . $functionRequired . '</comment>';
147 $status = '<info>OK!</info>';
150 if (!\function_exists
($functionRequired)) {
152 $status = '<error>ERROR!</error>';
153 $help = 'You need the ' . $functionRequired . ' function activated';
156 $rows[] = [$label, $status, $help];
159 $this->io
->table(['Checked', 'Status', 'Recommendation'], $rows);
162 throw new \
RuntimeException('Some system requirements are not fulfilled. Please check output messages and fix them.');
165 $this->io
->success('Success! Your system can run wallabag properly.');
170 protected function setupDatabase()
172 $this->io
->section('Step 2 of 4: Setting up database.');
174 // user want to reset everything? Don't care about what is already here
175 if (true === $this->defaultInput
->getOption('reset')) {
176 $this->io
->text('Dropping database, creating database and schema, clearing the cache');
179 ->runCommand('doctrine:database:drop', ['--force' => true])
180 ->runCommand('doctrine:database:create')
181 ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true])
182 ->runCommand('cache:clear')
185 $this->io
->newLine();
190 if (!$this->isDatabasePresent()) {
191 $this->io
->text('Creating database and schema, clearing the cache');
194 ->runCommand('doctrine:database:create')
195 ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true])
196 ->runCommand('cache:clear')
199 $this->io
->newLine();
204 if ($this->io
->confirm('It appears that your database already exists. Would you like to reset it?', false)) {
205 $this->io
->text('Dropping database, creating database and schema...');
208 ->runCommand('doctrine:database:drop', ['--force' => true])
209 ->runCommand('doctrine:database:create')
210 ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true])
212 } elseif ($this->isSchemaPresent()) {
213 if ($this->io
->confirm('Seems like your database contains schema. Do you want to reset it?', false)) {
214 $this->io
->text('Dropping schema and creating schema...');
217 ->runCommand('doctrine:schema:drop', ['--force' => true])
218 ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true])
222 $this->io
->text('Creating schema...');
225 ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true])
229 $this->io
->text('Clearing the cache...');
230 $this->runCommand('cache:clear');
232 $this->io
->newLine();
233 $this->io
->text('<info>Database successfully setup.</info>');
238 protected function setupAdmin()
240 $this->io
->section('Step 3 of 4: Administration setup.');
242 if (!$this->io
->confirm('Would you like to create a new admin user (recommended)?', true)) {
246 $em = $this->getContainer()->get('doctrine.orm.entity_manager');
248 $userManager = $this->getContainer()->get('fos_user.user_manager');
249 $user = $userManager->createUser();
251 $user->setUsername($this->io
->ask('Username', 'wallabag'));
253 $question = new Question('Password', 'wallabag');
254 $question->setHidden(true);
255 $user->setPlainPassword($this->io
->askQuestion($question));
257 $user->setEmail($this->io
->ask('Email', ''));
259 $user->setEnabled(true);
260 $user->addRole('ROLE_SUPER_ADMIN');
264 // dispatch a created event so the associated config will be created
265 $event = new UserEvent($user);
266 $this->getContainer()->get('event_dispatcher')->dispatch(FOSUserEvents
::USER_CREATED
, $event);
268 $this->io
->text('<info>Administration successfully setup.</info>');
273 protected function setupConfig()
275 $this->io
->section('Step 4 of 4: Config setup.');
276 $em = $this->getContainer()->get('doctrine.orm.entity_manager');
278 // cleanup before insert new stuff
279 $em->createQuery('DELETE FROM CraueConfigBundle:Setting')->execute();
281 foreach ($this->getContainer()->getParameter('wallabag_core.default_internal_settings') as $setting) {
282 $newSetting = new Setting();
283 $newSetting->setName($setting['name']);
284 $newSetting->setValue($setting['value']);
285 $newSetting->setSection($setting['section']);
286 $em->persist($newSetting);
291 $this->io
->text('<info>Config successfully setup.</info>');
299 * @param string $command
300 * @param array $parameters Parameters to this command (usually 'force' => true)
302 protected function runCommand($command, $parameters = [])
304 $parameters = array_merge(
305 ['command' => $command],
308 '--no-debug' => true,
309 '--env' => $this->defaultInput
->getOption('env') ?: 'dev',
313 if ($this->defaultInput
->getOption('no-interaction')) {
314 $parameters = array_merge($parameters, ['--no-interaction' => true]);
317 $this->getApplication()->setAutoExit(false);
319 $output = new BufferedOutput();
320 $exitCode = $this->getApplication()->run(new ArrayInput($parameters), $output);
322 // PDO does not always close the connection after Doctrine commands.
323 // See https://github.com/symfony/symfony/issues/11750.
324 $this->getContainer()->get('doctrine')->getManager()->getConnection()->close();
326 if (0 !== $exitCode) {
327 $this->getApplication()->setAutoExit(true);
329 throw new \
RuntimeException(
330 'The command "' . $command . "\" generates some errors: \n\n"
338 * Check if the database already exists.
342 private function isDatabasePresent()
344 $connection = $this->getContainer()->get('doctrine')->getManager()->getConnection();
345 $databaseName = $connection->getDatabase();
348 $schemaManager = $connection->getSchemaManager();
349 } catch (\Exception
$exception) {
351 if (false !== strpos($exception->getMessage(), sprintf("Unknown database '%s'", $databaseName))) {
356 if (false !== strpos($exception->getMessage(), sprintf('database "%s" does not exist', $databaseName))) {
363 // custom verification for sqlite, since `getListDatabasesSQL` doesn't work for sqlite
364 if ('sqlite' === $schemaManager->getDatabasePlatform()->getName()) {
365 $params = $this->getContainer()->get('doctrine.dbal.default_connection')->getParams();
367 if (isset($params['path']) && file_exists($params['path'])) {
375 return \
in_array($databaseName, $schemaManager->listDatabases(), true);
376 } catch (\Doctrine\DBAL\Exception\DriverException
$e) {
377 // it means we weren't able to get database list, assume the database doesn't exist
384 * Check if the schema is already created.
385 * If we found at least oen table, it means the schema exists.
389 private function isSchemaPresent()
391 $schemaManager = $this->getContainer()->get('doctrine')->getManager()->getConnection()->getSchemaManager();
393 return \
count($schemaManager->listTableNames()) > 0 ? true : false;