Release v4.1.3

Author: actions-user

app/Config/Cache.php

@@ -82,6 +82,21 @@ class Cache extends BaseConfig
 	 */
 	public $prefix = '';
 
+	/**
+	 * --------------------------------------------------------------------------
+	 * Default TTL
+	 * --------------------------------------------------------------------------
+	 *
+	 * The default number of seconds to save items when none is specified.
+	 *
+	 * WARNING: This is not used by framework handlers where 60 seconds is
+	 * hard-coded, but may be useful to projects and modules. This will replace
+	 * the hard-coded value in a future release.
+	 *
+	 * @var integer
+	 */
+	public $ttl = 60;
+
 	/**
 	 * --------------------------------------------------------------------------
 	 * File settings

public/index.php

@@ -17,8 +17,9 @@
 
 // Load our paths config file
 // This is the line that might need to be changed, depending on your folder structure.
-require realpath(FCPATH . '../app/Config/Paths.php') ?: FCPATH . '../app/Config/Paths.php';
+$pathsConfig = FCPATH . '../app/Config/Paths.php';
 // ^^^ Change this if you move your application folder
+require realpath($pathsConfig) ?: $pathsConfig;
 
 $paths = new Config\Paths();
 

spark

@@ -33,8 +33,9 @@ if (strpos(PHP_SAPI, 'cgi') === 0)
 define('FCPATH', __DIR__ . DIRECTORY_SEPARATOR . 'public' . DIRECTORY_SEPARATOR);
 
 // Load our paths config file
-require realpath('app/Config/Paths.php') ?: 'app/Config/Paths.php';
+$pathsConfig = 'app/Config/Paths.php';
 // ^^^ Change this line if you move your application folder
+require realpath($pathsConfig) ?: $pathsConfig;
 
 $paths = new Config\Paths();
 

system/Autoloader/Autoloader.php

@@ -22,17 +22,17 @@
  * An autoloader that uses both PSR4 autoloading, and traditional classmaps.
  *
  * Given a foo-bar package of classes in the file system at the following paths:
- *```
+ * ```
  *      /path/to/packages/foo-bar/
  *          /src
  *              Baz.php         # Foo\Bar\Baz
  *              Qux/
  *                  Quux.php    # Foo\Bar\Qux\Quux
- *```
+ * ```
  * you can add the path to the configuration array that is passed in the constructor.
  * The Config array consists of 2 primary keys, both of which are associative arrays:
  * 'psr4', and 'classmap'.
- *```
+ * ```
  *      $Config = [
  *          'psr4' => [
  *              'Foo\Bar'   => '/path/to/packages/foo-bar'
@@ -41,17 +41,17 @@
  *              'MyClass'   => '/path/to/class/file.php'
  *          ]
  *      ];
- *```
+ * ```
  * Example:
- *```
+ * ```
  *      <?php
  *      // our configuration array
  *      $Config = [ ... ];
  *      $loader = new \CodeIgniter\Autoloader\Autoloader($Config);
  *
  *      // register the autoloader
  *      $loader->register();
- *```
+ * ```
  */
 class Autoloader
 {
@@ -258,15 +258,6 @@ protected function loadInNamespace(string $class)
 	{
 		if (strpos($class, '\\') === false)
 		{
-			$class    = 'Config\\' . $class;
-			$filePath = APPPATH . str_replace('\\', DIRECTORY_SEPARATOR, $class) . '.php';
-			$filename = $this->includeFile($filePath);
-
-			if ($filename)
-			{
-				return $filename;
-			}
-
 			return false;
 		}
 
@@ -353,7 +344,9 @@ protected function discoverComposerNamespaces()
 			return;
 		}
 
-		/** @var ClassLoader $composer */
+		/**
+		 * @var ClassLoader $composer
+		 */
 		$composer = include COMPOSER_PATH;
 		$paths    = $composer->getPrefixesPsr4();
 		$classes  = $composer->getClassMap();

system/CLI/CLI.php

@@ -983,7 +983,7 @@ public static function getOption(string $name)
 
 		// If the option didn't have a value, simply return TRUE
 		// so they know it was set, otherwise return the actual value.
-		$val = static::$options[$name] === null ? true : static::$options[$name];
+		$val = static::$options[$name] ?? true;
 
 		return $val;
 	}

system/Cache/Handlers/FileHandler.php

@@ -285,35 +285,13 @@ public function getMetaData(string $key)
 	{
 		$key = static::validateKey($key, $this->prefix);
 
-		if (! is_file($this->path . $key))
+		if (false === $data = $this->getItem($key))
 		{
 			return false; // This will return null in a future release
 		}
 
-		$data = @unserialize(file_get_contents($this->path . $key));
-
-		if (! is_array($data) || ! isset($data['ttl']))
-		{
-			return false; // This will return null in a future release
-		}
-
-		// Consider expired items as missing
-		$expire = $data['time'] + $data['ttl'];
-
-		// @phpstan-ignore-next-line
-		if ($data['ttl'] > 0 && time() > $expire)
-		{
-			// If the file is still there then remove it
-			if (is_file($this->path . $key))
-			{
-				unlink($this->path . $key);
-			}
-
-			return false; // This will return null in a future release
-		}
-
 		return [
-			'expire' => $expire,
+			'expire' => $data['time'] + $data['ttl'],
 			'mtime'  => filemtime($this->path . $key),
 			'data'   => $data['data'],
 		];
@@ -348,15 +326,19 @@ protected function getItem(string $filename)
 			return false;
 		}
 
-		$data = unserialize(file_get_contents($this->path . $filename));
+		$data = @unserialize(file_get_contents($this->path . $filename));
+		if (! is_array($data) || ! isset($data['ttl']))
+		{
+			return false;
+		}
 
 		// @phpstan-ignore-next-line
 		if ($data['ttl'] > 0 && time() > $data['time'] + $data['ttl'])
 		{
-			// If the file is still there then remove it
+			// If the file is still there then try to remove it
 			if (is_file($this->path . $filename))
 			{
-				unlink($this->path . $filename);
+				@unlink($this->path . $filename);
 			}
 
 			return false;

system/Cache/Handlers/MemcachedHandler.php

@@ -351,7 +351,7 @@ public function getMetaData(string $key)
 			return false; // This will return null in a future release
 		}
 
-		list($data, $time, $limit) = $stored;
+		[$data, $time, $limit] = $stored;
 
 		// Calculate the remaining time to live from the original limit
 		$ttl = time() - $time - $limit;

system/CodeIgniter.php

@@ -44,11 +44,8 @@ class CodeIgniter
 	/**
 	 * The current version of CodeIgniter Framework
 	 */
-	const CI_VERSION = '4.1.2';
+	const CI_VERSION = '4.1.3';
 
-	/**
-	 * @var string
-	 */
 	private const MIN_PHP_VERSION = '7.3';
 
 	/**
@@ -474,7 +471,7 @@ protected function handleRequest(?RouteCollectionInterface $routes, Cache $cache
 
 		// Save our current URI as the previous URI in the session
 		// for safer, more accurate use with `previous_url()` helper function.
-		$this->storePreviousURL((string) current_url(true));
+		$this->storePreviousURL(current_url(true));
 
 		unset($uri);
 
@@ -1080,7 +1077,7 @@ public function storePreviousURL($uri)
 
 		if (isset($_SESSION))
 		{
-			$_SESSION['_ci_previous_url'] = (string) $uri;
+			$_SESSION['_ci_previous_url'] = URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(), $uri->getFragment());
 		}
 	}
 

system/Commands/Generators/ValidationGenerator.php

@@ -12,7 +12,6 @@
 namespace CodeIgniter\Commands\Generators;
 
 use CodeIgniter\CLI\BaseCommand;
-use CodeIgniter\CLI\CLI;
 use CodeIgniter\CLI\GeneratorTrait;
 
 /**

system/Commands/Utilities/Environment.php

@@ -0,0 +1,160 @@
+<?php
+
+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
+	 *
+	 * @param array<string, mixed> $params
+	 *
+	 * @return void
+	 */
+	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
+	 *
+	 * @param string $newEnv
+	 *
+	 * @return boolean
+	 */
+	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;
+	}
+}