vendor/friendsofsymfony/ckeditor-bundle/src/Command/CKEditorInstallerCommand.php line 290

  1. <?php
  3. /*
  4.  * This file is part of the FOSCKEditor Bundle.
  5.  *
  6.  * (c) 2018 - present  Friends of Symfony
  7.  * (c) 2009 - 2017     Eric GELOEN <geloen.eric@gmail.com>
  8.  *
  9.  * For the full copyright and license information, please read the LICENSE
  10.  * file that was distributed with this source code.
  11.  */
  13. namespace FOS\CKEditorBundle\Command;
  15. use FOS\CKEditorBundle\Installer\CKEditorInstaller;
  16. use Symfony\Component\Console\Command\Command;
  17. use Symfony\Component\Console\Helper\ProgressBar;
  18. use Symfony\Component\Console\Helper\QuestionHelper;
  19. use Symfony\Component\Console\Input\InputArgument;
  20. use Symfony\Component\Console\Input\InputInterface;
  21. use Symfony\Component\Console\Input\InputOption;
  22. use Symfony\Component\Console\Output\NullOutput;
  23. use Symfony\Component\Console\Output\OutputInterface;
  24. use Symfony\Component\Console\Question\ChoiceQuestion;
  26. /**
  27.  * @author GeLo <geloen.eric@gmail.com>
  28.  */
  29. final class CKEditorInstallerCommand extends Command
  30. {
  31.     /**
  32.      * @var CKEditorInstaller
  33.      */
  34.     private $installer;
  36.     public function __construct(CKEditorInstaller $installer)
  37.     {
  38.         parent::__construct();
  40.         $this->installer = $installer;
  41.     }
  43.     protected function configure(): void
  44.     {
  45.         $this
  46.             ->setName('ckeditor:install')
  47.             ->setDescription('Install CKEditor')
  48.             ->addArgument('path', InputArgument::OPTIONAL, 'Where to install CKEditor')
  49.             ->addOption(
  50.                 'release',
  51.                 null,
  52.                 InputOption::VALUE_OPTIONAL,
  53.                 'CKEditor release (basic, standard, full or custom)'
  54.             )
  55.             ->addOption(
  56.                 'custom-build-id',
  57.                 null,
  58.                 InputOption::VALUE_OPTIONAL,
  59.                 'CKEditor custom build ID'
  60.             )
  61.             ->addOption('tag', null, InputOption::VALUE_OPTIONAL, 'CKEditor tag (x.y.z or latest)')
  62.             ->addOption(
  63.                 'clear',
  64.                 null,
  65.                 InputOption::VALUE_OPTIONAL,
  66.                 'How to clear previous CKEditor installation (drop, keep or skip)'
  67.             )
  68.             ->addOption(
  69.                 'exclude',
  70.                 null,
  71.                 InputOption::VALUE_IS_ARRAY | InputOption::VALUE_OPTIONAL,
  72.                 'Path to exclude when extracting CKEditor'
  73.             )
  74.             ->addOption(
  75.                 'no-progress-bar',
  76.                 'nobar',
  77.                 InputOption::VALUE_NONE,
  78.                 'Hide the progress bars?'
  79.             )
  80.             ->setHelp(
  81.                 <<<'EOF'
  82. The <info>%command.name%</info> command install CKEditor in your application:
  84.   <info>php %command.full_name%</info>
  85.   
  86. You can install it at a specific path (absolute):
  88.   <info>php %command.full_name% path</info>
  89.   
  90. You can install a specific release (basic, standard or full):
  92.   <info>php %command.full_name% --release=full</info>
  93.   
  94. You can install a specific version:
  96.   <info>php %command.full_name% --tag=4.7.0</info>
  98. You can install custom build generated on https://ckeditor.com/cke4/builder:
  100.   <info>php %command.full_name% --release=custom --custom-build-id=574a82a0d3e9226d94b0e91d10eaa372</info>
  102. If there is a previous CKEditor installation detected, 
  103. you can control how it should be handled in non-interactive mode:
  105.   <info>php %command.full_name% --clear=drop</info>
  106.   <info>php %command.full_name% --clear=keep</info>
  107.   <info>php %command.full_name% --clear=skip</info>
  108.   
  109. You can exclude path(s) when extracting CKEditor:
  111.   <info>php %command.full_name% --exclude=samples --exclude=adapters</info>
  112. EOF
  113.             );
  114.     }
  116.     protected function execute(InputInterface $input, OutputInterface $output): int
  117.     {
  118.         $this->title($output);
  120.         $success = $this->installer->install($this->createOptions($input, $output));
  122.         if ($success) {
  123.             $this->success('CKEditor has been successfully installed...', $output);
  124.         } else {
  125.             $this->info('CKEditor installation has been skipped...', $output);
  126.         }
  128.         return 0;
  129.     }
  131.     private function createOptions(InputInterface $input, OutputInterface $output): array
  132.     {
  133.         $options = ['notifier' => $this->createNotifier($input, $output)];
  135.         if ($input->hasArgument('path')) {
  136.             $options['path'] = $input->getArgument('path');
  137.         }
  139.         if ($input->hasOption('release')) {
  140.             $options['release'] = $input->getOption('release');
  141.         }
  143.         if ($input->hasOption('custom-build-id')) {
  144.             $options['custom_build_id'] = $input->getOption('custom-build-id');
  145.         }
  147.         if ($input->hasOption('tag')) {
  148.             $options['version'] = $input->getOption('tag');
  149.         }
  151.         if ($input->hasOption('exclude')) {
  152.             $options['excludes'] = $input->getOption('exclude');
  153.         }
  155.         if ($input->hasOption('clear')) {
  156.             $options['clear'] = $input->getOption('clear');
  157.         }
  159.         return array_filter($options);
  160.     }
  162.     private function createNotifier(InputInterface $input, OutputInterface $output): \Closure
  163.     {
  164.         $barOutput = $input->getOption('no-progress-bar') ? new NullOutput() : $output;
  166.         $clear = new ProgressBar($barOutput);
  167.         $download = new ProgressBar($barOutput);
  168.         $extract = new ProgressBar($barOutput);
  170.         return function ($type, $data) use ($input, $output, $barOutput, $clear, $download, $extract) {
  171.             switch ($type) {
  172.                 case CKEditorInstaller::NOTIFY_CLEAR:
  173.                     $result = $this->choice(
  174.                         [
  175.                             sprintf('CKEditor is already installed in "%s"...', $data),
  176.                             '',
  177.                             'What do you want to do?',
  178.                         ],
  179.                         $choices = [
  180.                             CKEditorInstaller::CLEAR_DROP => 'Drop the directory & reinstall CKEditor',
  181.                             CKEditorInstaller::CLEAR_KEEP => 'Keep the directory & reinstall CKEditor by overriding files',
  182.                             CKEditorInstaller::CLEAR_SKIP => 'Skip installation',
  183.                         ],
  184.                         CKEditorInstaller::CLEAR_DROP,
  185.                         $input,
  186.                         $output
  187.                     );
  189.                     if (false !== ($key = array_search($result, $choices, true))) {
  190.                         $result = $key;
  191.                     }
  193.                     if (CKEditorInstaller::CLEAR_DROP === $result) {
  194.                         $this->comment(sprintf('Dropping CKEditor from "%s"', $data), $output);
  195.                     }
  197.                     return $result;
  199.                 case CKEditorInstaller::NOTIFY_CLEAR_ARCHIVE:
  200.                     $this->comment(sprintf('Dropping CKEditor ZIP archive "%s"', $data), $output);
  202.                     break;
  204.                 case CKEditorInstaller::NOTIFY_CLEAR_COMPLETE:
  205.                     $this->finishProgressBar($clear, $barOutput);
  207.                     break;
  209.                 case CKEditorInstaller::NOTIFY_CLEAR_PROGRESS:
  210.                     $clear->advance();
  212.                     break;
  214.                 case CKEditorInstaller::NOTIFY_CLEAR_SIZE:
  215.                     $clear->start($data);
  217.                     break;
  219.                 case CKEditorInstaller::NOTIFY_DOWNLOAD:
  220.                     $this->comment(sprintf('Downloading CKEditor ZIP archive from "%s"', $data), $output);
  222.                     break;
  224.                 case CKEditorInstaller::NOTIFY_DOWNLOAD_COMPLETE:
  225.                     $this->finishProgressBar($download, $barOutput);
  227.                     break;
  229.                 case CKEditorInstaller::NOTIFY_DOWNLOAD_PROGRESS:
  230.                     $download->setProgress($data);
  232.                     break;
  234.                 case CKEditorInstaller::NOTIFY_DOWNLOAD_SIZE:
  235.                     $download->start($data);
  237.                     break;
  239.                 case CKEditorInstaller::NOTIFY_EXTRACT:
  240.                     $this->comment(sprintf('Extracting CKEditor ZIP archive to "%s"', $data), $output);
  242.                     break;
  244.                 case CKEditorInstaller::NOTIFY_EXTRACT_COMPLETE:
  245.                     $this->finishProgressBar($extract, $barOutput);
  247.                     break;
  249.                 case CKEditorInstaller::NOTIFY_EXTRACT_PROGRESS:
  250.                     $extract->advance();
  252.                     break;
  254.                 case CKEditorInstaller::NOTIFY_EXTRACT_SIZE:
  255.                     $extract->start($data);
  257.                     break;
  258.             }
  259.         };
  260.     }
  262.     private function title(OutputInterface $output): void
  263.     {
  264.         $output->writeln(
  265.             [
  266.                 '----------------------',
  267.                 '| CKEditor Installer |',
  268.                 '----------------------',
  269.                 '',
  270.             ]
  271.         );
  272.     }
  274.     private function comment(string $message, OutputInterface $output): void
  275.     {
  276.         $output->writeln(' // '.$message);
  277.         $output->writeln('');
  278.     }
  280.     private function success(string $message, OutputInterface $output): void
  281.     {
  282.         $this->block('[OK] - '.$message, $output, 'green', 'black');
  283.     }
  285.     private function info(string $message, OutputInterface $output): void
  286.     {
  287.         $this->block('[INFO] - '.$message, $output, 'yellow', 'black');
  288.     }
  290.     private function block(
  291.         string $message,
  292.         OutputInterface $output,
  293.         string $background = null,
  294.         string $font = null
  295.     ): void {
  296.         $options = [];
  298.         if (null !== $background) {
  299.             $options[] = 'bg='.$background;
  300.         }
  302.         if (null !== $font) {
  303.             $options[] = 'fg='.$font;
  304.         }
  306.         $pattern = ' %s ';
  308.         if (!empty($options)) {
  309.             $pattern = '<'.implode(';', $options).'>'.$pattern.'</>';
  310.         }
  312.         $output->writeln($block = sprintf($pattern, str_repeat(' ', strlen($message))));
  313.         $output->writeln(sprintf($pattern, $message));
  314.         $output->writeln($block);
  315.     }
  317.     /**
  318.      * @param string[] $question
  319.      * @param string[] $choices
  320.      */
  321.     private function choice(
  322.         array $question,
  323.         array $choices,
  324.         string $default,
  325.         InputInterface $input,
  326.         OutputInterface $output
  327.     ): ?string {
  328.         $helper = new QuestionHelper();
  330.         if (is_array($question)) {
  331.             $question = implode("\n", $question);
  332.         }
  334.         $result = $helper->ask(
  335.             $input,
  336.             $output,
  337.             new ChoiceQuestion($question, $choices, $default)
  338.         );
  340.         $output->writeln('');
  342.         return $result;
  343.     }
  345.     private function finishProgressBar(ProgressBar $progress, OutputInterface $output): void
  346.     {
  347.         $progress->finish();
  348.         $output->writeln(['', '']);
  349.     }
  350. }