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