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     protected function configure()
  30     {
  31         $this
  32             ->setName('wallabag:install')
  33             ->setDescription('Wallabag installer.')
  34             ->addOption(
  35                'reset',
  36                null,
  37                InputOption::VALUE_NONE,
  38                'Reset current database'
  39             )
  40         ;
  41     }
  42
  43     protected function execute(InputInterface $input, OutputInterface $output)
  44     {
  45         $this->defaultInput = $input;
  46         $this->defaultOutput = $output;
  47
  48         $output->writeln('<info>Installing Wallabag...</info>');
  49         $output->writeln('');
  50
  51         $this
  52             ->checkRequirements()
  53             ->setupDatabase()
  54             ->setupAdmin()
  55             ->setupAsset()
  56         ;
  57
  58         $output->writeln('<info>Wallabag has been successfully installed.</info>');
  59         $output->writeln('<comment>Just execute `php bin/console server:run` for using wallabag: http://localhost:8000</comment>');
  60     }
  61
  62     protected function checkRequirements()
  63     {
  64         $this->defaultOutput->writeln('<info><comment>Step 1 of 4.</comment> Checking system requirements.</info>');
  65
  66         $fulfilled = true;
  67
  68         $label = '<comment>PCRE</comment>';
  69         if (extension_loaded('pcre')) {
  70             $status = '<info>OK!</info>';
  71             $help = '';
  72         } else {
  73             $fulfilled = false;
  74             $status = '<error>ERROR!</error>';
  75             $help = 'You should enabled PCRE extension';
  76         }
  77         $rows[] = array($label, $status, $help);
  78
  79         $label = '<comment>DOM</comment>';
  80         if (extension_loaded('DOM')) {
  81             $status = '<info>OK!</info>';
  82             $help = '';
  83         } else {
  84             $fulfilled = false;
  85             $status = '<error>ERROR!</error>';
  86             $help = 'You should enabled DOM extension';
  87         }
  88         $rows[] = array($label, $status, $help);
  89
  90         $table = new Table($this->defaultOutput);
  91         $table
  92             ->setHeaders(array('Checked', 'Status', 'Recommendation'))
  93             ->setRows($rows)
  94             ->render();
  95
  96         if (!$fulfilled) {
  97             throw new \RuntimeException('Some system requirements are not fulfilled. Please check output messages and fix them.');
  98         }
  99
 100         $this->defaultOutput->writeln('<info>Success! Your system can run Wallabag properly.</info>');
 101
 102         $this->defaultOutput->writeln('');
 103
 104         return $this;
 105     }
 106
 107     protected function setupDatabase()
 108     {
 109         $this->defaultOutput->writeln('<info><comment>Step 2 of 4.</comment> Setting up database.</info>');
 110
 111         // user want to reset everything? Don't care about what is already here
 112         if (true === $this->defaultInput->getOption('reset')) {
 113             $this->defaultOutput->writeln('Droping database, creating database and schema, clearing the cache');
 114
 115             $this
 116                 ->runCommand('doctrine:database:drop', array('--force' => true))
 117                 ->runCommand('doctrine:database:create')
 118                 ->runCommand('doctrine:schema:create')
 119                 ->runCommand('cache:clear')
 120             ;
 121
 122             $this->defaultOutput->writeln('');
 123
 124             return $this;
 125         }
 126
 127         if (!$this->isDatabasePresent()) {
 128             $this->defaultOutput->writeln('Creating database and schema, clearing the cache');
 129
 130             $this
 131                 ->runCommand('doctrine:database:create')
 132                 ->runCommand('doctrine:schema:create')
 133                 ->runCommand('cache:clear')
 134             ;
 135
 136             $this->defaultOutput->writeln('');
 137
 138             return $this;
 139         }
 140
 141         $questionHelper = $this->getHelper('question');
 142         $question = new ConfirmationQuestion('It appears that your database already exists. Would you like to reset it? (y/N)', false);
 143
 144         if ($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) {
 145             $this->defaultOutput->writeln('Droping database, creating database and schema');
 146
 147             $this
 148                 ->runCommand('doctrine:database:drop', array('--force' => true))
 149                 ->runCommand('doctrine:database:create')
 150                 ->runCommand('doctrine:schema:create')
 151             ;
 152         } elseif ($this->isSchemaPresent()) {
 153             $question = new ConfirmationQuestion('Seems like your database contains schema. Do you want to reset it? (y/N)', false);
 154             if ($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) {
 155                 $this->defaultOutput->writeln('Droping schema and creating schema');
 156
 157                 $this
 158                     ->runCommand('doctrine:schema:drop', array('--force' => true))
 159                     ->runCommand('doctrine:schema:create')
 160                 ;
 161             }
 162         } else {
 163             $this->defaultOutput->writeln('Creating schema');
 164
 165             $this
 166                 ->runCommand('doctrine:schema:create')
 167             ;
 168         }
 169
 170         $this->defaultOutput->writeln('Clearing the cache');
 171         $this->runCommand('cache:clear');
 172
 173         $this->defaultOutput->writeln('');
 174
 175         return $this;
 176     }
 177
 178     protected function setupAdmin()
 179     {
 180         $this->defaultOutput->writeln('<info><comment>Step 3 of 4.</comment> Administration setup.</info>');
 181
 182         $questionHelper = $this->getHelperSet()->get('question');
 183         $question = new ConfirmationQuestion('Would you like to create a new user ? (y/N)', false);
 184
 185         if (!$questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) {
 186             return $this;
 187         }
 188
 189         $em = $this->getContainer()->get('doctrine.orm.entity_manager');
 190
 191         $userManager = $this->getContainer()->get('fos_user.user_manager');
 192         $user = $userManager->createUser();
 193
 194         $question = new Question('Username (default: wallabag) :', 'wallabag');
 195         $user->setUsername($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question));
 196
 197         $question = new Question('Password (default: wallabag) :', 'wallabag');
 198         $user->setPlainPassword($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question));
 199
 200         $question = new Question('Email:', '');
 201         $user->setEmail($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question));
 202
 203         $user->setEnabled(true);
 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
 316         foreach ($settings as $setting) {
 317             $newSetting = new Setting();
 318             $newSetting->setName($setting['name']);
 319             $newSetting->setValue($setting['value']);
 320             $newSetting->setSection($setting['section']);
 321             $em->persist($newSetting);
 322         }
 323
 324         $em->flush();
 325
 326         $this->defaultOutput->writeln('');
 327
 328         return $this;
 329     }
 330
 331     protected function setupAsset()
 332     {
 333         $this->defaultOutput->writeln('<info><comment>Step 4 of 4.</comment> Installing assets.</info>');
 334
 335         $this
 336             ->runCommand('assets:install')
 337             ->runCommand('assetic:dump')
 338         ;
 339
 340         $this->defaultOutput->writeln('');
 341
 342         return $this;
 343     }
 344
 345     /**
 346      * Run a command.
 347      *
 348      * @param string $command
 349      * @param array  $parameters Parameters to this command (usually 'force' => true)
 350      */
 351     protected function runCommand($command, $parameters = array())
 352     {
 353         $parameters = array_merge(
 354             array('command' => $command),
 355             $parameters,
 356             array(
 357                 '--no-debug' => true,
 358                 '--env' => $this->defaultInput->getOption('env') ?: 'dev',
 359             )
 360         );
 361
 362         if ($this->defaultInput->getOption('no-interaction')) {
 363             $parameters = array_merge($parameters, array('--no-interaction' => true));
 364         }
 365
 366         $this->getApplication()->setAutoExit(false);
 367         $exitCode = $this->getApplication()->run(new ArrayInput($parameters), new NullOutput());
 368
 369         if (0 !== $exitCode) {
 370             $this->getApplication()->setAutoExit(true);
 371
 372             $errorMessage = sprintf('The command "%s" terminated with an error code: %u.', $command, $exitCode);
 373             $this->defaultOutput->writeln("<error>$errorMessage</error>");
 374             $exception = new \Exception($errorMessage, $exitCode);
 375
 376             throw $exception;
 377         }
 378
 379         // PDO does not always close the connection after Doctrine commands.
 380         // See https://github.com/symfony/symfony/issues/11750.
 381         $this->getContainer()->get('doctrine')->getManager()->getConnection()->close();
 382
 383         return $this;
 384     }
 385
 386     /**
 387      * Check if the database already exists.
 388      *
 389      * @return bool
 390      */
 391     private function isDatabasePresent()
 392     {
 393         $connection = $this->getContainer()->get('doctrine')->getManager()->getConnection();
 394         $databaseName = $connection->getDatabase();
 395
 396         try {
 397             $schemaManager = $connection->getSchemaManager();
 398         } catch (\Exception $exception) {
 399             // mysql & sqlite
 400             if (false !== strpos($exception->getMessage(), sprintf("Unknown database '%s'", $databaseName))) {
 401                 return false;
 402             }
 403
 404             // pgsql
 405             if (false !== strpos($exception->getMessage(), sprintf('database "%s" does not exist', $databaseName))) {
 406                 return false;
 407             }
 408
 409             throw $exception;
 410         }
 411
 412         // custom verification for sqlite, since `getListDatabasesSQL` doesn't work for sqlite
 413         if ('sqlite' == $schemaManager->getDatabasePlatform()->getName()) {
 414             $params = $this->getContainer()->get('doctrine.dbal.default_connection')->getParams();
 415
 416             if (isset($params['path']) && file_exists($params['path'])) {
 417                 return true;
 418             }
 419
 420             return false;
 421         }
 422
 423         return in_array($databaseName, $schemaManager->listDatabases());
 424     }
 425
 426     /**
 427      * Check if the schema is already created.
 428      * If we found at least oen table, it means the schema exists.
 429      *
 430      * @return bool
 431      */
 432     private function isSchemaPresent()
 433     {
 434         $schemaManager = $this->getContainer()->get('doctrine')->getManager()->getConnection()->getSchemaManager();
 435
 436         return count($schemaManager->listTableNames()) > 0 ? true : false;
 437     }
 438 }