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