Initial

system/Commands/Utilities/Environment.php

@@ -0,0 +1,155 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Commands\Utilities;
+
+use CodeIgniter\CLI\BaseCommand;
+use CodeIgniter\CLI\CLI;
+use CodeIgniter\Config\DotEnv;
+
+/**
+ * Command to display the current environment,
+ * or set a new one in the `.env` file.
+ */
+final class Environment extends BaseCommand
+{
+    /**
+     * The group the command is lumped under
+     * when listing commands.
+     *
+     * @var string
+     */
+    protected $group = 'CodeIgniter';
+
+    /**
+     * The Command's name
+     *
+     * @var string
+     */
+    protected $name = 'env';
+
+    /**
+     * The Command's short description
+     *
+     * @var string
+     */
+    protected $description = 'Retrieves the current environment, or set a new one.';
+
+    /**
+     * The Command's usage
+     *
+     * @var string
+     */
+    protected $usage = 'env [<environment>]';
+
+    /**
+     * The Command's arguments
+     *
+     * @var array<string, string>
+     */
+    protected $arguments = [
+        'environment' => '[Optional] The new environment to set. If none is provided, this will print the current environment.',
+    ];
+
+    /**
+     * The Command's options
+     *
+     * @var array
+     */
+    protected $options = [];
+
+    /**
+     * Allowed values for environment. `testing` is excluded
+     * since spark won't work on it.
+     *
+     * @var array<int, string>
+     */
+    private static $knownTypes = [
+        'production',
+        'development',
+    ];
+
+    /**
+     * {@inheritDoc}
+     */
+    public function run(array $params)
+    {
+        if ($params === []) {
+            CLI::write(sprintf('Your environment is currently set as %s.', CLI::color($_SERVER['CI_ENVIRONMENT'] ?? ENVIRONMENT, 'green')));
+            CLI::newLine();
+
+            return;
+        }
+
+        $env = strtolower(array_shift($params));
+
+        if ($env === 'testing') {
+            CLI::error('The "testing" environment is reserved for PHPUnit testing.', 'light_gray', 'red');
+            CLI::error('You will not be able to run spark under a "testing" environment.', 'light_gray', 'red');
+            CLI::newLine();
+
+            return;
+        }
+
+        if (! in_array($env, self::$knownTypes, true)) {
+            CLI::error(sprintf('Invalid environment type "%s". Expected one of "%s".', $env, implode('" and "', self::$knownTypes)), 'light_gray', 'red');
+            CLI::newLine();
+
+            return;
+        }
+
+        if (! $this->writeNewEnvironmentToEnvFile($env)) {
+            CLI::error('Error in writing new environment to .env file.', 'light_gray', 'red');
+            CLI::newLine();
+
+            return;
+        }
+
+        // force DotEnv to reload the new environment
+        // however we cannot redefine the ENVIRONMENT constant
+        putenv('CI_ENVIRONMENT');
+        unset($_ENV['CI_ENVIRONMENT'], $_SERVER['CI_ENVIRONMENT']);
+        (new DotEnv(ROOTPATH))->load();
+
+        CLI::write(sprintf('Environment is successfully changed to "%s".', $env), 'green');
+        CLI::write('The ENVIRONMENT constant will be changed in the next script execution.');
+        CLI::newLine();
+    }
+
+    /**
+     * @see https://regex101.com/r/4sSORp/1 for the regex in action
+     */
+    private function writeNewEnvironmentToEnvFile(string $newEnv): bool
+    {
+        $baseEnv = ROOTPATH . 'env';
+        $envFile = ROOTPATH . '.env';
+
+        if (! is_file($envFile)) {
+            if (! is_file($baseEnv)) {
+                CLI::write('Both default shipped `env` file and custom `.env` are missing.', 'yellow');
+                CLI::write('It is impossible to write the new environment type.', 'yellow');
+                CLI::newLine();
+
+                return false;
+            }
+
+            copy($baseEnv, $envFile);
+        }
+
+        $pattern = preg_quote($_SERVER['CI_ENVIRONMENT'] ?? ENVIRONMENT, '/');
+        $pattern = sprintf('/^[#\s]*CI_ENVIRONMENT[=\s]+%s$/m', $pattern);
+
+        return file_put_contents(
+            $envFile,
+            preg_replace($pattern, "\nCI_ENVIRONMENT = {$newEnv}", file_get_contents($envFile), -1, $count)
+        ) !== false && $count > 0;
+    }
+}

system/Commands/Utilities/Namespaces.php

@@ -0,0 +1,95 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Commands\Utilities;
+
+use CodeIgniter\CLI\BaseCommand;
+use CodeIgniter\CLI\CLI;
+use Config\Autoload;
+
+/**
+ * Lists namespaces set in Config\Autoload with their
+ * full server path. Helps you to verify that you have
+ * the namespaces setup correctly.
+ */
+class Namespaces extends BaseCommand
+{
+    /**
+     * The group the command is lumped under
+     * when listing commands.
+     *
+     * @var string
+     */
+    protected $group = 'CodeIgniter';
+
+    /**
+     * The Command's name
+     *
+     * @var string
+     */
+    protected $name = 'namespaces';
+
+    /**
+     * the Command's short description
+     *
+     * @var string
+     */
+    protected $description = 'Verifies your namespaces are setup correctly.';
+
+    /**
+     * the Command's usage
+     *
+     * @var string
+     */
+    protected $usage = 'namespaces';
+
+    /**
+     * the Command's Arguments
+     *
+     * @var array
+     */
+    protected $arguments = [];
+
+    /**
+     * the Command's Options
+     *
+     * @var array
+     */
+    protected $options = [];
+
+    /**
+     * Displays the help for the spark cli script itself.
+     */
+    public function run(array $params)
+    {
+        $config = new Autoload();
+
+        $tbody = [];
+
+        foreach ($config->psr4 as $ns => $path) {
+            $path = realpath($path) ?: $path;
+
+            $tbody[] = [
+                $ns,
+                realpath($path) ?: $path,
+                is_dir($path) ? 'Yes' : 'MISSING',
+            ];
+        }
+
+        $thead = [
+            'Namespace',
+            'Path',
+            'Found?',
+        ];
+
+        CLI::table($tbody, $thead);
+    }
+}

system/Commands/Utilities/Publish.php

@@ -0,0 +1,104 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Commands\Utilities;
+
+use CodeIgniter\CLI\BaseCommand;
+use CodeIgniter\CLI\CLI;
+use CodeIgniter\Publisher\Publisher;
+
+/**
+ * Discovers all Publisher classes from the "Publishers/" directory
+ * across namespaces. Executes `publish()` from each instance, parsing
+ * each result.
+ */
+class Publish extends BaseCommand
+{
+    /**
+     * The group the command is lumped under
+     * when listing commands.
+     *
+     * @var string
+     */
+    protected $group = 'CodeIgniter';
+
+    /**
+     * The Command's name
+     *
+     * @var string
+     */
+    protected $name = 'publish';
+
+    /**
+     * The Command's short description
+     *
+     * @var string
+     */
+    protected $description = 'Discovers and executes all predefined Publisher classes.';
+
+    /**
+     * The Command's usage
+     *
+     * @var string
+     */
+    protected $usage = 'publish [<directory>]';
+
+    /**
+     * The Command's arguments
+     *
+     * @var array<string, string>
+     */
+    protected $arguments = [
+        'directory' => '[Optional] The directory to scan within each namespace. Default: "Publishers".',
+    ];
+
+    /**
+     * the Command's Options
+     *
+     * @var array
+     */
+    protected $options = [];
+
+    /**
+     * Displays the help for the spark cli script itself.
+     */
+    public function run(array $params)
+    {
+        $directory = array_shift($params) ?? 'Publishers';
+
+        if ([] === $publishers = Publisher::discover($directory)) {
+            CLI::write(lang('Publisher.publishMissing', [$directory]));
+
+            return;
+        }
+
+        foreach ($publishers as $publisher) {
+            if ($publisher->publish()) {
+                CLI::write(lang('Publisher.publishSuccess', [
+                    get_class($publisher),
+                    count($publisher->getPublished()),
+                    $publisher->getDestination(),
+                ]), 'green');
+            } else {
+                CLI::error(lang('Publisher.publishFailure', [
+                    get_class($publisher),
+                    $publisher->getDestination(),
+                ]), 'light_gray', 'red');
+
+                foreach ($publisher->getErrors() as $file => $exception) {
+                    CLI::write($file);
+                    CLI::error($exception->getMessage());
+                    CLI::newLine();
+                }
+            }
+        }
+    }
+}

system/Commands/Utilities/Routes.php

@@ -0,0 +1,112 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Commands\Utilities;
+
+use CodeIgniter\CLI\BaseCommand;
+use CodeIgniter\CLI\CLI;
+use Config\Services;
+
+/**
+ * Lists all of the user-defined routes. This will include any Routes files
+ * that can be discovered, but will NOT include any routes that are not defined
+ * in a routes file, but are instead discovered through auto-routing.
+ */
+class Routes extends BaseCommand
+{
+    /**
+     * The group the command is lumped under
+     * when listing commands.
+     *
+     * @var string
+     */
+    protected $group = 'CodeIgniter';
+
+    /**
+     * The Command's name
+     *
+     * @var string
+     */
+    protected $name = 'routes';
+
+    /**
+     * the Command's short description
+     *
+     * @var string
+     */
+    protected $description = 'Displays all of user-defined routes. Does NOT display auto-detected routes.';
+
+    /**
+     * the Command's usage
+     *
+     * @var string
+     */
+    protected $usage = 'routes';
+
+    /**
+     * the Command's Arguments
+     *
+     * @var array
+     */
+    protected $arguments = [];
+
+    /**
+     * the Command's Options
+     *
+     * @var array
+     */
+    protected $options = [];
+
+    /**
+     * Displays the help for the spark cli script itself.
+     */
+    public function run(array $params)
+    {
+        $collection = Services::routes(true);
+        $methods    = [
+            'get',
+            'head',
+            'post',
+            'patch',
+            'put',
+            'delete',
+            'options',
+            'trace',
+            'connect',
+            'cli',
+        ];
+
+        $tbody = [];
+
+        foreach ($methods as $method) {
+            $routes = $collection->getRoutes($method);
+
+            foreach ($routes as $route => $handler) {
+                // filter for strings, as callbacks aren't displayable
+                if (is_string($handler)) {
+                    $tbody[] = [
+                        strtoupper($method),
+                        $route,
+                        $handler,
+                    ];
+                }
+            }
+        }
+
+        $thead = [
+            'Method',
+            'Route',
+            'Handler',
+        ];
+
+        CLI::table($tbody, $thead);
+    }
+}