[5.0] Introduce a CLI UI for creating a public folder

includes/app.php

@@ -19,10 +19,6 @@
 
 require_once __DIR__ . '/defines.php';
 
-if (!defined('JPATH_PUBLIC')) {
-    define('JPATH_PUBLIC', JPATH_ROOT);
-}
-
 // Check for presence of vendor dependencies not included in the git repository
 if (!file_exists(JPATH_LIBRARIES . '/vendor/autoload.php') || !is_dir(JPATH_PUBLIC . '/media/vendor')) {
     echo file_get_contents(JPATH_ROOT . '/templates/system/build_incomplete.html');

installation/forms/setup.xml

@@ -176,4 +176,15 @@
 		/>
 
 	</fieldset>
+
+	<fieldset name="expert">
+		<field
+			name="public_folder"
+			type="text"
+			label="INSTL_PUBLIC_FOLDER_LABEL"
+			description="INSTL_PUBLIC_FOLDER_DESCRIPTION"
+			default=""
+			filter="string"
+		/>
+	</fieldset>
 </form>

installation/language/en-GB/joomla.cli.ini

@@ -33,3 +33,5 @@ INSTL_DATABASE_USER_DESC="Database username"
 INSTL_DATABASE_USER_DESC_SHORT="Database username"
 INSTL_SITE_NAME_DESC="Enter the name of your Joomla site"
 INSTL_SITE_NAME_DESC_SHORT="Name of the website"
+INSTL_PUBLIC_FOLDER_LABEL="Relative or absolute path to the public folder"
+INSTL_PUBLIC_FOLDER_DESC_SHORT="Relative or absolute path to the public folder"

installation/language/en-GB/joomla.ini

@@ -114,6 +114,10 @@ INSTL_SITE="Main Configuration"
 INSTL_SITE_DEVMODE_LABEL="We detected development mode"
 INSTL_SITE_NAME_DESC="Enter the name of your Joomla site."
 
+; Expert View
+INSTL_PUBLIC_FOLDER_LABEL="Relative or absolute path to the public folder"
+INSTL_PUBLIC_FOLDER_DESC_SHORT="Relative or absolute path to the public folder"
+
 ; Complete view
 INSTL_COMPLETE_ERROR_FOLDER_DELETE="The \"%s\" folder could not be deleted. Please manually delete the folder."
 INSTL_COMPLETE_REMOVE_FOLDER="Remove \"%s\" folder"

installation/src/Console/InstallCommand.php

@@ -12,7 +12,7 @@
 use Joomla\CMS\Factory;
 use Joomla\CMS\Form\FormField;
 use Joomla\CMS\Form\FormHelper;
-use Joomla\CMS\Installation\Application\CliInstallationApplication;
+use Joomla\CMS\Helper\PublicFolderGeneratorHelper;
 use Joomla\CMS\Installation\Model\ChecksModel;
 use Joomla\CMS\Installation\Model\CleanupModel;
 use Joomla\CMS\Installation\Model\DatabaseModel;
@@ -181,6 +181,16 @@ protected function doExecute(InputInterface $input, OutputInterface $output): in
             $this->ioStyle->writeln('OK');
         }
 
+        if (!empty($cfg['public_folder'])) {
+            $this->ioStyle->write('Creating the public folder...');
+
+            if (!(new PublicFolderGeneratorHelper())->createPublicFolder($cfg['public_folder'])) {
+                return Command::FAILURE;
+            }
+
+            $this->ioStyle->writeln('OK');
+        }
+
         $this->ioStyle->success('Joomla has been installed');
 
         return Command::SUCCESS;
@@ -363,7 +373,7 @@ protected function getStringFromOption($option, $question, FormField $field): st
 
         // We don't have a CLI option and now interactively get that from the user.
         while (\is_null($answer) || $answer === false) {
-            if (in_array($option, ['admin-password', 'db-pass'])) {
+            if (in_array($option, ['admin-password', 'db-pass', 'public_folder'])) {
                 $answer = $this->ioStyle->askHidden($question);
             } else {
                 $answer = $this->ioStyle->ask(
@@ -379,7 +389,7 @@ protected function getStringFromOption($option, $question, FormField $field): st
                 $answer = false;
             }
 
-            if ($option == 'db-pass' && $valid && $answer == null) {
+            if (($option == 'db-pass' || $option == 'public_folder') && $valid && $answer == null) {
                 return '';
             }
         }

installation/src/Model/SetupModel.php

@@ -109,6 +109,11 @@ public function getForm($view = null)
             return false;
         }
 
+        /** @todo make this available in web installert too */
+        if (!Factory::getApplication()->isClient('cli_installation')) {
+            $form->removeField('public_folder');
+        }
+
         // Check the session for previously entered form data.
         $data = (array) $this->getOptions();
 

libraries/src/Application/ConsoleApplication.php

@@ -310,6 +310,7 @@ protected function getDefaultCommands(): array
                 new Console\DeleteUserCommand($this->getDatabase()),
                 new Console\ChangeUserPasswordCommand(),
                 new Console\ListUserCommand($this->getDatabase()),
+                new Console\SiteCreatePublicFolderCommand(),
             ]
         );
     }

libraries/src/Console/SiteCreatePublicFolderCommand.php

@@ -0,0 +1,151 @@
+<?php
+
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\CMS\Console;
+
+use Joomla\CMS\Helper\PublicFolderGeneratorHelper;
+use Joomla\Console\Command\AbstractCommand;
+use Joomla\Filter\InputFilter;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Console command for creating a public folder
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class SiteCreatePublicFolderCommand extends AbstractCommand
+{
+    /**
+     * The default command name
+     *
+     * @var    string
+     * @since  __DEPLOY_VERSION__
+     */
+    protected static $defaultName = 'site:create-public-folder';
+
+    /**
+     * SymfonyStyle Object
+     * @var   object
+     * @since __DEPLOY_VERSION__
+     */
+    private $ioStyle;
+
+    /**
+     * Stores the Input Object
+     * @var   object
+     * @since __DEPLOY_VERSION__
+     */
+    private $cliInput;
+
+    /**
+     * The public folder path (absolute)
+     *
+     * @var    string
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    private $publicFolder;
+
+    /**
+     * Internal function to execute the command.
+     *
+     * @param   InputInterface   $input   The input to inject into the command.
+     * @param   OutputInterface  $output  The output to inject into the command.
+     *
+     * @return  integer  The command exit code
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    protected function doExecute(InputInterface $input, OutputInterface $output): int
+    {
+        $this->configureIO($input, $output);
+        $this->ioStyle->title('Create a public folder');
+
+        $this->publicFolder = $this->getStringFromOption('public-folder', 'Please enter the absolute path to the public folder', true);
+
+        // Remove the last (Windows || NIX) slash
+        $this->publicFolder = rtrim((new InputFilter())->clean($this->publicFolder, 'PATH'), '/');
+        $this->publicFolder = rtrim($this->publicFolder, '\\');
+
+        if (!((new PublicFolderGeneratorHelper())->createPublicFolder($this->publicFolder))) {
+            return Command::FAILURE;
+        }
+
+        $this->ioStyle->success("Public folder created! \nAdjust your server configuration to serve from the public folder.");
+
+        return Command::SUCCESS;
+    }
+
+    /**
+     * Method to get a value from option
+     *
+     * @param   string  $option    set the option name
+     * @param   string  $question  set the question if user enters no value to option
+     * @param   bool    $required  is it required
+     *
+     * @return  string
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getStringFromOption($option, $question, $required = true): string
+    {
+        $answer = (string) $this->cliInput->getOption($option);
+
+        while (!$answer && $required) {
+            $answer = (string) $this->ioStyle->ask($question);
+        }
+
+        if (!$required) {
+            $answer = (string) $this->ioStyle->ask($question);
+        }
+
+        return $answer;
+    }
+
+    /**
+     * Configure the IO.
+     *
+     * @param   InputInterface   $input   The input to inject into the command.
+     * @param   OutputInterface  $output  The output to inject into the command.
+     *
+     * @return  void
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    private function configureIO(InputInterface $input, OutputInterface $output)
+    {
+        $this->cliInput = $input;
+        $this->ioStyle  = new SymfonyStyle($input, $output);
+    }
+
+    /**
+     * Configure the command.
+     *
+     * @return  void
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    protected function configure(): void
+    {
+        $help = "<info>%command.name%</info> will create a public folder
+		\nUsage: <info>php %command.full_name%</info>";
+
+        $this->addOption('public-folder', null, InputOption::VALUE_REQUIRED, 'public folder absolute path');
+        $this->setDescription('Create a public folder');
+        $this->setHelp($help);
+    }
+}