src/Wallabag/CoreBundle/Command/InstallCommand.php

   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         $doctrineManager = $this->getContainer()->get('doctrine')->getManager();
  76
  77         $rows = [];
  78
  79         // testing if database driver exists
  80         $fulfilled = true;
  81         $label = '<comment>PDO Driver (%s)</comment>';
  82         $status = '<info>OK!</info>';
  83         $help = '';
  84
  85         if (!extension_loaded($this->getContainer()->getParameter('database_driver'))) {
  86             $fulfilled = false;
  87             $status = '<error>ERROR!</error>';
  88             $help = 'Database driver "'.$this->getContainer()->getParameter('database_driver').'" is not installed.';
  89         }
  90
  91         $rows[] = [sprintf($label, $this->getContainer()->getParameter('database_driver')), $status, $help];
  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 {
  99             $conn = $this->getContainer()->get('doctrine')->getManager()->getConnection();
 100             $conn->connect();
 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')) {
 104                 $fulfilled = false;
 105                 $status = '<error>ERROR!</error>';
 106                 $help = 'Can\'t connect to the database: '.$e->getMessage();
 107             }
 108         }
 109
 110         $rows[] = [$label, $status, $help];
 111
 112         // check MySQL & PostgreSQL version
 113         $label = '<comment>Database version</comment>';
 114         $status = '<info>OK!</info>';
 115         $help = '';
 116
 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';
 121
 122             if (false === version_compare($version, $minimalVersion, '>')) {
 123                 $fulfilled = false;
 124                 $status = '<error>ERROR!</error>';
 125                 $help = 'Your MySQL version ('.$version.') is too old, consider upgrading ('.$minimalVersion.'+).';
 126             }
 127         }
 128
 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();
 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>';
 139                 $help = 'PostgreSQL should be greater than 9.1 (actual version: '.$matches[1].')';
 140             }
 141         }
 142
 143         $rows[] = [$label, $status, $help];
 144
 145         foreach ($this->functionExists as $functionRequired) {
 146             $label = '<comment>'.$functionRequired.'</comment>';
 147             $status = '<info>OK!</info>';
 148             $help = '';
 149
 150             if (!function_exists($functionRequired)) {
 151                 $fulfilled = false;
 152                 $status = '<error>ERROR!</error>';
 153                 $help = 'You need the '.$functionRequired.' function activated';
 154             }
 155
 156             $rows[] = [$label, $status, $help];
 157         }
 158
 159         $table = new Table($this->defaultOutput);
 160         $table
 161             ->setHeaders(['Checked', 'Status', 'Recommendation'])
 162             ->setRows($rows)
 163             ->render();
 164
 165         if (!$fulfilled) {
 166             throw new \RuntimeException('Some system requirements are not fulfilled. Please check output messages and fix them.');
 167         }
 168
 169         $this->defaultOutput->writeln('<info>Success! Your system can run wallabag properly.</info>');
 170
 171         $this->defaultOutput->writeln('');
 172
 173         return $this;
 174     }
 175
 176     protected function setupDatabase()
 177     {
 178         $this->defaultOutput->writeln('<info><comment>Step 2 of 4.</comment> Setting up database.</info>');
 179
 180         // user want to reset everything? Don't care about what is already here
 181         if (true === $this->defaultInput->getOption('reset')) {
 182             $this->defaultOutput->writeln('Droping database, creating database and schema, clearing the cache');
 183
 184             $this
 185                 ->runCommand('doctrine:database:drop', ['--force' => true])
 186                 ->runCommand('doctrine:database:create')
 187                 ->runCommand('doctrine:schema:create')
 188                 ->runCommand('cache:clear')
 189             ;
 190
 191             $this->defaultOutput->writeln('');
 192
 193             return $this;
 194         }
 195
 196         if (!$this->isDatabasePresent()) {
 197             $this->defaultOutput->writeln('Creating database and schema, clearing the cache');
 198
 199             $this
 200                 ->runCommand('doctrine:database:create')
 201                 ->runCommand('doctrine:schema:create')
 202                 ->runCommand('cache:clear')
 203             ;
 204
 205             $this->defaultOutput->writeln('');
 206
 207             return $this;
 208         }
 209
 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);
 212
 213         if ($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) {
 214             $this->defaultOutput->writeln('Droping database, creating database and schema');
 215
 216             $this
 217                 ->runCommand('doctrine:database:drop', ['--force' => true])
 218                 ->runCommand('doctrine:database:create')
 219                 ->runCommand('doctrine:schema:create')
 220             ;
 221         } elseif ($this->isSchemaPresent()) {
 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)) {
 224                 $this->defaultOutput->writeln('Droping schema and creating schema');
 225
 226                 $this
 227                     ->runCommand('doctrine:schema:drop', ['--force' => true])
 228                     ->runCommand('doctrine:schema:create')
 229                 ;
 230             }
 231         } else {
 232             $this->defaultOutput->writeln('Creating schema');
 233
 234             $this
 235                 ->runCommand('doctrine:schema:create')
 236             ;
 237         }
 238
 239         $this->defaultOutput->writeln('Clearing the cache');
 240         $this->runCommand('cache:clear');
 241
 242         $this->defaultOutput->writeln('');
 243
 244         return $this;
 245     }
 246
 247     protected function setupAdmin()
 248     {
 249         $this->defaultOutput->writeln('<info><comment>Step 3 of 4.</comment> Administration setup.</info>');
 250
 251         $questionHelper = $this->getHelperSet()->get('question');
 252         $question = new ConfirmationQuestion('Would you like to create a new admin user (recommended) ? (Y/n)', true);
 253
 254         if (!$questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) {
 255             return $this;
 256         }
 257
 258         $em = $this->getContainer()->get('doctrine.orm.entity_manager');
 259
 260         $userManager = $this->getContainer()->get('fos_user.user_manager');
 261         $user = $userManager->createUser();
 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
 272         $user->setEnabled(true);
 273         $user->addRole('ROLE_SUPER_ADMIN');
 274
 275         $em->persist($user);
 276
 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);
 280
 281         $this->defaultOutput->writeln('');
 282
 283         return $this;
 284     }
 285
 286     protected function setupConfig()
 287     {
 288         $this->defaultOutput->writeln('<info><comment>Step 4 of 4.</comment> Config setup.</info>');
 289         $em = $this->getContainer()->get('doctrine.orm.entity_manager');
 290
 291         // cleanup before insert new stuff
 292         $em->createQuery('DELETE FROM CraueConfigBundle:Setting')->execute();
 293
 294         $settings = [
 295             [
 296                 'name' => 'share_public',
 297                 'value' => '1',
 298                 'section' => 'entry',
 299             ],
 300             [
 301                 'name' => 'carrot',
 302                 'value' => '1',
 303                 'section' => 'entry',
 304             ],
 305             [
 306                 'name' => 'share_diaspora',
 307                 'value' => '1',
 308                 'section' => 'entry',
 309             ],
 310             [
 311                 'name' => 'diaspora_url',
 312                 'value' => 'http://diasporapod.com',
 313                 'section' => 'entry',
 314             ],
 315             [
 316                 'name' => 'share_unmark',
 317                 'value' => '1',
 318                 'section' => 'entry',
 319             ],
 320             [
 321                 'name' => 'unmark_url',
 322                 'value' => 'https://unmark.it',
 323                 'section' => 'entry',
 324             ],
 325             [
 326                 'name' => 'share_shaarli',
 327                 'value' => '1',
 328                 'section' => 'entry',
 329             ],
 330             [
 331                 'name' => 'shaarli_url',
 332                 'value' => 'http://myshaarli.com',
 333                 'section' => 'entry',
 334             ],
 335             [
 336                 'name' => 'share_mail',
 337                 'value' => '1',
 338                 'section' => 'entry',
 339             ],
 340             [
 341                 'name' => 'share_twitter',
 342                 'value' => '1',
 343                 'section' => 'entry',
 344             ],
 345             [
 346                 'name' => 'export_epub',
 347                 'value' => '1',
 348                 'section' => 'export',
 349             ],
 350             [
 351                 'name' => 'export_mobi',
 352                 'value' => '1',
 353                 'section' => 'export',
 354             ],
 355             [
 356                 'name' => 'export_pdf',
 357                 'value' => '1',
 358                 'section' => 'export',
 359             ],
 360             [
 361                 'name' => 'export_csv',
 362                 'value' => '1',
 363                 'section' => 'export',
 364             ],
 365             [
 366                 'name' => 'export_json',
 367                 'value' => '1',
 368                 'section' => 'export',
 369             ],
 370             [
 371                 'name' => 'export_txt',
 372                 'value' => '1',
 373                 'section' => 'export',
 374             ],
 375             [
 376                 'name' => 'export_xml',
 377                 'value' => '1',
 378                 'section' => 'export',
 379             ],
 380             [
 381                 'name' => 'import_with_redis',
 382                 'value' => '0',
 383                 'section' => 'import',
 384             ],
 385             [
 386                 'name' => 'import_with_rabbitmq',
 387                 'value' => '0',
 388                 'section' => 'import',
 389             ],
 390             [
 391                 'name' => 'show_printlink',
 392                 'value' => '1',
 393                 'section' => 'entry',
 394             ],
 395             [
 396                 'name' => 'wallabag_support_url',
 397                 'value' => 'https://www.wallabag.org/pages/support.html',
 398                 'section' => 'misc',
 399             ],
 400             [
 401                 'name' => 'wallabag_url',
 402                 'value' => '',
 403                 'section' => 'misc',
 404             ],
 405             [
 406                 'name' => 'piwik_enabled',
 407                 'value' => '0',
 408                 'section' => 'analytics',
 409             ],
 410             [
 411                 'name' => 'piwik_host',
 412                 'value' => 'v2.wallabag.org',
 413                 'section' => 'analytics',
 414             ],
 415             [
 416                 'name' => 'piwik_site_id',
 417                 'value' => '1',
 418                 'section' => 'analytics',
 419             ],
 420             [
 421                 'name' => 'demo_mode_enabled',
 422                 'value' => '0',
 423                 'section' => 'misc',
 424             ],
 425             [
 426                 'name' => 'demo_mode_username',
 427                 'value' => 'wallabag',
 428                 'section' => 'misc',
 429             ],
 430             [
 431                 'name' => 'download_images_enabled',
 432                 'value' => '0',
 433                 'section' => 'misc',
 434             ],
 435         ];
 436
 437         foreach ($settings as $setting) {
 438             $newSetting = new Setting();
 439             $newSetting->setName($setting['name']);
 440             $newSetting->setValue($setting['value']);
 441             $newSetting->setSection($setting['section']);
 442             $em->persist($newSetting);
 443         }
 444
 445         $em->flush();
 446
 447         $this->defaultOutput->writeln('');
 448
 449         return $this;
 450     }
 451
 452     /**
 453      * Run a command.
 454      *
 455      * @param string $command
 456      * @param array  $parameters Parameters to this command (usually 'force' => true)
 457      */
 458     protected function runCommand($command, $parameters = [])
 459     {
 460         $parameters = array_merge(
 461             ['command' => $command],
 462             $parameters,
 463             [
 464                 '--no-debug' => true,
 465                 '--env' => $this->defaultInput->getOption('env') ?: 'dev',
 466             ]
 467         );
 468
 469         if ($this->defaultInput->getOption('no-interaction')) {
 470             $parameters = array_merge($parameters, ['--no-interaction' => true]);
 471         }
 472
 473         $this->getApplication()->setAutoExit(false);
 474
 475         $output = new BufferedOutput();
 476         $exitCode = $this->getApplication()->run(new ArrayInput($parameters), $output);
 477
 478         if (0 !== $exitCode) {
 479             $this->getApplication()->setAutoExit(true);
 480
 481             $this->defaultOutput->writeln('');
 482             $this->defaultOutput->writeln('<error>The command "'.$command.'" generates some errors: </error>');
 483             $this->defaultOutput->writeln($output->fetch());
 484
 485             die();
 486         }
 487
 488         // PDO does not always close the connection after Doctrine commands.
 489         // See https://github.com/symfony/symfony/issues/11750.
 490         $this->getContainer()->get('doctrine')->getManager()->getConnection()->close();
 491
 492         return $this;
 493     }
 494
 495     /**
 496      * Check if the database already exists.
 497      *
 498      * @return bool
 499      */
 500     private function isDatabasePresent()
 501     {
 502         $connection = $this->getContainer()->get('doctrine')->getManager()->getConnection();
 503         $databaseName = $connection->getDatabase();
 504
 505         try {
 506             $schemaManager = $connection->getSchemaManager();
 507         } catch (\Exception $exception) {
 508             // mysql & sqlite
 509             if (false !== strpos($exception->getMessage(), sprintf("Unknown database '%s'", $databaseName))) {
 510                 return false;
 511             }
 512
 513             // pgsql
 514             if (false !== strpos($exception->getMessage(), sprintf('database "%s" does not exist', $databaseName))) {
 515                 return false;
 516             }
 517
 518             throw $exception;
 519         }
 520
 521         // custom verification for sqlite, since `getListDatabasesSQL` doesn't work for sqlite
 522         if ('sqlite' === $schemaManager->getDatabasePlatform()->getName()) {
 523             $params = $this->getContainer()->get('doctrine.dbal.default_connection')->getParams();
 524
 525             if (isset($params['path']) && file_exists($params['path'])) {
 526                 return true;
 527             }
 528
 529             return false;
 530         }
 531
 532         try {
 533             return in_array($databaseName, $schemaManager->listDatabases());
 534         } catch (\Doctrine\DBAL\Exception\DriverException $e) {
 535             // it means we weren't able to get database list, assume the database doesn't exist
 536
 537             return false;
 538         }
 539     }
 540
 541     /**
 542      * Check if the schema is already created.
 543      * If we found at least oen table, it means the schema exists.
 544      *
 545      * @return bool
 546      */
 547     private function isSchemaPresent()
 548     {
 549         $schemaManager = $this->getContainer()->get('doctrine')->getManager()->getConnection()->getSchemaManager();
 550
 551         return count($schemaManager->listTableNames()) > 0 ? true : false;
 552     }
 553 }