]>
Commit | Line | Data |
---|---|---|
1 | <?php | |
2 | ||
3 | namespace Wallabag\CoreBundle\Command; | |
4 | ||
5 | use FOS\UserBundle\Event\UserEvent; | |
6 | use FOS\UserBundle\FOSUserEvents; | |
7 | use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand; | |
8 | use Symfony\Component\Console\Helper\Table; | |
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\ConfirmationQuestion; | |
15 | use Symfony\Component\Console\Question\Question; | |
16 | use Wallabag\CoreBundle\Entity\Config; | |
17 | use Craue\ConfigBundle\Entity\Setting; | |
18 | ||
19 | class InstallCommand extends ContainerAwareCommand | |
20 | { | |
21 | /** | |
22 | * @var InputInterface | |
23 | */ | |
24 | protected $defaultInput; | |
25 | ||
26 | /** | |
27 | * @var OutputInterface | |
28 | */ | |
29 | protected $defaultOutput; | |
30 | ||
31 | /** | |
32 | * @var array | |
33 | */ | |
34 | protected $functionExists = [ | |
35 | 'curl_exec', | |
36 | 'curl_multi_init', | |
37 | ]; | |
38 | ||
39 | protected function configure() | |
40 | { | |
41 | $this | |
42 | ->setName('wallabag:install') | |
43 | ->setDescription('Wallabag installer.') | |
44 | ->addOption( | |
45 | 'reset', | |
46 | null, | |
47 | InputOption::VALUE_NONE, | |
48 | 'Reset current database' | |
49 | ) | |
50 | ; | |
51 | } | |
52 | ||
53 | protected function execute(InputInterface $input, OutputInterface $output) | |
54 | { | |
55 | $this->defaultInput = $input; | |
56 | $this->defaultOutput = $output; | |
57 | ||
58 | $output->writeln('<info>Installing Wallabag...</info>'); | |
59 | $output->writeln(''); | |
60 | ||
61 | $this | |
62 | ->checkRequirements() | |
63 | ->setupDatabase() | |
64 | ->setupAdmin() | |
65 | ->setupConfig() | |
66 | ; | |
67 | ||
68 | $output->writeln('<info>Wallabag has been successfully installed.</info>'); | |
69 | $output->writeln('<comment>Just execute `php bin/console server:run --env=prod` for using wallabag: http://localhost:8000</comment>'); | |
70 | } | |
71 | ||
72 | protected function checkRequirements() | |
73 | { | |
74 | $this->defaultOutput->writeln('<info><comment>Step 1 of 4.</comment> Checking system requirements.</info>'); | |
75 | ||
76 | $rows = []; | |
77 | ||
78 | // testing if database driver exists | |
79 | $fulfilled = true; | |
80 | $label = '<comment>PDO Driver (%s)</comment>'; | |
81 | $status = '<info>OK!</info>'; | |
82 | $help = ''; | |
83 | ||
84 | if (!extension_loaded($this->getContainer()->getParameter('database_driver'))) { | |
85 | $fulfilled = false; | |
86 | $status = '<error>ERROR!</error>'; | |
87 | $help = 'Database driver "'.$this->getContainer()->getParameter('database_driver').'" is not installed.'; | |
88 | } | |
89 | ||
90 | $rows[] = [sprintf($label, $this->getContainer()->getParameter('database_driver')), $status, $help]; | |
91 | ||
92 | // testing if connection to the database can be etablished | |
93 | $label = '<comment>Database connection</comment>'; | |
94 | $status = '<info>OK!</info>'; | |
95 | $help = ''; | |
96 | ||
97 | try { | |
98 | $conn = $this->getContainer()->get('doctrine')->getManager()->getConnection(); | |
99 | $conn->connect(); | |
100 | } catch (\Exception $e) { | |
101 | if (false === strpos($e->getMessage(), 'Unknown database') | |
102 | && false === strpos($e->getMessage(), 'database "'.$this->getContainer()->getParameter('database_name').'" does not exist')) { | |
103 | $fulfilled = false; | |
104 | $status = '<error>ERROR!</error>'; | |
105 | $help = 'Can\'t connect to the database: '.$e->getMessage(); | |
106 | } | |
107 | } | |
108 | ||
109 | $rows[] = [$label, $status, $help]; | |
110 | ||
111 | // now check if MySQL isn't too old to handle utf8mb4 | |
112 | if ($conn->isConnected() && $conn->getDatabasePlatform() instanceof \Doctrine\DBAL\Platforms\MySqlPlatform) { | |
113 | $version = $conn->query('select version()')->fetchColumn(); | |
114 | $minimalVersion = '5.5.4'; | |
115 | ||
116 | if (false === version_compare($version, $minimalVersion, '>')) { | |
117 | $fulfilled = false; | |
118 | $rows[] = [ | |
119 | '<comment>Database version</comment>', | |
120 | '<error>ERROR!</error>', | |
121 | 'Your MySQL version ('.$version.') is too old, consider upgrading ('.$minimalVersion.'+).' | |
122 | ]; | |
123 | } | |
124 | } | |
125 | ||
126 | foreach ($this->functionExists as $functionRequired) { | |
127 | $label = '<comment>'.$functionRequired.'</comment>'; | |
128 | $status = '<info>OK!</info>'; | |
129 | $help = ''; | |
130 | ||
131 | if (!function_exists($functionRequired)) { | |
132 | $fulfilled = false; | |
133 | $status = '<error>ERROR!</error>'; | |
134 | $help = 'You need the '.$functionRequired.' function activated'; | |
135 | } | |
136 | ||
137 | $rows[] = [$label, $status, $help]; | |
138 | } | |
139 | ||
140 | $table = new Table($this->defaultOutput); | |
141 | $table | |
142 | ->setHeaders(['Checked', 'Status', 'Recommendation']) | |
143 | ->setRows($rows) | |
144 | ->render(); | |
145 | ||
146 | if (!$fulfilled) { | |
147 | throw new \RuntimeException('Some system requirements are not fulfilled. Please check output messages and fix them.'); | |
148 | } | |
149 | ||
150 | $this->defaultOutput->writeln('<info>Success! Your system can run Wallabag properly.</info>'); | |
151 | ||
152 | $this->defaultOutput->writeln(''); | |
153 | ||
154 | return $this; | |
155 | } | |
156 | ||
157 | protected function setupDatabase() | |
158 | { | |
159 | $this->defaultOutput->writeln('<info><comment>Step 2 of 4.</comment> Setting up database.</info>'); | |
160 | ||
161 | // user want to reset everything? Don't care about what is already here | |
162 | if (true === $this->defaultInput->getOption('reset')) { | |
163 | $this->defaultOutput->writeln('Droping database, creating database and schema, clearing the cache'); | |
164 | ||
165 | $this | |
166 | ->runCommand('doctrine:database:drop', ['--force' => true]) | |
167 | ->runCommand('doctrine:database:create') | |
168 | ->runCommand('doctrine:schema:create') | |
169 | ->runCommand('cache:clear') | |
170 | ; | |
171 | ||
172 | $this->defaultOutput->writeln(''); | |
173 | ||
174 | return $this; | |
175 | } | |
176 | ||
177 | if (!$this->isDatabasePresent()) { | |
178 | $this->defaultOutput->writeln('Creating database and schema, clearing the cache'); | |
179 | ||
180 | $this | |
181 | ->runCommand('doctrine:database:create') | |
182 | ->runCommand('doctrine:schema:create') | |
183 | ->runCommand('cache:clear') | |
184 | ; | |
185 | ||
186 | $this->defaultOutput->writeln(''); | |
187 | ||
188 | return $this; | |
189 | } | |
190 | ||
191 | $questionHelper = $this->getHelper('question'); | |
192 | $question = new ConfirmationQuestion('It appears that your database already exists. Would you like to reset it? (y/N)', false); | |
193 | ||
194 | if ($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) { | |
195 | $this->defaultOutput->writeln('Droping database, creating database and schema'); | |
196 | ||
197 | $this | |
198 | ->runCommand('doctrine:database:drop', ['--force' => true]) | |
199 | ->runCommand('doctrine:database:create') | |
200 | ->runCommand('doctrine:schema:create') | |
201 | ; | |
202 | } elseif ($this->isSchemaPresent()) { | |
203 | $question = new ConfirmationQuestion('Seems like your database contains schema. Do you want to reset it? (y/N)', false); | |
204 | if ($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) { | |
205 | $this->defaultOutput->writeln('Droping schema and creating schema'); | |
206 | ||
207 | $this | |
208 | ->runCommand('doctrine:schema:drop', ['--force' => true]) | |
209 | ->runCommand('doctrine:schema:create') | |
210 | ; | |
211 | } | |
212 | } else { | |
213 | $this->defaultOutput->writeln('Creating schema'); | |
214 | ||
215 | $this | |
216 | ->runCommand('doctrine:schema:create') | |
217 | ; | |
218 | } | |
219 | ||
220 | $this->defaultOutput->writeln('Clearing the cache'); | |
221 | $this->runCommand('cache:clear'); | |
222 | ||
223 | $this->defaultOutput->writeln(''); | |
224 | ||
225 | return $this; | |
226 | } | |
227 | ||
228 | protected function setupAdmin() | |
229 | { | |
230 | $this->defaultOutput->writeln('<info><comment>Step 3 of 4.</comment> Administration setup.</info>'); | |
231 | ||
232 | $questionHelper = $this->getHelperSet()->get('question'); | |
233 | $question = new ConfirmationQuestion('Would you like to create a new admin user (recommended) ? (Y/n)', true); | |
234 | ||
235 | if (!$questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) { | |
236 | return $this; | |
237 | } | |
238 | ||
239 | $em = $this->getContainer()->get('doctrine.orm.entity_manager'); | |
240 | ||
241 | $userManager = $this->getContainer()->get('fos_user.user_manager'); | |
242 | $user = $userManager->createUser(); | |
243 | ||
244 | $question = new Question('Username (default: wallabag) :', 'wallabag'); | |
245 | $user->setUsername($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)); | |
246 | ||
247 | $question = new Question('Password (default: wallabag) :', 'wallabag'); | |
248 | $user->setPlainPassword($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)); | |
249 | ||
250 | $question = new Question('Email:', ''); | |
251 | $user->setEmail($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)); | |
252 | ||
253 | $user->setEnabled(true); | |
254 | $user->addRole('ROLE_SUPER_ADMIN'); | |
255 | ||
256 | $em->persist($user); | |
257 | ||
258 | // dispatch a created event so the associated config will be created | |
259 | $event = new UserEvent($user); | |
260 | $this->getContainer()->get('event_dispatcher')->dispatch(FOSUserEvents::USER_CREATED, $event); | |
261 | ||
262 | $this->defaultOutput->writeln(''); | |
263 | ||
264 | return $this; | |
265 | } | |
266 | ||
267 | protected function setupConfig() | |
268 | { | |
269 | $this->defaultOutput->writeln('<info><comment>Step 4 of 4.</comment> Config setup.</info>'); | |
270 | $em = $this->getContainer()->get('doctrine.orm.entity_manager'); | |
271 | ||
272 | // cleanup before insert new stuff | |
273 | $em->createQuery('DELETE FROM CraueConfigBundle:Setting')->execute(); | |
274 | ||
275 | $settings = [ | |
276 | [ | |
277 | 'name' => 'share_public', | |
278 | 'value' => '1', | |
279 | 'section' => 'entry', | |
280 | ], | |
281 | [ | |
282 | 'name' => 'carrot', | |
283 | 'value' => '1', | |
284 | 'section' => 'entry', | |
285 | ], | |
286 | [ | |
287 | 'name' => 'share_diaspora', | |
288 | 'value' => '1', | |
289 | 'section' => 'entry', | |
290 | ], | |
291 | [ | |
292 | 'name' => 'diaspora_url', | |
293 | 'value' => 'http://diasporapod.com', | |
294 | 'section' => 'entry', | |
295 | ], | |
296 | [ | |
297 | 'name' => 'share_shaarli', | |
298 | 'value' => '1', | |
299 | 'section' => 'entry', | |
300 | ], | |
301 | [ | |
302 | 'name' => 'shaarli_url', | |
303 | 'value' => 'http://myshaarli.com', | |
304 | 'section' => 'entry', | |
305 | ], | |
306 | [ | |
307 | 'name' => 'share_mail', | |
308 | 'value' => '1', | |
309 | 'section' => 'entry', | |
310 | ], | |
311 | [ | |
312 | 'name' => 'share_twitter', | |
313 | 'value' => '1', | |
314 | 'section' => 'entry', | |
315 | ], | |
316 | [ | |
317 | 'name' => 'export_epub', | |
318 | 'value' => '1', | |
319 | 'section' => 'export', | |
320 | ], | |
321 | [ | |
322 | 'name' => 'export_mobi', | |
323 | 'value' => '1', | |
324 | 'section' => 'export', | |
325 | ], | |
326 | [ | |
327 | 'name' => 'export_pdf', | |
328 | 'value' => '1', | |
329 | 'section' => 'export', | |
330 | ], | |
331 | [ | |
332 | 'name' => 'export_csv', | |
333 | 'value' => '1', | |
334 | 'section' => 'export', | |
335 | ], | |
336 | [ | |
337 | 'name' => 'export_json', | |
338 | 'value' => '1', | |
339 | 'section' => 'export', | |
340 | ], | |
341 | [ | |
342 | 'name' => 'export_txt', | |
343 | 'value' => '1', | |
344 | 'section' => 'export', | |
345 | ], | |
346 | [ | |
347 | 'name' => 'export_xml', | |
348 | 'value' => '1', | |
349 | 'section' => 'export', | |
350 | ], | |
351 | [ | |
352 | 'name' => 'import_with_redis', | |
353 | 'value' => '0', | |
354 | 'section' => 'import', | |
355 | ], | |
356 | [ | |
357 | 'name' => 'import_with_rabbitmq', | |
358 | 'value' => '0', | |
359 | 'section' => 'import', | |
360 | ], | |
361 | [ | |
362 | 'name' => 'show_printlink', | |
363 | 'value' => '1', | |
364 | 'section' => 'entry', | |
365 | ], | |
366 | [ | |
367 | 'name' => 'wallabag_support_url', | |
368 | 'value' => 'https://www.wallabag.org/pages/support.html', | |
369 | 'section' => 'misc', | |
370 | ], | |
371 | [ | |
372 | 'name' => 'wallabag_url', | |
373 | 'value' => 'http://v2.wallabag.org', | |
374 | 'section' => 'misc', | |
375 | ], | |
376 | [ | |
377 | 'name' => 'piwik_enabled', | |
378 | 'value' => '0', | |
379 | 'section' => 'analytics', | |
380 | ], | |
381 | [ | |
382 | 'name' => 'piwik_host', | |
383 | 'value' => 'http://v2.wallabag.org', | |
384 | 'section' => 'analytics', | |
385 | ], | |
386 | [ | |
387 | 'name' => 'piwik_site_id', | |
388 | 'value' => '1', | |
389 | 'section' => 'analytics', | |
390 | ], | |
391 | [ | |
392 | 'name' => 'demo_mode_enabled', | |
393 | 'value' => '0', | |
394 | 'section' => 'misc', | |
395 | ], | |
396 | [ | |
397 | 'name' => 'demo_mode_username', | |
398 | 'value' => 'wallabag', | |
399 | 'section' => 'misc', | |
400 | ], | |
401 | ]; | |
402 | ||
403 | foreach ($settings as $setting) { | |
404 | $newSetting = new Setting(); | |
405 | $newSetting->setName($setting['name']); | |
406 | $newSetting->setValue($setting['value']); | |
407 | $newSetting->setSection($setting['section']); | |
408 | $em->persist($newSetting); | |
409 | } | |
410 | ||
411 | $em->flush(); | |
412 | ||
413 | $this->defaultOutput->writeln(''); | |
414 | ||
415 | return $this; | |
416 | } | |
417 | ||
418 | /** | |
419 | * Run a command. | |
420 | * | |
421 | * @param string $command | |
422 | * @param array $parameters Parameters to this command (usually 'force' => true) | |
423 | */ | |
424 | protected function runCommand($command, $parameters = []) | |
425 | { | |
426 | $parameters = array_merge( | |
427 | ['command' => $command], | |
428 | $parameters, | |
429 | [ | |
430 | '--no-debug' => true, | |
431 | '--env' => $this->defaultInput->getOption('env') ?: 'dev', | |
432 | ] | |
433 | ); | |
434 | ||
435 | if ($this->defaultInput->getOption('no-interaction')) { | |
436 | $parameters = array_merge($parameters, ['--no-interaction' => true]); | |
437 | } | |
438 | ||
439 | $this->getApplication()->setAutoExit(false); | |
440 | ||
441 | $output = new BufferedOutput(); | |
442 | $exitCode = $this->getApplication()->run(new ArrayInput($parameters), $output); | |
443 | ||
444 | if (0 !== $exitCode) { | |
445 | $this->getApplication()->setAutoExit(true); | |
446 | ||
447 | $this->defaultOutput->writeln(''); | |
448 | $this->defaultOutput->writeln('<error>The command "'.$command.'" generates some errors: </error>'); | |
449 | $this->defaultOutput->writeln($output->fetch()); | |
450 | ||
451 | die(); | |
452 | } | |
453 | ||
454 | // PDO does not always close the connection after Doctrine commands. | |
455 | // See https://github.com/symfony/symfony/issues/11750. | |
456 | $this->getContainer()->get('doctrine')->getManager()->getConnection()->close(); | |
457 | ||
458 | return $this; | |
459 | } | |
460 | ||
461 | /** | |
462 | * Check if the database already exists. | |
463 | * | |
464 | * @return bool | |
465 | */ | |
466 | private function isDatabasePresent() | |
467 | { | |
468 | $connection = $this->getContainer()->get('doctrine')->getManager()->getConnection(); | |
469 | $databaseName = $connection->getDatabase(); | |
470 | ||
471 | try { | |
472 | $schemaManager = $connection->getSchemaManager(); | |
473 | } catch (\Exception $exception) { | |
474 | // mysql & sqlite | |
475 | if (false !== strpos($exception->getMessage(), sprintf("Unknown database '%s'", $databaseName))) { | |
476 | return false; | |
477 | } | |
478 | ||
479 | // pgsql | |
480 | if (false !== strpos($exception->getMessage(), sprintf('database "%s" does not exist', $databaseName))) { | |
481 | return false; | |
482 | } | |
483 | ||
484 | throw $exception; | |
485 | } | |
486 | ||
487 | // custom verification for sqlite, since `getListDatabasesSQL` doesn't work for sqlite | |
488 | if ('sqlite' === $schemaManager->getDatabasePlatform()->getName()) { | |
489 | $params = $this->getContainer()->get('doctrine.dbal.default_connection')->getParams(); | |
490 | ||
491 | if (isset($params['path']) && file_exists($params['path'])) { | |
492 | return true; | |
493 | } | |
494 | ||
495 | return false; | |
496 | } | |
497 | ||
498 | try { | |
499 | return in_array($databaseName, $schemaManager->listDatabases()); | |
500 | } catch (\Doctrine\DBAL\Exception\DriverException $e) { | |
501 | // it means we weren't able to get database list, assume the database doesn't exist | |
502 | ||
503 | return false; | |
504 | } | |
505 | } | |
506 | ||
507 | /** | |
508 | * Check if the schema is already created. | |
509 | * If we found at least oen table, it means the schema exists. | |
510 | * | |
511 | * @return bool | |
512 | */ | |
513 | private function isSchemaPresent() | |
514 | { | |
515 | $schemaManager = $this->getContainer()->get('doctrine')->getManager()->getConnection()->getSchemaManager(); | |
516 | ||
517 | return count($schemaManager->listTableNames()) > 0 ? true : false; | |
518 | } | |
519 | } |