]>
Commit | Line | Data |
---|---|---|
2e45e7be J |
1 | <?php |
2 | ||
3 | namespace Wallabag\CoreBundle\Command; | |
4 | ||
f808b016 | 5 | use Craue\ConfigBundle\Entity\Setting; |
ca17abce JB |
6 | use FOS\UserBundle\Event\UserEvent; |
7 | use FOS\UserBundle\FOSUserEvents; | |
2e45e7be | 8 | use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand; |
619cc453 JB |
9 | use Symfony\Component\Console\Helper\Table; |
10 | use Symfony\Component\Console\Input\ArrayInput; | |
2e45e7be | 11 | use Symfony\Component\Console\Input\InputInterface; |
0bf99bb1 | 12 | use Symfony\Component\Console\Input\InputOption; |
39a19bdf | 13 | use Symfony\Component\Console\Output\BufferedOutput; |
619cc453 | 14 | use Symfony\Component\Console\Output\OutputInterface; |
78507d28 | 15 | use Symfony\Component\Console\Question\ConfirmationQuestion; |
619cc453 | 16 | use Symfony\Component\Console\Question\Question; |
2e45e7be J |
17 | |
18 | class InstallCommand extends ContainerAwareCommand | |
19 | { | |
0bf99bb1 J |
20 | /** |
21 | * @var InputInterface | |
22 | */ | |
23 | protected $defaultInput; | |
24 | ||
25 | /** | |
26 | * @var OutputInterface | |
27 | */ | |
28 | protected $defaultOutput; | |
29 | ||
fc6020b2 NL |
30 | /** |
31 | * @var array | |
32 | */ | |
db847ca0 | 33 | protected $functionExists = [ |
db847ca0 TC |
34 | 'curl_exec', |
35 | 'curl_multi_init', | |
fc6020b2 NL |
36 | ]; |
37 | ||
2e45e7be J |
38 | protected function configure() |
39 | { | |
40 | $this | |
41 | ->setName('wallabag:install') | |
88d5d94d | 42 | ->setDescription('wallabag installer.') |
0bf99bb1 J |
43 | ->addOption( |
44 | 'reset', | |
45 | null, | |
46 | InputOption::VALUE_NONE, | |
47 | 'Reset current database' | |
48 | ) | |
2e45e7be J |
49 | ; |
50 | } | |
51 | ||
52 | protected function execute(InputInterface $input, OutputInterface $output) | |
53 | { | |
0bf99bb1 J |
54 | $this->defaultInput = $input; |
55 | $this->defaultOutput = $output; | |
56 | ||
88d5d94d | 57 | $output->writeln('<info>Installing wallabag...</info>'); |
2e45e7be J |
58 | $output->writeln(''); |
59 | ||
60 | $this | |
0bf99bb1 J |
61 | ->checkRequirements() |
62 | ->setupDatabase() | |
63 | ->setupAdmin() | |
637dc4bb | 64 | ->setupConfig() |
7d2d1d68 | 65 | ->runMigrations() |
2e45e7be J |
66 | ; |
67 | ||
88d5d94d | 68 | $output->writeln('<info>wallabag has been successfully installed.</info>'); |
0c6845a9 | 69 | $output->writeln('<comment>Just execute `php bin/console server:run --env=prod` for using wallabag: http://localhost:8000</comment>'); |
2e45e7be J |
70 | } |
71 | ||
0bf99bb1 | 72 | protected function checkRequirements() |
2e45e7be | 73 | { |
7d2d1d68 | 74 | $this->defaultOutput->writeln('<info><comment>Step 1 of 5.</comment> Checking system requirements.</info>'); |
cffcce0c | 75 | $doctrineManager = $this->getContainer()->get('doctrine')->getManager(); |
2e45e7be | 76 | |
001a7bad | 77 | $rows = []; |
2e45e7be | 78 | |
001a7bad JB |
79 | // testing if database driver exists |
80 | $fulfilled = true; | |
a730cae3 | 81 | $label = '<comment>PDO Driver (%s)</comment>'; |
0e49487b JB |
82 | $status = '<info>OK!</info>'; |
83 | $help = ''; | |
c61b68e8 JB |
84 | |
85 | if (!extension_loaded($this->getContainer()->getParameter('database_driver'))) { | |
db847ca0 TC |
86 | $fulfilled = false; |
87 | $status = '<error>ERROR!</error>'; | |
f808b016 | 88 | $help = 'Database driver "' . $this->getContainer()->getParameter('database_driver') . '" is not installed.'; |
db847ca0 TC |
89 | } |
90 | ||
a730cae3 | 91 | $rows[] = [sprintf($label, $this->getContainer()->getParameter('database_driver')), $status, $help]; |
001a7bad JB |
92 | |
93 | // testing if connection to the database can be etablished | |
94 | $label = '<comment>Database connection</comment>'; | |
95 | $status = '<info>OK!</info>'; | |
96 | $help = ''; | |
97 | ||
98 | try { | |
fc79f1ff JB |
99 | $conn = $this->getContainer()->get('doctrine')->getManager()->getConnection(); |
100 | $conn->connect(); | |
001a7bad | 101 | } catch (\Exception $e) { |
39a19bdf | 102 | if (false === strpos($e->getMessage(), 'Unknown database') |
f808b016 | 103 | && false === strpos($e->getMessage(), 'database "' . $this->getContainer()->getParameter('database_name') . '" does not exist')) { |
f62c3faf JB |
104 | $fulfilled = false; |
105 | $status = '<error>ERROR!</error>'; | |
f808b016 | 106 | $help = 'Can\'t connect to the database: ' . $e->getMessage(); |
f62c3faf | 107 | } |
001a7bad JB |
108 | } |
109 | ||
4d0ec0e7 | 110 | $rows[] = [$label, $status, $help]; |
db847ca0 | 111 | |
68003139 JB |
112 | // check MySQL & PostgreSQL version |
113 | $label = '<comment>Database version</comment>'; | |
cffcce0c JB |
114 | $status = '<info>OK!</info>'; |
115 | $help = ''; | |
116 | ||
fc79f1ff | 117 | // now check if MySQL isn't too old to handle utf8mb4 |
68003139 | 118 | if ($conn->isConnected() && 'mysql' === $conn->getDatabasePlatform()->getName()) { |
fc79f1ff JB |
119 | $version = $conn->query('select version()')->fetchColumn(); |
120 | $minimalVersion = '5.5.4'; | |
121 | ||
122 | if (false === version_compare($version, $minimalVersion, '>')) { | |
123 | $fulfilled = false; | |
68003139 | 124 | $status = '<error>ERROR!</error>'; |
f808b016 | 125 | $help = 'Your MySQL version (' . $version . ') is too old, consider upgrading (' . $minimalVersion . '+).'; |
fc79f1ff JB |
126 | } |
127 | } | |
128 | ||
68003139 JB |
129 | // testing if PostgreSQL > 9.1 |
130 | if ($conn->isConnected() && 'postgresql' === $conn->getDatabasePlatform()->getName()) { | |
cffcce0c JB |
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(); | |
133 | ||
134 | preg_match('/PostgreSQL ([0-9\.]+)/i', $version, $matches); | |
135 | ||
136 | if (isset($matches[1]) & version_compare($matches[1], '9.2.0', '<')) { | |
137 | $fulfilled = false; | |
138 | $status = '<error>ERROR!</error>'; | |
f808b016 | 139 | $help = 'PostgreSQL should be greater than 9.1 (actual version: ' . $matches[1] . ')'; |
cffcce0c JB |
140 | } |
141 | } | |
142 | ||
143 | $rows[] = [$label, $status, $help]; | |
144 | ||
db847ca0 | 145 | foreach ($this->functionExists as $functionRequired) { |
f808b016 | 146 | $label = '<comment>' . $functionRequired . '</comment>'; |
0e49487b JB |
147 | $status = '<info>OK!</info>'; |
148 | $help = ''; | |
db847ca0 | 149 | |
0e49487b | 150 | if (!function_exists($functionRequired)) { |
fc6020b2 NL |
151 | $fulfilled = false; |
152 | $status = '<error>ERROR!</error>'; | |
f808b016 | 153 | $help = 'You need the ' . $functionRequired . ' function activated'; |
fc6020b2 | 154 | } |
db847ca0 | 155 | |
4d0ec0e7 | 156 | $rows[] = [$label, $status, $help]; |
2e45e7be | 157 | } |
0bf99bb1 | 158 | |
78507d28 JB |
159 | $table = new Table($this->defaultOutput); |
160 | $table | |
4d0ec0e7 | 161 | ->setHeaders(['Checked', 'Status', 'Recommendation']) |
0bf99bb1 | 162 | ->setRows($rows) |
78507d28 | 163 | ->render(); |
2e45e7be J |
164 | |
165 | if (!$fulfilled) { | |
0bf99bb1 | 166 | throw new \RuntimeException('Some system requirements are not fulfilled. Please check output messages and fix them.'); |
2e45e7be J |
167 | } |
168 | ||
88d5d94d | 169 | $this->defaultOutput->writeln('<info>Success! Your system can run wallabag properly.</info>'); |
8a493541 | 170 | |
0bf99bb1 | 171 | $this->defaultOutput->writeln(''); |
2e45e7be J |
172 | |
173 | return $this; | |
174 | } | |
175 | ||
0bf99bb1 | 176 | protected function setupDatabase() |
2e45e7be | 177 | { |
7d2d1d68 | 178 | $this->defaultOutput->writeln('<info><comment>Step 2 of 5.</comment> Setting up database.</info>'); |
2e45e7be | 179 | |
0bf99bb1 J |
180 | // user want to reset everything? Don't care about what is already here |
181 | if (true === $this->defaultInput->getOption('reset')) { | |
7d2d1d68 | 182 | $this->defaultOutput->writeln('Dropping database, creating database and schema, clearing the cache'); |
2e45e7be | 183 | |
0bf99bb1 | 184 | $this |
4d0ec0e7 | 185 | ->runCommand('doctrine:database:drop', ['--force' => true]) |
0bf99bb1 J |
186 | ->runCommand('doctrine:database:create') |
187 | ->runCommand('doctrine:schema:create') | |
d5027625 | 188 | ->runCommand('cache:clear') |
0bf99bb1 | 189 | ; |
2e45e7be | 190 | |
d5027625 JB |
191 | $this->defaultOutput->writeln(''); |
192 | ||
0bf99bb1 J |
193 | return $this; |
194 | } | |
2e45e7be | 195 | |
0bf99bb1 J |
196 | if (!$this->isDatabasePresent()) { |
197 | $this->defaultOutput->writeln('Creating database and schema, clearing the cache'); | |
2e45e7be | 198 | |
0bf99bb1 J |
199 | $this |
200 | ->runCommand('doctrine:database:create') | |
201 | ->runCommand('doctrine:schema:create') | |
202 | ->runCommand('cache:clear') | |
203 | ; | |
2e45e7be | 204 | |
d5027625 JB |
205 | $this->defaultOutput->writeln(''); |
206 | ||
0bf99bb1 J |
207 | return $this; |
208 | } | |
2e45e7be | 209 | |
78507d28 JB |
210 | $questionHelper = $this->getHelper('question'); |
211 | $question = new ConfirmationQuestion('It appears that your database already exists. Would you like to reset it? (y/N)', false); | |
2e45e7be | 212 | |
78507d28 | 213 | if ($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) { |
7d2d1d68 | 214 | $this->defaultOutput->writeln('Dropping database, creating database and schema'); |
2e45e7be | 215 | |
0bf99bb1 | 216 | $this |
4d0ec0e7 | 217 | ->runCommand('doctrine:database:drop', ['--force' => true]) |
0bf99bb1 J |
218 | ->runCommand('doctrine:database:create') |
219 | ->runCommand('doctrine:schema:create') | |
220 | ; | |
221 | } elseif ($this->isSchemaPresent()) { | |
78507d28 JB |
222 | $question = new ConfirmationQuestion('Seems like your database contains schema. Do you want to reset it? (y/N)', false); |
223 | if ($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) { | |
7d2d1d68 | 224 | $this->defaultOutput->writeln('Dropping schema and creating schema'); |
2e45e7be | 225 | |
0bf99bb1 | 226 | $this |
4d0ec0e7 | 227 | ->runCommand('doctrine:schema:drop', ['--force' => true]) |
0bf99bb1 J |
228 | ->runCommand('doctrine:schema:create') |
229 | ; | |
230 | } | |
2e45e7be | 231 | } else { |
0bf99bb1 J |
232 | $this->defaultOutput->writeln('Creating schema'); |
233 | ||
234 | $this | |
235 | ->runCommand('doctrine:schema:create') | |
236 | ; | |
2e45e7be J |
237 | } |
238 | ||
0bf99bb1 J |
239 | $this->defaultOutput->writeln('Clearing the cache'); |
240 | $this->runCommand('cache:clear'); | |
241 | ||
0bf99bb1 J |
242 | $this->defaultOutput->writeln(''); |
243 | ||
244 | return $this; | |
2e45e7be J |
245 | } |
246 | ||
0bf99bb1 | 247 | protected function setupAdmin() |
2e45e7be | 248 | { |
7d2d1d68 | 249 | $this->defaultOutput->writeln('<info><comment>Step 3 of 5.</comment> Administration setup.</info>'); |
0bf99bb1 | 250 | |
78507d28 | 251 | $questionHelper = $this->getHelperSet()->get('question'); |
3c39f5ac | 252 | $question = new ConfirmationQuestion('Would you like to create a new admin user (recommended) ? (Y/n)', true); |
0bf99bb1 | 253 | |
78507d28 | 254 | if (!$questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) { |
0bf99bb1 J |
255 | return $this; |
256 | } | |
257 | ||
2e45e7be J |
258 | $em = $this->getContainer()->get('doctrine.orm.entity_manager'); |
259 | ||
ec3ce598 NL |
260 | $userManager = $this->getContainer()->get('fos_user.user_manager'); |
261 | $user = $userManager->createUser(); | |
78507d28 JB |
262 | |
263 | $question = new Question('Username (default: wallabag) :', 'wallabag'); | |
264 | $user->setUsername($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)); | |
265 | ||
266 | $question = new Question('Password (default: wallabag) :', 'wallabag'); | |
267 | $user->setPlainPassword($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)); | |
268 | ||
269 | $question = new Question('Email:', ''); | |
270 | $user->setEmail($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)); | |
271 | ||
a1691859 | 272 | $user->setEnabled(true); |
8f06a8c4 | 273 | $user->addRole('ROLE_SUPER_ADMIN'); |
2e45e7be J |
274 | |
275 | $em->persist($user); | |
276 | ||
ca17abce JB |
277 | // dispatch a created event so the associated config will be created |
278 | $event = new UserEvent($user); | |
279 | $this->getContainer()->get('event_dispatcher')->dispatch(FOSUserEvents::USER_CREATED, $event); | |
0bf99bb1 | 280 | |
637dc4bb JB |
281 | $this->defaultOutput->writeln(''); |
282 | ||
283 | return $this; | |
284 | } | |
285 | ||
286 | protected function setupConfig() | |
287 | { | |
7d2d1d68 | 288 | $this->defaultOutput->writeln('<info><comment>Step 4 of 5.</comment> Config setup.</info>'); |
637dc4bb JB |
289 | $em = $this->getContainer()->get('doctrine.orm.entity_manager'); |
290 | ||
d6ba77e8 JB |
291 | // cleanup before insert new stuff |
292 | $em->createQuery('DELETE FROM CraueConfigBundle:Setting')->execute(); | |
293 | ||
426bb453 | 294 | foreach ($this->getContainer()->getParameter('wallabag_core.default_internal_settings') as $setting) { |
d6ba77e8 JB |
295 | $newSetting = new Setting(); |
296 | $newSetting->setName($setting['name']); | |
297 | $newSetting->setValue($setting['value']); | |
298 | $newSetting->setSection($setting['section']); | |
299 | $em->persist($newSetting); | |
300 | } | |
301 | ||
0bf99bb1 J |
302 | $em->flush(); |
303 | ||
304 | $this->defaultOutput->writeln(''); | |
305 | ||
306 | return $this; | |
2e45e7be J |
307 | } |
308 | ||
7d2d1d68 NL |
309 | protected function runMigrations() |
310 | { | |
311 | $this->defaultOutput->writeln('<info><comment>Step 5 of 5.</comment> Run migrations.</info>'); | |
312 | ||
313 | $this | |
314 | ->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true]); | |
906424c1 JB |
315 | |
316 | return $this; | |
7d2d1d68 NL |
317 | } |
318 | ||
0bf99bb1 | 319 | /** |
4346a860 | 320 | * Run a command. |
0bf99bb1 J |
321 | * |
322 | * @param string $command | |
323 | * @param array $parameters Parameters to this command (usually 'force' => true) | |
324 | */ | |
4d0ec0e7 | 325 | protected function runCommand($command, $parameters = []) |
0bf99bb1 J |
326 | { |
327 | $parameters = array_merge( | |
4d0ec0e7 | 328 | ['command' => $command], |
0bf99bb1 | 329 | $parameters, |
4d0ec0e7 | 330 | [ |
0bf99bb1 J |
331 | '--no-debug' => true, |
332 | '--env' => $this->defaultInput->getOption('env') ?: 'dev', | |
4d0ec0e7 | 333 | ] |
0bf99bb1 J |
334 | ); |
335 | ||
336 | if ($this->defaultInput->getOption('no-interaction')) { | |
4d0ec0e7 | 337 | $parameters = array_merge($parameters, ['--no-interaction' => true]); |
0bf99bb1 J |
338 | } |
339 | ||
340 | $this->getApplication()->setAutoExit(false); | |
39a19bdf JB |
341 | |
342 | $output = new BufferedOutput(); | |
343 | $exitCode = $this->getApplication()->run(new ArrayInput($parameters), $output); | |
0bf99bb1 | 344 | |
7ab5eb95 | 345 | // PDO does not always close the connection after Doctrine commands. |
346 | // See https://github.com/symfony/symfony/issues/11750. | |
347 | $this->getContainer()->get('doctrine')->getManager()->getConnection()->close(); | |
348 | ||
0bf99bb1 J |
349 | if (0 !== $exitCode) { |
350 | $this->getApplication()->setAutoExit(true); | |
351 | ||
7ab5eb95 | 352 | throw new \RuntimeException( |
f808b016 JB |
353 | 'The command "' . $command . "\" generates some errors: \n\n" |
354 | . $output->fetch()); | |
0bf99bb1 J |
355 | } |
356 | ||
2e45e7be J |
357 | return $this; |
358 | } | |
0bf99bb1 J |
359 | |
360 | /** | |
4346a860 | 361 | * Check if the database already exists. |
0bf99bb1 | 362 | * |
4346a860 | 363 | * @return bool |
0bf99bb1 J |
364 | */ |
365 | private function isDatabasePresent() | |
366 | { | |
af43bd37 JB |
367 | $connection = $this->getContainer()->get('doctrine')->getManager()->getConnection(); |
368 | $databaseName = $connection->getDatabase(); | |
0bf99bb1 J |
369 | |
370 | try { | |
af43bd37 | 371 | $schemaManager = $connection->getSchemaManager(); |
0bf99bb1 | 372 | } catch (\Exception $exception) { |
54a2241e | 373 | // mysql & sqlite |
0bf99bb1 J |
374 | if (false !== strpos($exception->getMessage(), sprintf("Unknown database '%s'", $databaseName))) { |
375 | return false; | |
376 | } | |
377 | ||
54a2241e JB |
378 | // pgsql |
379 | if (false !== strpos($exception->getMessage(), sprintf('database "%s" does not exist', $databaseName))) { | |
380 | return false; | |
381 | } | |
382 | ||
0bf99bb1 J |
383 | throw $exception; |
384 | } | |
385 | ||
732c2ad8 | 386 | // custom verification for sqlite, since `getListDatabasesSQL` doesn't work for sqlite |
f62c3faf | 387 | if ('sqlite' === $schemaManager->getDatabasePlatform()->getName()) { |
732c2ad8 J |
388 | $params = $this->getContainer()->get('doctrine.dbal.default_connection')->getParams(); |
389 | ||
390 | if (isset($params['path']) && file_exists($params['path'])) { | |
391 | return true; | |
392 | } | |
393 | ||
394 | return false; | |
395 | } | |
396 | ||
69c21157 | 397 | try { |
f808b016 | 398 | return in_array($databaseName, $schemaManager->listDatabases(), true); |
443cff98 | 399 | } catch (\Doctrine\DBAL\Exception\DriverException $e) { |
69c21157 JB |
400 | // it means we weren't able to get database list, assume the database doesn't exist |
401 | ||
402 | return false; | |
403 | } | |
0bf99bb1 J |
404 | } |
405 | ||
406 | /** | |
164bd801 | 407 | * Check if the schema is already created. |
4346a860 | 408 | * If we found at least oen table, it means the schema exists. |
0bf99bb1 | 409 | * |
4346a860 | 410 | * @return bool |
0bf99bb1 J |
411 | */ |
412 | private function isSchemaPresent() | |
413 | { | |
414 | $schemaManager = $this->getContainer()->get('doctrine')->getManager()->getConnection()->getSchemaManager(); | |
415 | ||
164bd801 | 416 | return count($schemaManager->listTableNames()) > 0 ? true : false; |
0bf99bb1 | 417 | } |
2e45e7be | 418 | } |