|
| 1 | +<?php |
| 2 | + |
| 3 | +/** |
| 4 | + * Joomla! Content Management System |
| 5 | + * |
| 6 | + * @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org> |
| 7 | + * @license GNU General Public License version 2 or later; see LICENSE.txt |
| 8 | + */ |
| 9 | + |
| 10 | +namespace Joomla\CMS\Console; |
| 11 | + |
| 12 | +use Joomla\CMS\Helper\PublicFolderGeneratorHelper; |
| 13 | +use Joomla\Console\Command\AbstractCommand; |
| 14 | +use Joomla\Filter\InputFilter; |
| 15 | +use Symfony\Component\Console\Command\Command; |
| 16 | +use Symfony\Component\Console\Input\InputInterface; |
| 17 | +use Symfony\Component\Console\Input\InputOption; |
| 18 | +use Symfony\Component\Console\Output\OutputInterface; |
| 19 | +use Symfony\Component\Console\Style\SymfonyStyle; |
| 20 | + |
| 21 | +// phpcs:disable PSR1.Files.SideEffects |
| 22 | +\defined('_JEXEC') or die; |
| 23 | +// phpcs:enable PSR1.Files.SideEffects |
| 24 | + |
| 25 | +/** |
| 26 | + * Console command for creating a public folder |
| 27 | + * |
| 28 | + * @since __DEPLOY_VERSION__ |
| 29 | + */ |
| 30 | +class SiteCreatePublicFolderCommand extends AbstractCommand |
| 31 | +{ |
| 32 | + /** |
| 33 | + * The default command name |
| 34 | + * |
| 35 | + * @var string |
| 36 | + * @since __DEPLOY_VERSION__ |
| 37 | + */ |
| 38 | + protected static $defaultName = 'site:create-public-folder'; |
| 39 | + |
| 40 | + /** |
| 41 | + * SymfonyStyle Object |
| 42 | + * @var object |
| 43 | + * @since __DEPLOY_VERSION__ |
| 44 | + */ |
| 45 | + private $ioStyle; |
| 46 | + |
| 47 | + /** |
| 48 | + * Stores the Input Object |
| 49 | + * @var object |
| 50 | + * @since __DEPLOY_VERSION__ |
| 51 | + */ |
| 52 | + private $cliInput; |
| 53 | + |
| 54 | + /** |
| 55 | + * The public folder path (absolute) |
| 56 | + * |
| 57 | + * @var string |
| 58 | + * |
| 59 | + * @since __DEPLOY_VERSION__ |
| 60 | + */ |
| 61 | + private $publicFolder; |
| 62 | + |
| 63 | + /** |
| 64 | + * Internal function to execute the command. |
| 65 | + * |
| 66 | + * @param InputInterface $input The input to inject into the command. |
| 67 | + * @param OutputInterface $output The output to inject into the command. |
| 68 | + * |
| 69 | + * @return integer The command exit code |
| 70 | + * |
| 71 | + * @since __DEPLOY_VERSION__ |
| 72 | + */ |
| 73 | + protected function doExecute(InputInterface $input, OutputInterface $output): int |
| 74 | + { |
| 75 | + $this->configureIO($input, $output); |
| 76 | + $this->ioStyle->title('Create a public folder'); |
| 77 | + |
| 78 | + $this->publicFolder = $this->getStringFromOption('public-folder', 'Please enter the absolute path to the public folder', true); |
| 79 | + |
| 80 | + // Remove the last (Windows || NIX) slash |
| 81 | + $this->publicFolder = rtrim((new InputFilter())->clean($this->publicFolder, 'PATH'), '/'); |
| 82 | + $this->publicFolder = rtrim($this->publicFolder, '\\'); |
| 83 | + |
| 84 | + if (!((new PublicFolderGeneratorHelper())->createPublicFolder($this->publicFolder))) { |
| 85 | + return Command::FAILURE; |
| 86 | + } |
| 87 | + |
| 88 | + $this->ioStyle->success("Public folder created! \nAdjust your server configuration to serve from the public folder."); |
| 89 | + |
| 90 | + return Command::SUCCESS; |
| 91 | + } |
| 92 | + |
| 93 | + /** |
| 94 | + * Method to get a value from option |
| 95 | + * |
| 96 | + * @param string $option set the option name |
| 97 | + * @param string $question set the question if user enters no value to option |
| 98 | + * @param bool $required is it required |
| 99 | + * |
| 100 | + * @return string |
| 101 | + * |
| 102 | + * @since __DEPLOY_VERSION__ |
| 103 | + */ |
| 104 | + public function getStringFromOption($option, $question, $required = true): string |
| 105 | + { |
| 106 | + $answer = (string) $this->cliInput->getOption($option); |
| 107 | + |
| 108 | + while (!$answer && $required) { |
| 109 | + $answer = (string) $this->ioStyle->ask($question); |
| 110 | + } |
| 111 | + |
| 112 | + if (!$required) { |
| 113 | + $answer = (string) $this->ioStyle->ask($question); |
| 114 | + } |
| 115 | + |
| 116 | + return $answer; |
| 117 | + } |
| 118 | + |
| 119 | + /** |
| 120 | + * Configure the IO. |
| 121 | + * |
| 122 | + * @param InputInterface $input The input to inject into the command. |
| 123 | + * @param OutputInterface $output The output to inject into the command. |
| 124 | + * |
| 125 | + * @return void |
| 126 | + * |
| 127 | + * @since __DEPLOY_VERSION__ |
| 128 | + */ |
| 129 | + private function configureIO(InputInterface $input, OutputInterface $output) |
| 130 | + { |
| 131 | + $this->cliInput = $input; |
| 132 | + $this->ioStyle = new SymfonyStyle($input, $output); |
| 133 | + } |
| 134 | + |
| 135 | + /** |
| 136 | + * Configure the command. |
| 137 | + * |
| 138 | + * @return void |
| 139 | + * |
| 140 | + * @since __DEPLOY_VERSION__ |
| 141 | + */ |
| 142 | + protected function configure(): void |
| 143 | + { |
| 144 | + $help = "<info>%command.name%</info> will create a public folder |
| 145 | + \nUsage: <info>php %command.full_name%</info>"; |
| 146 | + |
| 147 | + $this->addOption('public-folder', null, InputOption::VALUE_REQUIRED, 'public folder absolute path'); |
| 148 | + $this->setDescription('Create a public folder'); |
| 149 | + $this->setHelp($help); |
| 150 | + } |
| 151 | +} |
0 commit comments