src/Wallabag/CoreBundle/Command/InstallCommand.php

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