-
-
+ - + + +
-
diff --git a/env b/env
index 67faaee5..cc0681c6 100644
--- a/env
+++ b/env
@@ -45,6 +45,7 @@
# database.default.password = root
# database.default.DBDriver = MySQLi
# database.default.DBPrefix =
+# database.default.port = 3306
# database.tests.hostname = localhost
# database.tests.database = ci4
@@ -52,6 +53,7 @@
# database.tests.password = root
# database.tests.DBDriver = MySQLi
# database.tests.DBPrefix =
+# database.tests.port = 3306
#--------------------------------------------------------------------
# CONTENT SECURITY POLICY
diff --git a/public/index.php b/public/index.php
index 51f4be81..96e7f45f 100644
--- a/public/index.php
+++ b/public/index.php
@@ -1,5 +1,17 @@
format}";
// Determine correct response type through content negotiation if not explicitly declared
- if (empty($this->format) || ! in_array($this->format, ['json', 'xml'], true)) {
- $mime = $this->request->negotiate('media', $format->getConfig()->supportedResponseFormats, false);
+ if (
+ (empty($this->format) || ! in_array($this->format, ['json', 'xml'], true))
+ && $this->request instanceof IncomingRequest
+ ) {
+ $mime = $this->request->negotiate(
+ 'media',
+ $format->getConfig()->supportedResponseFormats,
+ false
+ );
}
$this->response->setContentType($mime);
diff --git a/system/Autoloader/Autoloader.php b/system/Autoloader/Autoloader.php
index 311428fe..f87e4485 100644
--- a/system/Autoloader/Autoloader.php
+++ b/system/Autoloader/Autoloader.php
@@ -141,9 +141,7 @@ public function register()
// Load our non-class files
foreach ($this->files as $file) {
- if (is_string($file)) {
- $this->includeFile($file);
- }
+ $this->includeFile($file);
}
}
diff --git a/system/BaseModel.php b/system/BaseModel.php
index 39bd9ce2..8817d6b4 100644
--- a/system/BaseModel.php
+++ b/system/BaseModel.php
@@ -353,11 +353,11 @@ abstract protected function doFirst();
/**
* Inserts data into the current database
- * This methods works only with dbCalls
+ * This method works only with dbCalls
*
* @param array $data Data
*
- * @return bool|int|string
+ * @return bool
*/
abstract protected function doInsert(array $data);
@@ -695,7 +695,7 @@ public function getInsertID()
*
* @throws ReflectionException
*
- * @return bool|int|string
+ * @return bool|int|string insert ID or true on success. false on failure.
*/
public function insert($data = null, bool $returnID = true)
{
@@ -1073,7 +1073,8 @@ public function errors(bool $forceDB = false)
*/
public function paginate(?int $perPage = null, string $group = 'default', ?int $page = null, int $segment = 0)
{
- $pager = Services::pager(null, null, false);
+ // Since multiple models may use the Pager, the Pager must be shared.
+ $pager = Services::pager();
if ($segment) {
$pager->setSegment($segment, $group);
diff --git a/system/CLI/CLI.php b/system/CLI/CLI.php
index d88374e8..7a503031 100644
--- a/system/CLI/CLI.php
+++ b/system/CLI/CLI.php
@@ -673,7 +673,7 @@ public static function generateDimensions()
// Then let the developer know of the error.
static::$height = null;
static::$width = null;
- log_message('error', $e->getMessage());
+ log_message('error', (string) $e);
}
}
@@ -838,7 +838,7 @@ public static function getSegments(): array
* Gets a single command-line option. Returns TRUE if the option
* exists, but doesn't have a value, and is simply acting as a flag.
*
- * @return mixed
+ * @return string|true|null
*/
public static function getOption(string $name)
{
diff --git a/system/CLI/GeneratorTrait.php b/system/CLI/GeneratorTrait.php
index 51706b47..e1452f3b 100644
--- a/system/CLI/GeneratorTrait.php
+++ b/system/CLI/GeneratorTrait.php
@@ -234,7 +234,7 @@ protected function renderTemplate(array $data = []): string
try {
return view(config('Generators')->views[$this->name], $data, ['debug' => false]);
} catch (Throwable $e) {
- log_message('error', $e->getMessage());
+ log_message('error', (string) $e);
return view("CodeIgniter\\Commands\\Generators\\Views\\{$this->template}", $data, ['debug' => false]);
}
diff --git a/system/Cache/CacheFactory.php b/system/Cache/CacheFactory.php
index 875dcd3f..38049119 100644
--- a/system/Cache/CacheFactory.php
+++ b/system/Cache/CacheFactory.php
@@ -73,7 +73,7 @@ public static function getHandler(Cache $config, ?string $handler = null, ?strin
try {
$adapter->initialize();
} catch (CriticalError $e) {
- log_message('critical', $e->getMessage() . ' Resorting to using ' . $backup . ' handler.');
+ log_message('critical', $e . ' Resorting to using ' . $backup . ' handler.');
// get the next best cache handler (or dummy if the $backup also fails)
$adapter = self::getHandler($config, $backup, 'dummy');
diff --git a/system/Cache/Handlers/FileHandler.php b/system/Cache/Handlers/FileHandler.php
index 2517c6a5..babb7c03 100644
--- a/system/Cache/Handlers/FileHandler.php
+++ b/system/Cache/Handlers/FileHandler.php
@@ -102,7 +102,7 @@ public function save(string $key, $value, int $ttl = 60)
// @codeCoverageIgnoreStart
} catch (Throwable $e) {
- log_message('debug', 'Failed to set mode on cache file: ' . $e->getMessage());
+ log_message('debug', 'Failed to set mode on cache file: ' . $e);
// @codeCoverageIgnoreEnd
}
diff --git a/system/Cache/Handlers/MemcachedHandler.php b/system/Cache/Handlers/MemcachedHandler.php
index b317652d..6b6f60e0 100644
--- a/system/Cache/Handlers/MemcachedHandler.php
+++ b/system/Cache/Handlers/MemcachedHandler.php
@@ -45,9 +45,7 @@ public function __construct(Cache $config)
{
$this->prefix = $config->prefix;
- if (! empty($config)) {
- $this->config = array_merge($this->config, $config->memcached);
- }
+ $this->config = array_merge($this->config, $config->memcached);
}
/**
diff --git a/system/Cache/Handlers/RedisHandler.php b/system/Cache/Handlers/RedisHandler.php
index 553825f6..df179e74 100644
--- a/system/Cache/Handlers/RedisHandler.php
+++ b/system/Cache/Handlers/RedisHandler.php
@@ -45,9 +45,7 @@ public function __construct(Cache $config)
{
$this->prefix = $config->prefix;
- if (! empty($config)) {
- $this->config = array_merge($this->config, $config->redis);
- }
+ $this->config = array_merge($this->config, $config->redis);
}
/**
diff --git a/system/CodeIgniter.php b/system/CodeIgniter.php
index a4a05233..7dbfbc8e 100644
--- a/system/CodeIgniter.php
+++ b/system/CodeIgniter.php
@@ -21,7 +21,6 @@
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Request;
-use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Router\Exceptions\RedirectException;
@@ -35,6 +34,7 @@
use Kint;
use Kint\Renderer\CliRenderer;
use Kint\Renderer\RichRenderer;
+use Locale;
use LogicException;
/**
@@ -47,14 +47,12 @@ class CodeIgniter
/**
* The current version of CodeIgniter Framework
*/
- public const CI_VERSION = '4.2.1';
-
- private const MIN_PHP_VERSION = '7.4';
+ public const CI_VERSION = '4.2.2';
/**
* App startup time.
*
- * @var mixed
+ * @var float|null
*/
protected $startTime;
@@ -158,16 +156,6 @@ class CodeIgniter
*/
public function __construct(App $config)
{
- if (version_compare(PHP_VERSION, self::MIN_PHP_VERSION, '<')) {
- // @codeCoverageIgnoreStart
- $message = extension_loaded('intl')
- ? lang('Core.invalidPhpVersion', [self::MIN_PHP_VERSION, PHP_VERSION])
- : sprintf('Your PHP version must be %s or higher to run CodeIgniter. Current version: %s', self::MIN_PHP_VERSION, PHP_VERSION);
-
- exit($message);
- // @codeCoverageIgnoreEnd
- }
-
$this->startTime = microtime(true);
$this->config = $config;
}
@@ -190,7 +178,7 @@ public function initialize()
}
// Set default locale on the server
- locale_set_default($this->config->defaultLocale ?? 'en');
+ Locale::setDefault($this->config->defaultLocale ?? 'en');
// Set default timezone on the server
date_default_timezone_set($this->config->appTimezone ?? 'UTC');
@@ -297,10 +285,9 @@ protected function initializeKint()
* tries to route the response, loads the controller and generally
* makes all of the pieces work together.
*
- * @throws Exception
* @throws RedirectException
*
- * @return bool|mixed|RequestInterface|ResponseInterface|void
+ * @return ResponseInterface|void
*/
public function run(?RouteCollectionInterface $routes = null, bool $returnResponse = false)
{
@@ -308,6 +295,8 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
throw new LogicException('Context must be set before run() is called. If you are upgrading from 4.1.x, you need to merge `public/index.php` and `spark` file from `vendor/codeigniter4/framework`.');
}
+ static::$cacheTTL = 0;
+
$this->startBenchmark();
$this->getRequestObject();
@@ -320,7 +309,9 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
$this->response->setStatusCode(405)->setBody('Method Not Allowed');
- return $this->sendResponse();
+ $this->sendResponse();
+
+ return;
}
Events::trigger('pre_system');
@@ -408,7 +399,7 @@ private function isWeb(): bool
* @throws PageNotFoundException
* @throws RedirectException
*
- * @return mixed|RequestInterface|ResponseInterface
+ * @return ResponseInterface
*/
protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
{
@@ -474,6 +465,9 @@ protected function handleRequest(?RouteCollectionInterface $routes, Cache $cache
// so it can be used with the output.
$this->gatherOutput($cacheConfig, $returned);
+ // After filter debug toolbar requires 'total_execution'.
+ $this->totalTime = $this->benchmark->getElapsedTime('total_execution');
+
// Never run filters when running through Spark cli
if (! $this->isSparked()) {
$filters->setResponse($this->response);
@@ -495,6 +489,17 @@ protected function handleRequest(?RouteCollectionInterface $routes, Cache $cache
$this->response = $response;
}
+ // Cache it without the performance metrics replaced
+ // so that we can have live speed updates along the way.
+ // Must be run after filters to preserve the Response headers.
+ if (static::$cacheTTL > 0) {
+ $this->cachePage($cacheConfig);
+ }
+
+ // Update the performance metrics
+ $output = $this->displayPerformanceMetrics($this->response->getBody());
+ $this->response->setBody($output);
+
// Save our current URI as the previous URI in the session
// for safer, more accurate use with `previous_url()` helper function.
$this->storePreviousURL(current_url(true));
@@ -528,7 +533,7 @@ protected function detectEnvironment()
{
// Make sure ENVIRONMENT isn't already set by other means.
if (! defined('ENVIRONMENT')) {
- define('ENVIRONMENT', $_SERVER['CI_ENVIRONMENT'] ?? 'production');
+ define('ENVIRONMENT', env('CI_ENVIRONMENT', 'production'));
}
}
@@ -583,9 +588,7 @@ public function setRequest(Request $request)
}
/**
- * Get our Request object, (either IncomingRequest or CLIRequest)
- * and set the server protocol based on the information provided
- * by the server.
+ * Get our Request object, (either IncomingRequest or CLIRequest).
*/
protected function getRequestObject()
{
@@ -594,12 +597,12 @@ protected function getRequestObject()
}
if ($this->isSparked() || $this->isPhpCli()) {
- $this->request = Services::clirequest($this->config);
+ Services::createRequest($this->config, true);
} else {
- $this->request = Services::request($this->config);
- // guess at protocol if needed
- $this->request->setProtocolVersion($_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.1');
+ Services::createRequest($this->config);
}
+
+ $this->request = Services::request();
}
/**
@@ -642,7 +645,7 @@ protected function forceSecureAccess($duration = 31_536_000)
*
* @throws Exception
*
- * @return bool|ResponseInterface
+ * @return false|ResponseInterface
*/
public function displayCache(Cache $config)
{
@@ -665,7 +668,8 @@ public function displayCache(Cache $config)
$this->response->setHeader($name, $value);
}
- $output = $this->displayPerformanceMetrics($output);
+ $this->totalTime = $this->benchmark->getElapsedTime('total_execution');
+ $output = $this->displayPerformanceMetrics($output);
$this->response->setBody($output);
return $this->response;
@@ -735,8 +739,6 @@ protected function generateCacheName(Cache $config): string
*/
public function displayPerformanceMetrics(string $output): string
{
- $this->totalTime = $this->benchmark->getElapsedTime('total_execution');
-
return str_replace('{elapsed_time}', (string) $this->totalTime, $output);
}
@@ -948,8 +950,9 @@ protected function display404errors(PageNotFoundException $e)
ob_end_flush(); // @codeCoverageIgnore
}
+ // Throws new PageNotFoundException and remove exception message on production.
throw PageNotFoundException::forPageNotFound(
- (ENVIRONMENT !== 'production' || ! $this->isWeb()) ? $e->getMessage() : ''
+ (ENVIRONMENT !== 'production' || ! $this->isWeb()) ? $e->getMessage() : null
);
}
@@ -957,7 +960,10 @@ protected function display404errors(PageNotFoundException $e)
* Gathers the script output from the buffer, replaces some execution
* time tag in the output and displays the debug toolbar, if required.
*
+ * @param Cache|null $cacheConfig Deprecated. No longer used.
* @param ResponseInterface|string|null $returned
+ *
+ * @deprecated $cacheConfig is deprecated.
*/
protected function gatherOutput(?Cache $cacheConfig = null, $returned = null)
{
@@ -993,14 +999,6 @@ protected function gatherOutput(?Cache $cacheConfig = null, $returned = null)
$this->output .= $returned;
}
- // Cache it without the performance metrics replaced
- // so that we can have live speed updates along the way.
- if (static::$cacheTTL > 0) {
- $this->cachePage($cacheConfig);
- }
-
- $this->output = $this->displayPerformanceMetrics($this->output);
-
$this->response->setBody($this->output);
}
@@ -1070,6 +1068,8 @@ public function spoofRequestMethod()
/**
* Sends the output of this request back to the client.
* This is what they've been waiting for!
+ *
+ * @return void
*/
protected function sendResponse()
{
diff --git a/system/Commands/Database/ShowTableInfo.php b/system/Commands/Database/ShowTableInfo.php
index 7e3d6a48..4666a54c 100644
--- a/system/Commands/Database/ShowTableInfo.php
+++ b/system/Commands/Database/ShowTableInfo.php
@@ -129,6 +129,7 @@ public function run(array $params)
$tables,
'required'
);
+ CLI::newLine();
$tableName = $tables[$tableNameNo];
}
@@ -154,7 +155,6 @@ private function restoreDBPrefix(): void
private function showDataOfTable(string $tableName, int $limitRows, int $limitFieldValue)
{
- CLI::newLine();
CLI::write("Data of Table \"{$tableName}\":", 'black', 'yellow');
CLI::newLine();
@@ -245,7 +245,6 @@ private function makeTableRows(
private function showFieldMetaData(string $tableName): void
{
- CLI::newLine();
CLI::write("List of Metadata Information in Table \"{$tableName}\":", 'black', 'yellow');
CLI::newLine();
diff --git a/system/Commands/Utilities/Routes/FilterFinder.php b/system/Commands/Utilities/Routes/FilterFinder.php
index f36ddd9e..0f25eebf 100644
--- a/system/Commands/Utilities/Routes/FilterFinder.php
+++ b/system/Commands/Utilities/Routes/FilterFinder.php
@@ -11,6 +11,7 @@
namespace CodeIgniter\Commands\Utilities\Routes;
+use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Filters\Filters;
use CodeIgniter\Router\Exceptions\RedirectException;
use CodeIgniter\Router\Router;
@@ -67,6 +68,11 @@ public function find(string $uri): array
'before' => [],
'after' => [],
];
+ } catch (PageNotFoundException $e) {
+ return [
+ 'before' => ['
'], + 'after' => [' '], + ]; } } } diff --git a/system/Common.php b/system/Common.php index 30e28a1d..962483bb 100644 --- a/system/Common.php +++ b/system/Common.php @@ -44,6 +44,7 @@ */ function app_timezone(): string { + /** @var App $config */ $config = config(App::class); return $config->appTimezone; @@ -904,7 +905,8 @@ function remove_invisible_characters(string $str, bool $urlEncoded = true): stri * NOTE: This requires the controller/method to * have a route defined in the routes Config file. * - * @param mixed ...$params + * @param string $method Named route or Controller::method + * @param int|string ...$params One or more parameters to be passed to the route * * @return false|string */ diff --git a/system/Config/BaseService.php b/system/Config/BaseService.php index d77cfb1b..5213f426 100644 --- a/system/Config/BaseService.php +++ b/system/Config/BaseService.php @@ -96,6 +96,7 @@ * @method static CLIRequest clirequest(App $config = null, $getShared = true) * @method static CodeIgniter codeigniter(App $config = null, $getShared = true) * @method static Commands commands($getShared = true) + * @method static void createRequest(App $config, bool $isCli = false) * @method static ContentSecurityPolicy csp(CSPConfig $config = null, $getShared = true) * @method static CURLRequest curlrequest($options = [], ResponseInterface $response = null, App $config = null, $getShared = true) * @method static Email email($config = null, $getShared = true) @@ -105,6 +106,7 @@ * @method static Format format(ConfigFormat $config = null, $getShared = true) * @method static Honeypot honeypot(ConfigHoneyPot $config = null, $getShared = true) * @method static BaseHandler image($handler = null, Images $config = null, $getShared = true) + * @method static IncomingRequest incomingrequest(?App $config = null, bool $getShared = true) * @method static Iterator iterator($getShared = true) * @method static Language language($locale = null, $getShared = true) * @method static Logger logger($getShared = true) @@ -114,7 +116,7 @@ * @method static Parser parser($viewPath = null, ConfigView $config = null, $getShared = true) * @method static RedirectResponse redirectresponse(App $config = null, $getShared = true) * @method static View renderer($viewPath = null, ConfigView $config = null, $getShared = true) - * @method static IncomingRequest request(App $config = null, $getShared = true) + * @method static IncomingRequest|CLIRequest request(App $config = null, $getShared = true) * @method static Response response(App $config = null, $getShared = true) * @method static Router router(RouteCollectionInterface $routes = null, Request $request = null, $getShared = true) * @method static RouteCollection routes($getShared = true) diff --git a/system/Config/Factories.php b/system/Config/Factories.php index 31188c1b..9e02fc43 100644 --- a/system/Config/Factories.php +++ b/system/Config/Factories.php @@ -87,7 +87,7 @@ public static function models(string $name, array $options = [], ?ConnectionInte * Loads instances based on the method component name. Either * creates a new instance or returns an existing shared instance. * - * @return mixed + * @return object|null */ public static function __callStatic(string $component, array $arguments) { diff --git a/system/Config/Services.php b/system/Config/Services.php index 9dca5011..169795c7 100644 --- a/system/Config/Services.php +++ b/system/Config/Services.php @@ -75,6 +75,7 @@ use Config\Toolbar as ToolbarConfig; use Config\Validation as ValidationConfig; use Config\View as ViewConfig; +use Locale; /** * Services Configuration file. @@ -117,6 +118,8 @@ public static function cache(?Cache $config = null, bool $getShared = true) * a command line request. * * @return CLIRequest + * + * @internal */ public static function clirequest(?App $config = null, bool $getShared = true) { @@ -361,8 +364,14 @@ public static function language(?string $locale = null, bool $getShared = true) return static::getSharedInstance('language', $locale)->setLocale($locale); } + if (AppServices::request() instanceof IncomingRequest) { + $requestLocale = AppServices::request()->getLocale(); + } else { + $requestLocale = Locale::getDefault(); + } + // Use '?:' for empty string check - $locale = $locale ?: AppServices::request()->getLocale(); + $locale = $locale ?: $requestLocale; return new Language($locale); } @@ -470,9 +479,13 @@ public static function renderer(?string $viewPath = null, ?ViewConfig $config = } /** - * The Request class models an HTTP request. + * Returns the current Request object. * - * @return IncomingRequest + * createRequest() injects IncomingRequest or CLIRequest. + * + * @return CLIRequest|IncomingRequest + * + * @deprecated The parameter $config and $getShared are deprecated. */ public static function request(?App $config = null, bool $getShared = true) { @@ -480,6 +493,45 @@ public static function request(?App $config = null, bool $getShared = true) return static::getSharedInstance('request', $config); } + // @TODO remove the following code for backward compatibility + return static::incomingrequest($config, $getShared); + } + + /** + * Create the current Request object, either IncomingRequest or CLIRequest. + * + * This method is called from CodeIgniter::getRequestObject(). + * + * @internal + */ + public static function createRequest(App $config, bool $isCli = false): void + { + if ($isCli) { + $request = AppServices::clirequest($config); + } else { + $request = AppServices::incomingrequest($config); + + // guess at protocol if needed + $request->setProtocolVersion($_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.1'); + } + + // Inject the request object into Services::request(). + static::$instances['request'] = $request; + } + + /** + * The IncomingRequest class models an HTTP request. + * + * @return IncomingRequest + * + * @internal + */ + public static function incomingrequest(?App $config = null, bool $getShared = true) + { + if ($getShared) { + return static::getSharedInstance('request', $config); + } + $config ??= config('App'); return new IncomingRequest( diff --git a/system/Cookie/CookieStore.php b/system/Cookie/CookieStore.php index af7dd2f0..d3f3223b 100644 --- a/system/Cookie/CookieStore.php +++ b/system/Cookie/CookieStore.php @@ -49,7 +49,7 @@ public static function fromCookieHeaders(array $headers, bool $raw = false) try { return Cookie::fromHeaderString($header, $raw); } catch (CookieException $e) { - log_message('error', $e->getMessage()); + log_message('error', (string) $e); return false; } diff --git a/system/Database/BaseBuilder.php b/system/Database/BaseBuilder.php index 2d54b90f..f18417c5 100644 --- a/system/Database/BaseBuilder.php +++ b/system/Database/BaseBuilder.php @@ -369,10 +369,6 @@ public function ignore(bool $ignore = true) */ public function select($select = '*', ?bool $escape = null) { - if (is_string($select)) { - $select = explode(',', $select); - } - // If the escape value was not set, we will base it on the global setting if (! is_bool($escape)) { $escape = $this->db->protectIdentifiers; @@ -384,6 +380,10 @@ public function select($select = '*', ?bool $escape = null) return $this; } + if (is_string($select)) { + $select = $escape === false ? [$select] : explode(',', $select); + } + foreach ($select as $val) { $val = trim($val); @@ -1863,7 +1863,12 @@ public function getCompiledInsert(bool $reset = true) } $sql = $this->_insert( - $this->db->protectIdentifiers($this->QBFrom[0], true, null, false), + $this->db->protectIdentifiers( + $this->removeAlias($this->QBFrom[0]), + true, + null, + false + ), array_keys($this->QBSet), array_values($this->QBSet) ); @@ -1878,11 +1883,13 @@ public function getCompiledInsert(bool $reset = true) /** * Compiles an insert string and runs the query * + * @param array|object|null $set + * * @throws DatabaseException * - * @return bool|Query + * @return bool */ - public function insert(?array $set = null, ?bool $escape = null) + public function insert($set = null, ?bool $escape = null) { if ($set !== null) { $this->set($set, '', $escape); @@ -1893,7 +1900,12 @@ public function insert(?array $set = null, ?bool $escape = null) } $sql = $this->_insert( - $this->db->protectIdentifiers($this->QBFrom[0], true, $escape, false), + $this->db->protectIdentifiers( + $this->removeAlias($this->QBFrom[0]), + true, + $escape, + false + ), array_keys($this->QBSet), array_values($this->QBSet) ); @@ -1912,6 +1924,25 @@ public function insert(?array $set = null, ?bool $escape = null) return false; } + /** + * @internal This is a temporary solution. + * + * @see https://github.com/codeigniter4/CodeIgniter4/pull/5376 + * @TODO Fix a root cause, and this method should be removed. + */ + protected function removeAlias(string $from): string + { + if (strpos($from, ' ') !== false) { + // if the alias is written with the AS keyword, remove it + $from = preg_replace('/\s+AS\s+/i', ' ', $from); + + $parts = explode(' ', $from); + $from = $parts[0]; + } + + return $from; + } + /** * This method is used by both insert() and getCompiledInsert() to * validate that the there data is actually being set and that table @@ -1941,7 +1972,7 @@ protected function _insert(string $table, array $keys, array $unescapedKeys): st } /** - * Compiles an replace into string and runs the query + * Compiles a replace into string and runs the query * * @throws DatabaseException * @@ -2012,11 +2043,12 @@ public function getCompiledUpdate(bool $reset = true) /** * Compiles an update string and runs the query. * - * @param mixed $where + * @param array|object|null $set + * @param array|RawSql|string|null $where * * @throws DatabaseException */ - public function update(?array $set = null, $where = null, ?int $limit = null): bool + public function update($set = null, $where = null, ?int $limit = null): bool { if ($set !== null) { $this->set($set); @@ -2337,7 +2369,7 @@ public function delete($where = '', ?int $limit = null, bool $resetData = true) return false; // @codeCoverageIgnore } - $sql = $this->_delete($table); + $sql = $this->_delete($this->removeAlias($table)); if (! empty($limit)) { $this->QBLimit = $limit; @@ -2369,7 +2401,13 @@ public function increment(string $column, int $value = 1) $sql = $this->_update($this->QBFrom[0], [$column => "{$column} + {$value}"]); - return $this->db->query($sql, $this->binds, false); + if (! $this->testMode) { + $this->resetWrite(); + + return $this->db->query($sql, $this->binds, false); + } + + return true; } /** @@ -2383,7 +2421,13 @@ public function decrement(string $column, int $value = 1) $sql = $this->_update($this->QBFrom[0], [$column => "{$column}-{$value}"]); - return $this->db->query($sql, $this->binds, false); + if (! $this->testMode) { + $this->resetWrite(); + + return $this->db->query($sql, $this->binds, false); + } + + return true; } /** diff --git a/system/Database/BaseConnection.php b/system/Database/BaseConnection.php index 0e103a51..413c0a47 100644 --- a/system/Database/BaseConnection.php +++ b/system/Database/BaseConnection.php @@ -271,7 +271,7 @@ abstract class BaseConnection implements ConnectionInterface /** * If true, no queries will actually be - * ran against the database. + * run against the database. * * @var bool */ @@ -336,7 +336,9 @@ abstract class BaseConnection implements ConnectionInterface public function __construct(array $params) { foreach ($params as $key => $value) { - $this->{$key} = $value; + if (property_exists($this, $key)) { + $this->{$key} = $value; + } } $queryClass = str_replace('Connection', 'Query', static::class); @@ -380,7 +382,7 @@ public function initialize() $this->connID = $this->connect($this->pConnect); } catch (Throwable $e) { $connectionErrors[] = sprintf('Main connection [%s]: %s', $this->DBDriver, $e->getMessage()); - log_message('error', 'Error connecting to the database: ' . $e->getMessage()); + log_message('error', 'Error connecting to the database: ' . $e); } // No connection resource? Check if there is a failover else throw an error @@ -401,7 +403,7 @@ public function initialize() $this->connID = $this->connect($this->pConnect); } catch (Throwable $e) { $connectionErrors[] = sprintf('Failover #%d [%s]: %s', ++$index, $this->DBDriver, $e->getMessage()); - log_message('error', 'Error connecting to the database: ' . $e->getMessage()); + log_message('error', 'Error connecting to the database: ' . $e); } // If a connection is made break the foreach loop @@ -603,6 +605,15 @@ public function query(string $sql, $binds = null, bool $setEscapeFlags = true, s // the getLastQuery() method. $this->lastQuery = $query; + // If $pretend is true, then we just want to return + // the actual query object here. There won't be + // any results to return. + if ($this->pretend) { + $query->setDuration($startTime); + + return $query; + } + // Run the query for real try { $exception = null; @@ -611,7 +622,7 @@ public function query(string $sql, $binds = null, bool $setEscapeFlags = true, s $this->resultID = false; } - if (! $this->pretend && $this->resultID === false) { + if ($this->resultID === false) { $query->setDuration($startTime, $startTime); // This will trigger a rollback if transactions are being used @@ -634,10 +645,8 @@ public function query(string $sql, $binds = null, bool $setEscapeFlags = true, s } } - if (! $this->pretend) { - // Let others do something with this query. - Events::trigger('DBQuery', $query); - } + // Let others do something with this query. + Events::trigger('DBQuery', $query); if ($exception !== null) { throw $exception; @@ -646,27 +655,16 @@ public function query(string $sql, $binds = null, bool $setEscapeFlags = true, s return false; } - if (! $this->pretend) { - // Let others do something with this query. - Events::trigger('DBQuery', $query); - } + // Let others do something with this query. + Events::trigger('DBQuery', $query); return false; } $query->setDuration($startTime); - if (! $this->pretend) { - // Let others do something with this query - Events::trigger('DBQuery', $query); - } - - // If $pretend is true, then we just want to return - // the actual query object here. There won't be - // any results to return. - if ($this->pretend) { - return $query; - } + // Let others do something with this query + Events::trigger('DBQuery', $query); // resultID is not false, so it must be successful if ($this->isWriteType($sql)) { @@ -1021,6 +1019,11 @@ public function protectIdentifiers($item, bool $prefixSingle = false, ?bool $pro return $item; } + // Do not protect identifiers and do not prefix, no swap prefix, there is nothing to do + if ($protectIdentifiers === false && $prefixSingle === false && $this->swapPre === '') { + return $item; + } + // Convert tabs or multiple spaces into single spaces $item = preg_replace('/\s+/', ' ', trim($item)); @@ -1040,71 +1043,7 @@ public function protectIdentifiers($item, bool $prefixSingle = false, ?bool $pro // in the correct location, assuming the period doesn't indicate that we're dealing // with an alias. While we're at it, we will escape the components if (strpos($item, '.') !== false) { - $parts = explode('.', $item); - - // Does the first segment of the exploded item match - // one of the aliases previously identified? If so, - // we have nothing more to do other than escape the item - // - // NOTE: The ! empty() condition prevents this method - // from breaking when QB isn't enabled. - if (! empty($this->aliasedTables) && in_array($parts[0], $this->aliasedTables, true)) { - if ($protectIdentifiers === true) { - foreach ($parts as $key => $val) { - if (! in_array($val, $this->reservedIdentifiers, true)) { - $parts[$key] = $this->escapeIdentifiers($val); - } - } - - $item = implode('.', $parts); - } - - return $item . $alias; - } - - // Is there a table prefix defined in the config file? If not, no need to do anything - if ($this->DBPrefix !== '') { - // We now add the table prefix based on some logic. - // Do we have 4 segments (hostname.database.table.column)? - // If so, we add the table prefix to the column name in the 3rd segment. - if (isset($parts[3])) { - $i = 2; - } - // Do we have 3 segments (database.table.column)? - // If so, we add the table prefix to the column name in 2nd position - elseif (isset($parts[2])) { - $i = 1; - } - // Do we have 2 segments (table.column)? - // If so, we add the table prefix to the column name in 1st segment - else { - $i = 0; - } - - // This flag is set when the supplied $item does not contain a field name. - // This can happen when this function is being called from a JOIN. - if ($fieldExists === false) { - $i++; - } - - // Verify table prefix and replace if necessary - if ($this->swapPre !== '' && strpos($parts[$i], $this->swapPre) === 0) { - $parts[$i] = preg_replace('/^' . $this->swapPre . '(\S+?)/', $this->DBPrefix . '\\1', $parts[$i]); - } - // We only add the table prefix if it does not already exist - elseif (strpos($parts[$i], $this->DBPrefix) !== 0) { - $parts[$i] = $this->DBPrefix . $parts[$i]; - } - - // Put the parts back together - $item = implode('.', $parts); - } - - if ($protectIdentifiers === true) { - $item = $this->escapeIdentifiers($item); - } - - return $item . $alias; + return $this->protectDotItem($item, $alias, $protectIdentifiers, $fieldExists); } // In some cases, especially 'from', we end up running through @@ -1131,6 +1070,75 @@ public function protectIdentifiers($item, bool $prefixSingle = false, ?bool $pro return $item . $alias; } + private function protectDotItem(string $item, string $alias, bool $protectIdentifiers, bool $fieldExists): string + { + $parts = explode('.', $item); + + // Does the first segment of the exploded item match + // one of the aliases previously identified? If so, + // we have nothing more to do other than escape the item + // + // NOTE: The ! empty() condition prevents this method + // from breaking when QB isn't enabled. + if (! empty($this->aliasedTables) && in_array($parts[0], $this->aliasedTables, true)) { + if ($protectIdentifiers === true) { + foreach ($parts as $key => $val) { + if (! in_array($val, $this->reservedIdentifiers, true)) { + $parts[$key] = $this->escapeIdentifiers($val); + } + } + + $item = implode('.', $parts); + } + + return $item . $alias; + } + + // Is there a table prefix defined in the config file? If not, no need to do anything + if ($this->DBPrefix !== '') { + // We now add the table prefix based on some logic. + // Do we have 4 segments (hostname.database.table.column)? + // If so, we add the table prefix to the column name in the 3rd segment. + if (isset($parts[3])) { + $i = 2; + } + // Do we have 3 segments (database.table.column)? + // If so, we add the table prefix to the column name in 2nd position + elseif (isset($parts[2])) { + $i = 1; + } + // Do we have 2 segments (table.column)? + // If so, we add the table prefix to the column name in 1st segment + else { + $i = 0; + } + + // This flag is set when the supplied $item does not contain a field name. + // This can happen when this function is being called from a JOIN. + if ($fieldExists === false) { + $i++; + } + + // Verify table prefix and replace if necessary + if ($this->swapPre !== '' && strpos($parts[$i], $this->swapPre) === 0) { + $parts[$i] = preg_replace('/^' . $this->swapPre . '(\S+?)/', $this->DBPrefix . '\\1', $parts[$i]); + } + // We only add the table prefix if it does not already exist + elseif (strpos($parts[$i], $this->DBPrefix) !== 0) { + $parts[$i] = $this->DBPrefix . $parts[$i]; + } + + // Put the parts back together + $item = implode('.', $parts); + } + + if ($protectIdentifiers === true) { + $item = $this->escapeIdentifiers($item); + } + + return $item . $alias; + } + /** * Escape the SQL Identifiers * diff --git a/system/Database/Exceptions/DatabaseException.php b/system/Database/Exceptions/DatabaseException.php index a2b3b763..13f58dc1 100644 --- a/system/Database/Exceptions/DatabaseException.php +++ b/system/Database/Exceptions/DatabaseException.php @@ -20,5 +20,5 @@ class DatabaseException extends Error implements ExceptionInterface * * @var int */ - protected $code = 8; + protected $code = EXIT_DATABASE; } diff --git a/system/Database/Forge.php b/system/Database/Forge.php index 0ffd245f..d46dfdfd 100644 --- a/system/Database/Forge.php +++ b/system/Database/Forge.php @@ -110,6 +110,8 @@ class Forge * CREATE TABLE IF statement * * @var bool|string + * + * @deprecated This is no longer used. */ protected $createTableIfStr = 'CREATE TABLE IF NOT EXISTS'; @@ -495,21 +497,15 @@ public function createTable(string $table, bool $ifNotExists = false, array $att throw new RuntimeException('Field information is required.'); } - $sql = $this->_createTable($table, $ifNotExists, $attributes); - - if (is_bool($sql)) { + // If table exists lets stop here + if ($ifNotExists === true && $this->db->tableExists($table)) { $this->reset(); - if ($sql === false) { - if ($this->db->DBDebug) { - throw new DatabaseException('This feature is not available for the database you are using.'); - } - - return false; - } return true; } + $sql = $this->_createTable($table, false, $attributes); + if (($result = $this->db->query($sql)) !== false) { if (isset($this->db->dataCache['table_names']) && ! in_array($table, $this->db->dataCache['table_names'], true)) { $this->db->dataCache['table_names'][] = $table; @@ -529,22 +525,12 @@ public function createTable(string $table, bool $ifNotExists = false, array $att } /** - * @return bool|string + * @return string + * + * @deprecated $ifNotExists is no longer used, and will be removed. */ protected function _createTable(string $table, bool $ifNotExists, array $attributes) { - // For any platforms that don't support Create If Not Exists... - if ($ifNotExists === true && $this->createTableIfStr === false) { - if ($this->db->tableExists($table)) { - return true; - } - - $ifNotExists = false; - } - - $sql = ($ifNotExists) ? sprintf($this->createTableIfStr, $this->db->escapeIdentifiers($table)) - : 'CREATE TABLE'; - $columns = $this->_processFields(true); for ($i = 0, $c = count($columns); $i < $c; $i++) { @@ -566,7 +552,7 @@ protected function _createTable(string $table, bool $ifNotExists, array $attribu return sprintf( $this->createTableStr . '%s', - $sql, + 'CREATE TABLE', $this->db->escapeIdentifiers($table), $columns, $this->_createTableAttributes($attributes) @@ -778,7 +764,7 @@ public function modifyColumn(string $table, $field): bool return false; } - if ($sqls !== null) { + if (is_array($sqls)) { foreach ($sqls as $sql) { if ($this->db->query($sql) === false) { return false; diff --git a/system/Database/MySQLi/Connection.php b/system/Database/MySQLi/Connection.php index 5badaf1c..e4fd5b3f 100644 --- a/system/Database/MySQLi/Connection.php +++ b/system/Database/MySQLi/Connection.php @@ -291,7 +291,7 @@ protected function execute(string $sql) try { return $this->connID->query($this->prepQuery($sql), $this->resultMode); } catch (mysqli_sql_exception $e) { - log_message('error', $e->getMessage()); + log_message('error', (string) $e); if ($this->DBDebug) { throw $e; diff --git a/system/Database/OCI8/Connection.php b/system/Database/OCI8/Connection.php index dc0b26f5..b84111fb 100644 --- a/system/Database/OCI8/Connection.php +++ b/system/Database/OCI8/Connection.php @@ -204,7 +204,7 @@ protected function execute(string $sql) return $result; } catch (ErrorException $e) { - log_message('error', $e->getMessage()); + log_message('error', (string) $e); if ($this->DBDebug) { throw $e; diff --git a/system/Database/OCI8/Forge.php b/system/Database/OCI8/Forge.php index 9cd5bad9..42393cd6 100644 --- a/system/Database/OCI8/Forge.php +++ b/system/Database/OCI8/Forge.php @@ -36,6 +36,8 @@ class Forge extends BaseForge * CREATE TABLE IF statement * * @var false + * + * @deprecated This is no longer used. */ protected $createTableIfStr = false; diff --git a/system/Database/OCI8/Result.php b/system/Database/OCI8/Result.php index 72a1b098..13423787 100644 --- a/system/Database/OCI8/Result.php +++ b/system/Database/OCI8/Result.php @@ -13,7 +13,7 @@ use CodeIgniter\Database\BaseResult; use CodeIgniter\Database\ResultInterface; -use CodeIgniter\Entity; +use CodeIgniter\Entity\Entity; /** * Result for OCI8 diff --git a/system/Database/Postgre/Builder.php b/system/Database/Postgre/Builder.php index 1d80f687..b0a94670 100644 --- a/system/Database/Postgre/Builder.php +++ b/system/Database/Postgre/Builder.php @@ -96,7 +96,13 @@ public function increment(string $column, int $value = 1) $sql = $this->_update($this->QBFrom[0], [$column => "to_number({$column}, '9999999') + {$value}"]); - return $this->db->query($sql, $this->binds, false); + if (! $this->testMode) { + $this->resetWrite(); + + return $this->db->query($sql, $this->binds, false); + } + + return true; } /** @@ -112,7 +118,13 @@ public function decrement(string $column, int $value = 1) $sql = $this->_update($this->QBFrom[0], [$column => "to_number({$column}, '9999999') - {$value}"]); - return $this->db->query($sql, $this->binds, false); + if (! $this->testMode) { + $this->resetWrite(); + + return $this->db->query($sql, $this->binds, false); + } + + return true; } /** diff --git a/system/Database/Postgre/Connection.php b/system/Database/Postgre/Connection.php index 6827ba70..7b58bdb2 100644 --- a/system/Database/Postgre/Connection.php +++ b/system/Database/Postgre/Connection.php @@ -42,6 +42,11 @@ class Connection extends BaseConnection */ public $escapeChar = '"'; + protected $connect_timeout; + protected $options; + protected $sslmode; + protected $service; + /** * Connect to the database. * @@ -134,7 +139,7 @@ protected function execute(string $sql) try { return pg_query($this->connID, $sql); } catch (ErrorException $e) { - log_message('error', $e); + log_message('error', (string) $e); if ($this->DBDebug) { throw $e; } diff --git a/system/Database/SQLSRV/Builder.php b/system/Database/SQLSRV/Builder.php index a5bf829a..8d0e0b41 100755 --- a/system/Database/SQLSRV/Builder.php +++ b/system/Database/SQLSRV/Builder.php @@ -255,7 +255,13 @@ public function increment(string $column, int $value = 1) $sql = $this->_update($this->QBFrom[0], $values); - return $this->db->query($sql, $this->binds, false); + if (! $this->testMode) { + $this->resetWrite(); + + return $this->db->query($sql, $this->binds, false); + } + + return true; } /** @@ -275,7 +281,13 @@ public function decrement(string $column, int $value = 1) $sql = $this->_update($this->QBFrom[0], $values); - return $this->db->query($sql, $this->binds, false); + if (! $this->testMode) { + $this->resetWrite(); + + return $this->db->query($sql, $this->binds, false); + } + + return true; } /** diff --git a/system/Database/SQLSRV/Forge.php b/system/Database/SQLSRV/Forge.php index 67ef057e..95ec9ff0 100755 --- a/system/Database/SQLSRV/Forge.php +++ b/system/Database/SQLSRV/Forge.php @@ -87,6 +87,8 @@ class Forge extends BaseForge * CREATE TABLE IF statement * * @var string + * + * @deprecated This is no longer used. */ protected $createTableIfStr; @@ -101,14 +103,6 @@ public function __construct(BaseConnection $db) { parent::__construct($db); - $this->createTableIfStr = 'IF NOT EXISTS' - . '(SELECT t.name, s.name as schema_name, t.type_desc ' - . 'FROM sys.tables t ' - . 'INNER JOIN sys.schemas s on s.schema_id = t.schema_id ' - . "WHERE s.name=N'" . $this->db->schema . "' " - . "AND t.name=REPLACE(N'%s', '\"', '') " - . "AND t.type_desc='USER_TABLE')\nCREATE TABLE "; - $this->createTableStr = '%s ' . $this->db->escapeIdentifiers($this->db->schema) . ".%s (%s\n) "; $this->renameTableStr = 'EXEC sp_rename [' . $this->db->escapeIdentifiers($this->db->schema) . '.%s] , %s ;'; diff --git a/system/Database/SQLite3/Connection.php b/system/Database/SQLite3/Connection.php index 35ede04c..1085b30b 100644 --- a/system/Database/SQLite3/Connection.php +++ b/system/Database/SQLite3/Connection.php @@ -129,7 +129,7 @@ protected function execute(string $sql) ? $this->connID->exec($sql) : $this->connID->query($sql); } catch (ErrorException $e) { - log_message('error', $e); + log_message('error', (string) $e); if ($this->DBDebug) { throw $e; } @@ -151,6 +151,10 @@ public function affectedRows(): int */ protected function _escapeString(string $str): string { + if (! $this->connID) { + $this->initialize(); + } + return $this->connID->escapeString($str); } diff --git a/system/Database/SQLite3/Forge.php b/system/Database/SQLite3/Forge.php index 1f48f20b..154c9f97 100644 --- a/system/Database/SQLite3/Forge.php +++ b/system/Database/SQLite3/Forge.php @@ -56,8 +56,7 @@ public function __construct(BaseConnection $db) parent::__construct($db); if (version_compare($this->db->getVersion(), '3.3', '<')) { - $this->createTableIfStr = false; - $this->dropTableIfStr = false; + $this->dropTableIfStr = false; } } diff --git a/system/Debug/Exceptions.php b/system/Debug/Exceptions.php index 879dab71..9994aa7a 100644 --- a/system/Debug/Exceptions.php +++ b/system/Debug/Exceptions.php @@ -13,6 +13,8 @@ use CodeIgniter\API\ResponseTrait; use CodeIgniter\Exceptions\PageNotFoundException; +use CodeIgniter\HTTP\CLIRequest; +use CodeIgniter\HTTP\Exceptions\HTTPException; use CodeIgniter\HTTP\IncomingRequest; use CodeIgniter\HTTP\Response; use Config\Exceptions as ExceptionsConfig; @@ -50,9 +52,9 @@ class Exceptions protected $config; /** - * The incoming request. + * The request. * - * @var IncomingRequest + * @var CLIRequest|IncomingRequest */ protected $request; @@ -63,7 +65,10 @@ class Exceptions */ protected $response; - public function __construct(ExceptionsConfig $config, IncomingRequest $request, Response $response) + /** + * @param CLIRequest|IncomingRequest $request + */ + public function __construct(ExceptionsConfig $config, $request, Response $response) { $this->ob_level = ob_get_level(); $this->viewPath = rtrim($config->errorViewPath, '\\/ ') . DIRECTORY_SEPARATOR; @@ -111,7 +116,14 @@ public function exceptionHandler(Throwable $exception) } if (! is_cli()) { - $this->response->setStatusCode($statusCode); + try { + $this->response->setStatusCode($statusCode); + } catch (HTTPException $e) { + // Workaround for invalid HTTP status code. + $statusCode = 500; + $this->response->setStatusCode($statusCode); + } + if (! headers_sent()) { header(sprintf('HTTP/%s %s %s', $this->request->getProtocolVersion(), $this->response->getStatusCode(), $this->response->getReasonPhrase()), true, $statusCode); } @@ -257,7 +269,7 @@ protected function collectVars(Throwable $exception, int $statusCode): array 'title' => get_class($exception), 'type' => get_class($exception), 'code' => $statusCode, - 'message' => $exception->getMessage() ?? '(null)', + 'message' => $exception->getMessage(), 'file' => $exception->getFile(), 'line' => $exception->getLine(), 'trace' => $trace, diff --git a/system/Debug/Toolbar.php b/system/Debug/Toolbar.php index b91fb160..462a019e 100644 --- a/system/Debug/Toolbar.php +++ b/system/Debug/Toolbar.php @@ -397,8 +397,7 @@ public function prepare(?RequestInterface $request = null, ?ResponseInterface $r // for this response if ($request->isAJAX() || strpos($format, 'html') === false) { $response->setHeader('Debugbar-Time', "{$time}") - ->setHeader('Debugbar-Link', site_url("?debugbar_time={$time}")) - ->getBody(); + ->setHeader('Debugbar-Link', site_url("?debugbar_time={$time}")); return; } @@ -419,7 +418,14 @@ public function prepare(?RequestInterface $request = null, ?ResponseInterface $r . PHP_EOL; if (strpos($response->getBody(), '') !== false) { - $response->setBody(preg_replace('//', '' . $script, $response->getBody(), 1)); + $response->setBody( + preg_replace( + '//', + '' . $script, + $response->getBody(), + 1 + ) + ); return; } diff --git a/system/Email/Email.php b/system/Email/Email.php index 753dfe7d..55c9c95e 100644 --- a/system/Email/Email.php +++ b/system/Email/Email.php @@ -1654,7 +1654,7 @@ protected function spoolEmail() $success = $this->{$method}(); } catch (ErrorException $e) { $success = false; - log_message('error', 'Email: ' . $method . ' throwed ' . $e->getMessage()); + log_message('error', 'Email: ' . $method . ' throwed ' . $e); } if (! $success) { @@ -2144,7 +2144,13 @@ protected function mimeTypes($ext = '') public function __destruct() { if (is_resource($this->SMTPConnect)) { - $this->sendCommand('quit'); + try { + $this->sendCommand('quit'); + } catch (ErrorException $e) { + $protocol = $this->getProtocol(); + $method = 'sendWith' . ucfirst($protocol); + log_message('error', 'Email: ' . $method . ' throwed ' . $e); + } } } diff --git a/system/Entity/Cast/BaseCast.php b/system/Entity/Cast/BaseCast.php index c79dfc5f..bfb156da 100644 --- a/system/Entity/Cast/BaseCast.php +++ b/system/Entity/Cast/BaseCast.php @@ -19,10 +19,10 @@ abstract class BaseCast implements CastInterface /** * Get * - * @param mixed $value Data - * @param array $params Additional param + * @param array|bool|float|int|object|string|null $value Data + * @param array $params Additional param * - * @return mixed + * @return array|bool|float|int|object|string|null */ public static function get($value, array $params = []) { @@ -32,10 +32,10 @@ public static function get($value, array $params = []) /** * Set * - * @param mixed $value Data - * @param array $params Additional param + * @param array|bool|float|int|object|string|null $value Data + * @param array $params Additional param * - * @return mixed + * @return array|bool|float|int|object|string|null */ public static function set($value, array $params = []) { diff --git a/system/Entity/Cast/CastInterface.php b/system/Entity/Cast/CastInterface.php index e4a36384..c1dcf1c4 100644 --- a/system/Entity/Cast/CastInterface.php +++ b/system/Entity/Cast/CastInterface.php @@ -19,20 +19,20 @@ interface CastInterface /** * Get * - * @param mixed $value Data - * @param array $params Additional param + * @param array|bool|float|int|object|string|null $value Data + * @param array $params Additional param * - * @return mixed + * @return array|bool|float|int|object|string|null */ public static function get($value, array $params = []); /** * Set * - * @param mixed $value Data - * @param array $params Additional param + * @param array|bool|float|int|object|string|null $value Data + * @param array $params Additional param * - * @return mixed + * @return array|bool|float|int|object|string|null */ public static function set($value, array $params = []); } diff --git a/system/Entity/Cast/DatetimeCast.php b/system/Entity/Cast/DatetimeCast.php index 99f425a4..41af062c 100644 --- a/system/Entity/Cast/DatetimeCast.php +++ b/system/Entity/Cast/DatetimeCast.php @@ -24,6 +24,8 @@ class DatetimeCast extends BaseCast * {@inheritDoc} * * @throws Exception + * + * @return Time */ public static function get($value, array $params = []) { diff --git a/system/Entity/Entity.php b/system/Entity/Entity.php index 194f7441..39adf066 100644 --- a/system/Entity/Entity.php +++ b/system/Entity/Entity.php @@ -41,7 +41,7 @@ class Entity implements JsonSerializable * * Example: * $datamap = [ - * 'class_name' => 'db_name' + * 'class_property_name' => 'db_column_name' * ]; */ protected $datamap = []; @@ -146,7 +146,7 @@ public function fill(?array $data = null) * __get() magic method so will have any casts, etc applied to them. * * @param bool $onlyChanged If true, only return values that have changed since object creation - * @param bool $cast If true, properties will be casted. + * @param bool $cast If true, properties will be cast. * @param bool $recursive If true, inner entities will be casted as array as well. */ public function toArray(bool $onlyChanged = false, bool $cast = true, bool $recursive = false): array @@ -256,6 +256,8 @@ public function hasChanged(?string $key = null): bool return $this->original !== $this->attributes; } + $key = $this->mapProperty($key); + // Key doesn't exist in either if (! array_key_exists($key, $this->original) && ! array_key_exists($key, $this->attributes)) { return false; @@ -287,7 +289,7 @@ public function setAttributes(array $data) * Checks the datamap to see if this property name is being mapped, * and returns the db column name, if any, or the original property name. * - * @return mixed|string + * @return string db column name */ protected function mapProperty(string $key) { @@ -480,7 +482,7 @@ public function __get(string $key) // Convert to CamelCase for the method $method = 'get' . str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $key))); - // if a set* method exists for this key, + // if a get* method exists for this key, // use that method to insert this value. if (method_exists($this, $method)) { $result = $this->{$method}(); diff --git a/system/Entity/Exceptions/CastException.php b/system/Entity/Exceptions/CastException.php index 2cda4d72..224bbdc7 100644 --- a/system/Entity/Exceptions/CastException.php +++ b/system/Entity/Exceptions/CastException.php @@ -15,6 +15,10 @@ /** * CastException is thrown for invalid cast initialization and management. + * + * @TODO CodeIgniter\Exceptions\CastException is deprecated and this class is used. + * CodeIgniter\Exceptions\CastException has the property $code = EXIT_CONFIG, + * but this class does not have the code. */ class CastException extends FrameworkException { diff --git a/system/Exceptions/CastException.php b/system/Exceptions/CastException.php index 5e416315..06511f73 100644 --- a/system/Exceptions/CastException.php +++ b/system/Exceptions/CastException.php @@ -23,11 +23,11 @@ class CastException extends CriticalError use DebugTraceableTrait; /** - * Error code + * Exit status code * * @var int */ - protected $code = 3; + protected $code = EXIT_CONFIG; public static function forInvalidJsonFormatException(int $error) { diff --git a/system/Exceptions/ConfigException.php b/system/Exceptions/ConfigException.php index 41ae4959..ced8afc6 100644 --- a/system/Exceptions/ConfigException.php +++ b/system/Exceptions/ConfigException.php @@ -19,11 +19,11 @@ class ConfigException extends CriticalError use DebugTraceableTrait; /** - * Error code + * Exit status code * * @var int */ - protected $code = 3; + protected $code = EXIT_CONFIG; public static function forDisabledMigrations() { diff --git a/system/Exceptions/PageNotFoundException.php b/system/Exceptions/PageNotFoundException.php index 2a773f17..531df0e4 100644 --- a/system/Exceptions/PageNotFoundException.php +++ b/system/Exceptions/PageNotFoundException.php @@ -19,7 +19,7 @@ class PageNotFoundException extends OutOfBoundsException implements ExceptionInt use DebugTraceableTrait; /** - * Error code + * HTTP status code * * @var int */ diff --git a/system/Files/FileCollection.php b/system/Files/FileCollection.php index 853c15c0..20b208fd 100644 --- a/system/Files/FileCollection.php +++ b/system/Files/FileCollection.php @@ -178,7 +178,9 @@ public function add($paths, bool $recursive = true) // Test for a directory self::resolveDirectory($path); } catch (FileException $e) { - return $this->addFile($path); + $this->addFile($path); + + continue; } $this->addDirectory($path, $recursive); diff --git a/system/Filters/Filters.php b/system/Filters/Filters.php index 69788a05..d5d5e3aa 100644 --- a/system/Filters/Filters.php +++ b/system/Filters/Filters.php @@ -509,8 +509,8 @@ protected function processAliasesToClass(string $position) /** * Check paths for match for URI * - * @param string $uri URI to test against - * @param mixed $paths The path patterns to test + * @param string $uri URI to test against + * @param array|string $paths The path patterns to test * * @return bool True if any of the paths apply to the URI */ diff --git a/system/Format/FormatterInterface.php b/system/Format/FormatterInterface.php index 04ba3e89..f2b21115 100644 --- a/system/Format/FormatterInterface.php +++ b/system/Format/FormatterInterface.php @@ -21,7 +21,7 @@ interface FormatterInterface * * @param array|string $data * - * @return mixed + * @return bool|string */ public function format($data); } diff --git a/system/Format/JSONFormatter.php b/system/Format/JSONFormatter.php index b9b3daae..7933351a 100644 --- a/system/Format/JSONFormatter.php +++ b/system/Format/JSONFormatter.php @@ -24,7 +24,7 @@ class JSONFormatter implements FormatterInterface * * @param mixed $data * - * @return bool|string (JSON string | false) + * @return false|string (JSON string | false) */ public function format($data) { diff --git a/system/HTTP/CLIRequest.php b/system/HTTP/CLIRequest.php index 0563be28..5f2c70b1 100644 --- a/system/HTTP/CLIRequest.php +++ b/system/HTTP/CLIRequest.php @@ -212,6 +212,6 @@ protected function parseCommand() */ public function isCLI(): bool { - return is_cli(); + return true; } } diff --git a/system/HTTP/ContentSecurityPolicy.php b/system/HTTP/ContentSecurityPolicy.php index ff2ee311..36292621 100644 --- a/system/HTTP/ContentSecurityPolicy.php +++ b/system/HTTP/ContentSecurityPolicy.php @@ -776,7 +776,7 @@ protected function buildHeaders(ResponseInterface $response) protected function addToHeader(string $name, $values = null) { if (is_string($values)) { - $values = [$values => 0]; + $values = [$values => $this->reportOnly]; } $sources = []; @@ -785,13 +785,15 @@ protected function addToHeader(string $name, $values = null) foreach ($values as $value => $reportOnly) { if (is_numeric($value) && is_string($reportOnly) && ! empty($reportOnly)) { $value = $reportOnly; - $reportOnly = 0; + $reportOnly = $this->reportOnly; + } + + if (strpos($value, 'nonce-') === 0) { + $value = "'{$value}'"; } if ($reportOnly === true) { $reportSources[] = in_array($value, $this->validSources, true) ? "'{$value}'" : $value; - } elseif (strpos($value, 'nonce-') === 0) { - $sources[] = "'{$value}'"; } else { $sources[] = in_array($value, $this->validSources, true) ? "'{$value}'" : $value; } diff --git a/system/HTTP/DownloadResponse.php b/system/HTTP/DownloadResponse.php index abd666fb..04ad8b80 100644 --- a/system/HTTP/DownloadResponse.php +++ b/system/HTTP/DownloadResponse.php @@ -247,6 +247,8 @@ public function setCache(array $options = []) /** * {@inheritDoc} * + * @return $this + * * @todo Do downloads need CSP or Cookies? Compare with ResponseTrait::send() */ public function send() diff --git a/system/HTTP/Files/UploadedFile.php b/system/HTTP/Files/UploadedFile.php index f66c2a92..459c3070 100644 --- a/system/HTTP/Files/UploadedFile.php +++ b/system/HTTP/Files/UploadedFile.php @@ -283,7 +283,7 @@ public function getTempName(): string * type but will return the clientExtension if it fails to do so. * * This method will always return a more or less helpfull extension - * but might be insecure if the mime type is not machted. Consider + * but might be insecure if the mime type is not matched. Consider * using guessExtension for a more safe version. */ public function getExtension(): string diff --git a/system/HTTP/IncomingRequest.php b/system/HTTP/IncomingRequest.php index d37f498e..08e2d7b4 100755 --- a/system/HTTP/IncomingRequest.php +++ b/system/HTTP/IncomingRequest.php @@ -22,7 +22,7 @@ /** * Class IncomingRequest * - * Represents an incoming, getServer-side HTTP request. + * Represents an incoming, server-side HTTP request. * * Per the HTTP specification, this interface includes properties for * each of the following: @@ -347,7 +347,7 @@ public function negotiate(string $type, array $supported, bool $strictMatch = fa */ public function isCLI(): bool { - return is_cli(); + return false; } /** diff --git a/system/HTTP/Message.php b/system/HTTP/Message.php index 99a4e395..fb65d543 100644 --- a/system/HTTP/Message.php +++ b/system/HTTP/Message.php @@ -39,14 +39,14 @@ class Message implements MessageInterface /** * Message body * - * @var mixed + * @var string|null */ protected $body; /** * Returns the Message's body. * - * @return mixed + * @return string|null */ public function getBody() { diff --git a/system/HTTP/MessageInterface.php b/system/HTTP/MessageInterface.php index 2addc2b2..2746a669 100644 --- a/system/HTTP/MessageInterface.php +++ b/system/HTTP/MessageInterface.php @@ -37,7 +37,7 @@ public function setBody($data); public function appendBody($data); /** - * Populates the $headers array with any headers the getServer knows about. + * Populates the $headers array with any headers the server knows about. */ public function populateHeaders(): void; diff --git a/system/HTTP/MessageTrait.php b/system/HTTP/MessageTrait.php index e4fb7384..90e36ad5 100644 --- a/system/HTTP/MessageTrait.php +++ b/system/HTTP/MessageTrait.php @@ -45,7 +45,7 @@ trait MessageTrait /** * Sets the body of the current message. * - * @param mixed $data + * @param string $data * * @return $this */ @@ -75,7 +75,7 @@ public function appendBody($data): self //-------------------------------------------------------------------- /** - * Populates the $headers array with any headers the getServer knows about. + * Populates the $headers array with any headers the server knows about. */ public function populateHeaders(): void { diff --git a/system/HTTP/Negotiate.php b/system/HTTP/Negotiate.php index b379a6e1..dfb9dced 100644 --- a/system/HTTP/Negotiate.php +++ b/system/HTTP/Negotiate.php @@ -18,7 +18,7 @@ * * Provides methods to negotiate with the HTTP headers to determine the best * type match between what the application supports and what the requesting - * getServer wants. + * server wants. * * @see http://tools.ietf.org/html/rfc7231#section-5.3 */ diff --git a/system/HTTP/RedirectResponse.php b/system/HTTP/RedirectResponse.php index b9cabbba..1040c157 100644 --- a/system/HTTP/RedirectResponse.php +++ b/system/HTTP/RedirectResponse.php @@ -44,16 +44,20 @@ public function to(string $uri, ?int $code = null, string $method = 'auto') * Sets the URI to redirect to but as a reverse-routed or named route * instead of a raw URI. * + * @param string $route Named route or Controller::method + * * @throws HTTPException * * @return $this */ public function route(string $route, array $params = [], int $code = 302, string $method = 'auto') { + $namedRoute = $route; + $route = Services::routes()->reverseRoute($route, ...$params); if (! $route) { - throw HTTPException::forInvalidRedirectRoute($route); + throw HTTPException::forInvalidRedirectRoute($namedRoute); } return $this->redirect(site_url($route), $method, $code); diff --git a/system/HTTP/RequestTrait.php b/system/HTTP/RequestTrait.php index c2482772..c551dee9 100644 --- a/system/HTTP/RequestTrait.php +++ b/system/HTTP/RequestTrait.php @@ -212,7 +212,7 @@ public function setGlobal(string $method, $value) * @param int|null $filter Filter constant * @param array|int|null $flags Options * - * @return mixed + * @return array|bool|string|null */ public function fetchGlobal(string $method, $index = null, ?int $filter = null, $flags = null) { diff --git a/system/HTTP/Response.php b/system/HTTP/Response.php index 493c990e..bcaffa49 100644 --- a/system/HTTP/Response.php +++ b/system/HTTP/Response.php @@ -19,7 +19,7 @@ use Config\Services; /** - * Representation of an outgoing, getServer-side response. + * Representation of an outgoing, server-side response. * * Per the HTTP specification, this interface includes properties for * each of the following: @@ -203,7 +203,7 @@ public function pretend(bool $pretend = true) /** * Gets the response status code. * - * The status code is a 3-digit integer result code of the getServer's attempt + * The status code is a 3-digit integer result code of the server's attempt * to understand and satisfy the request. * * @return int Status code. diff --git a/system/HTTP/ResponseInterface.php b/system/HTTP/ResponseInterface.php index c1d615c5..9cf729bb 100644 --- a/system/HTTP/ResponseInterface.php +++ b/system/HTTP/ResponseInterface.php @@ -18,7 +18,7 @@ use InvalidArgumentException; /** - * Representation of an outgoing, getServer-side response. + * Representation of an outgoing, server-side response. * Most of these methods are supplied by ResponseTrait. * * Per the HTTP specification, this interface includes properties for @@ -107,7 +107,7 @@ interface ResponseInterface /** * Gets the response status code. * - * The status code is a 3-digit integer result code of the getServer's attempt + * The status code is a 3-digit integer result code of the server's attempt * to understand and satisfy the request. * * @return int Status code. diff --git a/system/HTTP/ResponseTrait.php b/system/HTTP/ResponseTrait.php index f8dd174b..66c7ce26 100644 --- a/system/HTTP/ResponseTrait.php +++ b/system/HTTP/ResponseTrait.php @@ -299,7 +299,7 @@ public function getXML() } /** - * Handles conversion of the of the data into the appropriate format, + * Handles conversion of the data into the appropriate format, * and sets the correct Content-Type header for our response. * * @param array|string $body @@ -634,7 +634,7 @@ public function getCookie(?string $name = null, string $prefix = '') return $this->cookieStore->get($name, $prefix); } catch (CookieException $e) { - log_message('error', $e->getMessage()); + log_message('error', (string) $e); return null; } @@ -657,6 +657,7 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat $store = $this->cookieStore; $found = false; + /** @var Cookie $cookie */ foreach ($store as $cookie) { if ($cookie->getPrefixedName() === $prefixed) { if ($domain !== $cookie->getDomain()) { @@ -754,8 +755,9 @@ private function doSetCookie(string $name, string $value, array $options): void * Generates the headers that force a download to happen. And * sends the file to the browser. * - * @param string $filename The path to the file to send - * @param string|null $data The data to be downloaded + * @param string $filename The name you want the downloaded file to be named + * or the path to the file to send + * @param string|null $data The data to be downloaded. Set null if the $filename is the file path * @param bool $setMime Whether to try and send the actual MIME type * * @return DownloadResponse|null diff --git a/system/HTTP/URI.php b/system/HTTP/URI.php index e0a6ff9f..7634b415 100644 --- a/system/HTTP/URI.php +++ b/system/HTTP/URI.php @@ -661,10 +661,8 @@ public function setAuthority(string $str) */ public function setScheme(string $str) { - $str = strtolower($str); - $str = preg_replace('#:(//)?$#', '', $str); - - $this->scheme = $str; + $str = strtolower($str); + $this->scheme = preg_replace('#:(//)?$#', '', $str); return $this; } @@ -932,8 +930,7 @@ protected function applyParts(array $parts) // Port if (isset($parts['port']) && $parts['port'] !== null) { // Valid port numbers are enforced by earlier parse_url or setPort() - $port = $parts['port']; - $this->port = $port; + $this->port = $parts['port']; } if (isset($parts['pass'])) { diff --git a/system/Helpers/array_helper.php b/system/Helpers/array_helper.php index 9d2b4487..5a72efed 100644 --- a/system/Helpers/array_helper.php +++ b/system/Helpers/array_helper.php @@ -16,7 +16,7 @@ * Searches an array through dot syntax. Supports * wildcard searches, like foo.*.bar * - * @return mixed + * @return array|bool|int|object|string|null */ function dot_array_search(string $index, array $array) { diff --git a/system/Helpers/form_helper.php b/system/Helpers/form_helper.php index 2466900d..aaab2a46 100644 --- a/system/Helpers/form_helper.php +++ b/system/Helpers/form_helper.php @@ -63,10 +63,8 @@ function form_open(string $action = '', $attributes = [], array $hidden = []): s $form .= csrf_field($csrfId ?? null); } - if (is_array($hidden)) { - foreach ($hidden as $name => $value) { - $form .= form_hidden($name, $value); - } + foreach ($hidden as $name => $value) { + $form .= form_hidden($name, $value); } return $form; diff --git a/system/Helpers/number_helper.php b/system/Helpers/number_helper.php index 0a1e16ce..c61229da 100644 --- a/system/Helpers/number_helper.php +++ b/system/Helpers/number_helper.php @@ -9,8 +9,6 @@ * the LICENSE file that was distributed with this source code. */ -use Config\Services; - // CodeIgniter Number Helpers if (! function_exists('number_to_size')) { @@ -129,8 +127,9 @@ function number_to_currency(float $num, string $currency, ?string $locale = null */ function format_number(float $num, int $precision = 1, ?string $locale = null, array $options = []): string { - // Locale is either passed in here, negotiated with client, or grabbed from our config file. - $locale ??= Services::request()->getLocale(); + // If locale is not passed, get from the default locale that is set from our config file + // or set by HTTP content negotiation. + $locale ??= Locale::getDefault(); // Type can be any of the NumberFormatter options, but provide a default. $type = (int) ($options['type'] ?? NumberFormatter::DECIMAL); diff --git a/system/Helpers/text_helper.php b/system/Helpers/text_helper.php index 6914f318..a939060a 100755 --- a/system/Helpers/text_helper.php +++ b/system/Helpers/text_helper.php @@ -573,6 +573,12 @@ function random_string(string $type = 'alnum', int $len = 8): string return sha1(uniqid((string) mt_rand(), true)); case 'crypto': + if ($len % 2 !== 0) { + throw new InvalidArgumentException( + 'You must set an even number to the second parameter when you use `crypto`.' + ); + } + return bin2hex(random_bytes($len / 2)); } // 'basic' type treated as default diff --git a/system/Helpers/url_helper.php b/system/Helpers/url_helper.php index 8efd11c1..a533f524 100644 --- a/system/Helpers/url_helper.php +++ b/system/Helpers/url_helper.php @@ -525,7 +525,8 @@ function mb_url_title(string $str, string $separator = '-', bool $lowercase = fa * NOTE: This requires the controller/method to * have a route defined in the routes Config file. * - * @param mixed ...$args + * @param string $controller Named route or Controller::method + * @param int|string ...$args One or more parameters to be passed to the route * * @throws RouterException */ diff --git a/system/I18n/Time.php b/system/I18n/Time.php index 659a0a25..dd26979a 100644 --- a/system/I18n/Time.php +++ b/system/I18n/Time.php @@ -452,7 +452,7 @@ public function getWeekOfYear(): string } /** - * Returns the age in years from the "current" date and 'now' + * Returns the age in years from the date and 'now' * * @throws Exception * @@ -460,11 +460,8 @@ public function getWeekOfYear(): string */ public function getAge() { - $now = self::now()->getTimestamp(); - $time = $this->getTimestamp(); - // future dates have no age - return max(0, date('Y', $now) - date('Y', $time)); + return max(0, $this->difference(self::now())->getYears()); } /** diff --git a/system/Images/Handlers/ImageMagickHandler.php b/system/Images/Handlers/ImageMagickHandler.php index 5e0bafe0..a1482db7 100644 --- a/system/Images/Handlers/ImageMagickHandler.php +++ b/system/Images/Handlers/ImageMagickHandler.php @@ -19,12 +19,6 @@ /** * Class ImageMagickHandler * - * To make this library as compatible as possible with the broadest - * number of installations, we do not use the Imagick extension, - * but simply use the command line version. - * - * hmm - the width & height accessors at the end use the imagick extension. - * * FIXME - This needs conversion & unit testing, to use the imagick extension */ class ImageMagickHandler extends BaseHandler diff --git a/system/Language/en/HTTP.php b/system/Language/en/HTTP.php index 8902b8ea..5ee3cae2 100644 --- a/system/Language/en/HTTP.php +++ b/system/Language/en/HTTP.php @@ -27,7 +27,7 @@ 'emptySupportedNegotiations' => 'You must provide an array of supported values to all Negotiations.', // RedirectResponse - 'invalidRoute' => '{0} route cannot be found while reverse-routing.', + 'invalidRoute' => 'The route for "{0}" cannot be found.', // DownloadResponse 'cannotSetBinary' => 'When setting filepath cannot set binary.', diff --git a/system/Model.php b/system/Model.php index 4b2087d9..04bd6b15 100644 --- a/system/Model.php +++ b/system/Model.php @@ -251,11 +251,11 @@ protected function doFirst() /** * Inserts data into the current table. - * This methods works only with dbCalls + * This method works only with dbCalls * * @param array $data Data * - * @return bool|Query + * @return bool */ protected function doInsert(array $data) { diff --git a/system/Pager/Pager.php b/system/Pager/Pager.php index 32843ba9..80861646 100644 --- a/system/Pager/Pager.php +++ b/system/Pager/Pager.php @@ -122,7 +122,8 @@ protected function displayLinks(string $group, string $template): string $pager = new PagerRenderer($this->getDetails($group)); - return $this->view->setVar('pager', $pager)->render($this->config->templates[$template]); + return $this->view->setVar('pager', $pager) + ->render($this->config->templates[$template], null, false); } /** diff --git a/system/RESTful/ResourceController.php b/system/RESTful/ResourceController.php index 809545c1..42bf9383 100644 --- a/system/RESTful/ResourceController.php +++ b/system/RESTful/ResourceController.php @@ -12,6 +12,7 @@ namespace CodeIgniter\RESTful; use CodeIgniter\API\ResponseTrait; +use CodeIgniter\HTTP\Response; /** * An extendable controller to provide a RESTful API for a resource. @@ -23,7 +24,7 @@ class ResourceController extends BaseResource /** * Return an array of resource objects, themselves in array format * - * @return mixed + * @return Response|string|void */ public function index() { @@ -33,9 +34,9 @@ public function index() /** * Return the properties of a resource object * - * @param mixed $id + * @param int|string|null $id * - * @return mixed + * @return Response|string|void */ public function show($id = null) { @@ -45,7 +46,7 @@ public function show($id = null) /** * Return a new resource object, with default properties * - * @return mixed + * @return Response|string|void */ public function new() { @@ -55,7 +56,7 @@ public function new() /** * Create a new resource object, from "posted" parameters * - * @return mixed + * @return Response|string|void */ public function create() { @@ -65,9 +66,9 @@ public function create() /** * Return the editable properties of a resource object * - * @param mixed $id + * @param int|string|null $id * - * @return mixed + * @return Response|string|void */ public function edit($id = null) { @@ -77,9 +78,9 @@ public function edit($id = null) /** * Add or update a model resource, from "posted" properties * - * @param mixed $id + * @param string|null|int$id * - * @return mixed + * @return Response|string|void */ public function update($id = null) { @@ -89,9 +90,9 @@ public function update($id = null) /** * Delete the designated resource object from the model * - * @param mixed $id + * @param int|string|null $id * - * @return mixed + * @return Response|string|void */ public function delete($id = null) { @@ -100,6 +101,8 @@ public function delete($id = null) /** * Set/change the expected response representation for returned objects + * + * @return void */ public function setFormat(string $format = 'json') { diff --git a/system/RESTful/ResourcePresenter.php b/system/RESTful/ResourcePresenter.php index 467e2687..3b832a24 100644 --- a/system/RESTful/ResourcePresenter.php +++ b/system/RESTful/ResourcePresenter.php @@ -11,6 +11,8 @@ namespace CodeIgniter\RESTful; +use CodeIgniter\HTTP\Response; + /** * An extendable controller to help provide a UI for a resource. */ @@ -19,7 +21,7 @@ class ResourcePresenter extends BaseResource /** * Present a view of resource objects * - * @return mixed + * @return Response|string|void */ public function index() { @@ -29,9 +31,9 @@ public function index() /** * Present a view to present a specific resource object * - * @param mixed $id + * @param int|string|null $id * - * @return mixed + * @return Response|string|void */ public function show($id = null) { @@ -41,7 +43,7 @@ public function show($id = null) /** * Present a view to present a new single resource object * - * @return mixed + * @return Response|string|void */ public function new() { @@ -52,7 +54,7 @@ public function new() * Process the creation/insertion of a new resource object. * This should be a POST. * - * @return mixed + * @return Response|string|void */ public function create() { @@ -62,9 +64,9 @@ public function create() /** * Present a view to edit the properties of a specific resource object * - * @param mixed $id + * @param int|string|null $id * - * @return mixed + * @return Response|string|void */ public function edit($id = null) { @@ -75,9 +77,9 @@ public function edit($id = null) * Process the updating, full or partial, of a specific resource object. * This should be a POST. * - * @param mixed $id + * @param int|string|null $id * - * @return mixed + * @return Response|string|void */ public function update($id = null) { @@ -87,9 +89,9 @@ public function update($id = null) /** * Present a view to confirm the deletion of a specific resource object * - * @param mixed $id + * @param int|string|null $id * - * @return mixed + * @return Response|string|void */ public function remove($id = null) { @@ -99,9 +101,9 @@ public function remove($id = null) /** * Process the deletion of a specific resource object * - * @param mixed $id + * @param int|string|null $id * - * @return mixed + * @return Response|string|void */ public function delete($id = null) { diff --git a/system/Router/Exceptions/RedirectException.php b/system/Router/Exceptions/RedirectException.php index b2456f36..d5a1616b 100644 --- a/system/Router/Exceptions/RedirectException.php +++ b/system/Router/Exceptions/RedirectException.php @@ -19,7 +19,7 @@ class RedirectException extends Exception { /** - * Status code for redirects + * HTTP status code for redirects * * @var int */ diff --git a/system/Router/RouteCollection.php b/system/Router/RouteCollection.php index 4998a16c..66a950e7 100644 --- a/system/Router/RouteCollection.php +++ b/system/Router/RouteCollection.php @@ -623,9 +623,9 @@ public function group(string $name, ...$params) $oldOptions = $this->currentOptions; // To register a route, we'll set a flag so that our router - // so it will see the group name. + // will see the group name. // If the group name is empty, we go on using the previously built group name. - $this->group = $name ? ltrim($oldGroup . '/' . $name, '/') : $oldGroup; + $this->group = $name ? trim($oldGroup . '/' . $name, '/') : $oldGroup; $callback = array_pop($params); @@ -989,7 +989,8 @@ public function environment(string $env, Closure $callback): RouteCollectionInte * // Equals 'path/$param1/$param2' * reverseRoute('Controller::method', $param1, $param2); * - * @param mixed ...$params + * @param string $search Named route or Controller::method + * @param int|string ...$params One or more parameters to be passed to the route * * @return false|string */ diff --git a/system/Router/RouteCollectionInterface.php b/system/Router/RouteCollectionInterface.php index e5e4350a..b12de34b 100644 --- a/system/Router/RouteCollectionInterface.php +++ b/system/Router/RouteCollectionInterface.php @@ -169,7 +169,8 @@ public function getHTTPVerb(); * // Equals 'path/$param1/$param2' * reverseRoute('Controller::method', $param1, $param2); * - * @param array ...$params + * @param string $search Named route or Controller::method + * @param int|string ...$params * * @return false|string */ diff --git a/system/Security/Security.php b/system/Security/Security.php index 3adb7bf6..529e10b0 100644 --- a/system/Security/Security.php +++ b/system/Security/Security.php @@ -21,6 +21,8 @@ use Config\Cookie as CookieConfig; use Config\Security as SecurityConfig; use Config\Services; +use ErrorException; +use InvalidArgumentException; use LogicException; /** @@ -52,7 +54,7 @@ class Security implements SecurityInterface protected $tokenRandomize = false; /** - * CSRF Hash + * CSRF Hash (without randomization) * * Random hash for Cross Site Request Forgery protection. * @@ -86,7 +88,7 @@ class Security implements SecurityInterface protected $cookie; /** - * CSRF Cookie Name + * CSRF Cookie Name (with Prefix) * * Cookie name for Cross Site Request Forgery protection. * @@ -152,6 +154,14 @@ class Security implements SecurityInterface */ private ?Session $session = null; + /** + * CSRF Hash in Request Cookie + * + * The cookie value is always CSRF hash (without randomization) even if + * $tokenRandomize is true. + */ + private ?string $hashInCookie = null; + /** * Constructor. * @@ -190,9 +200,13 @@ public function __construct(App $config) $this->configureSession(); } - $this->request = Services::request(); + $this->request = Services::request(); + $this->hashInCookie = $this->request->getCookie($this->cookieName); - $this->generateHash(); + $this->restoreHash(); + if ($this->hash === null) { + $this->generateHash(); + } } private function isCSRFCookie(): bool @@ -238,7 +252,7 @@ public function CSRFVerify(RequestInterface $request) } /** - * Returns the CSRF Hash. + * Returns the CSRF Token. * * @deprecated Use `CodeIgniter\Security\Security::getHash()` instead of using this method. * @@ -278,14 +292,35 @@ public function verify(RequestInterface $request) } $postedToken = $this->getPostedToken($request); - $token = ($postedToken !== null && $this->tokenRandomize) - ? $this->derandomize($postedToken) : $postedToken; + + try { + $token = ($postedToken !== null && $this->tokenRandomize) + ? $this->derandomize($postedToken) : $postedToken; + } catch (InvalidArgumentException $e) { + $token = null; + } // Do the tokens match? if (! isset($token, $this->hash) || ! hash_equals($this->hash, $token)) { throw SecurityException::forDisallowedAction(); } + $this->removeTokenInRequest($request); + + if ($this->regenerate) { + $this->generateHash(); + } + + log_message('info', 'CSRF token verified.'); + + return $this; + } + + /** + * Remove token in POST or JSON request data + */ + private function removeTokenInRequest(RequestInterface $request): void + { $json = json_decode($request->getBody() ?? ''); if (isset($_POST[$this->tokenName])) { @@ -297,22 +332,6 @@ public function verify(RequestInterface $request) unset($json->{$this->tokenName}); $request->setBody(json_encode($json)); } - - if ($this->regenerate) { - $this->hash = null; - if ($this->isCSRFCookie()) { - unset($_COOKIE[$this->cookieName]); - } else { - // Session based CSRF protection - $this->session->remove($this->tokenName); - } - } - - $this->generateHash(); - - log_message('info', 'CSRF token verified.'); - - return $this; } private function getPostedToken(RequestInterface $request): ?string @@ -335,7 +354,7 @@ private function getPostedToken(RequestInterface $request): ?string } /** - * Returns the CSRF Hash. + * Returns the CSRF Token. */ public function getHash(): ?string { @@ -344,6 +363,10 @@ public function getHash(): ?string /** * Randomize hash to avoid BREACH attacks. + * + * @params string $hash CSRF hash + * + * @return string CSRF token */ protected function randomize(string $hash): string { @@ -359,13 +382,24 @@ protected function randomize(string $hash): string /** * Derandomize the token. + * + * @params string $token CSRF token + * + * @throws InvalidArgumentException "hex2bin(): Hexadecimal input string must have an even length" + * + * @return string CSRF hash */ protected function derandomize(string $token): string { $key = substr($token, -static::CSRF_HASH_BYTES * 2); $value = substr($token, 0, static::CSRF_HASH_BYTES * 2); - return bin2hex(hex2bin($value) ^ hex2bin($key)); + try { + return bin2hex(hex2bin($value) ^ hex2bin($key)); + } catch (ErrorException $e) { + // "hex2bin(): Hexadecimal input string must have an even length" + throw new InvalidArgumentException($e->getMessage()); + } } /** @@ -479,32 +513,32 @@ public function sanitizeFilename(string $str, bool $relativePath = false): strin } /** - * Generates the CSRF Hash. + * Restore hash from Session or Cookie */ - protected function generateHash(): string + private function restoreHash(): void { - if ($this->hash === null) { - // If the cookie exists we will use its value. - // We don't necessarily want to regenerate it with - // each page load since a page could contain embedded - // sub-pages causing this feature to fail - if ($this->isCSRFCookie()) { - if ($this->isHashInCookie()) { - return $this->hash = $_COOKIE[$this->cookieName]; - } - } elseif ($this->session->has($this->tokenName)) { - // Session based CSRF protection - return $this->hash = $this->session->get($this->tokenName); + if ($this->isCSRFCookie()) { + if ($this->isHashInCookie()) { + $this->hash = $this->hashInCookie; } + } elseif ($this->session->has($this->tokenName)) { + // Session based CSRF protection + $this->hash = $this->session->get($this->tokenName); + } + } - $this->hash = bin2hex(random_bytes(static::CSRF_HASH_BYTES)); + /** + * Generates (Regenerate) the CSRF Hash. + */ + protected function generateHash(): string + { + $this->hash = bin2hex(random_bytes(static::CSRF_HASH_BYTES)); - if ($this->isCSRFCookie()) { - $this->saveHashInCookie(); - } else { - // Session based CSRF protection - $this->saveHashInSession(); - } + if ($this->isCSRFCookie()) { + $this->saveHashInCookie(); + } else { + // Session based CSRF protection + $this->saveHashInSession(); } return $this->hash; @@ -512,9 +546,14 @@ protected function generateHash(): string private function isHashInCookie(): bool { - return isset($_COOKIE[$this->cookieName]) - && is_string($_COOKIE[$this->cookieName]) - && preg_match('#^[0-9a-f]{32}$#iS', $_COOKIE[$this->cookieName]) === 1; + if ($this->hashInCookie === null) { + return false; + } + + $length = static::CSRF_HASH_BYTES * 2; + $pattern = '#^[0-9a-f]{' . $length . '}$#iS'; + + return preg_match($pattern, $this->hashInCookie) === 1; } private function saveHashInCookie(): void diff --git a/system/Session/Session.php b/system/Session/Session.php index 965edf88..f38de5a3 100644 --- a/system/Session/Session.php +++ b/system/Session/Session.php @@ -411,6 +411,28 @@ public function regenerate(bool $destroy = false) { $_SESSION['__ci_last_regenerate'] = time(); session_regenerate_id($destroy); + + $this->removeOldSessionCookie(); + } + + private function removeOldSessionCookie(): void + { + $response = Services::response(); + $cookieStoreInResponse = $response->getCookieStore(); + + if (! $cookieStoreInResponse->has($this->sessionCookieName)) { + return; + } + + // CookieStore is immutable. + $newCookieStore = $cookieStoreInResponse->remove($this->sessionCookieName); + + // But clear() method clears cookies in the object (not immutable). + $cookieStoreInResponse->clear(); + + foreach ($newCookieStore as $cookie) { + $response->setCookie($cookie); + } } /** diff --git a/system/Test/ControllerTestTrait.php b/system/Test/ControllerTestTrait.php index c5e255b7..2c60c250 100644 --- a/system/Test/ControllerTestTrait.php +++ b/system/Test/ControllerTestTrait.php @@ -126,7 +126,7 @@ protected function setUpControllerTestTrait(): void /** * Loads the specified controller, and generates any needed dependencies. * - * @return mixed + * @return $this */ public function controller(string $name) { @@ -215,7 +215,7 @@ public function execute(string $method, ...$params) * * @param mixed $appConfig * - * @return mixed + * @return $this */ public function withConfig($appConfig) { @@ -229,7 +229,7 @@ public function withConfig($appConfig) * * @param mixed $request * - * @return mixed + * @return $this */ public function withRequest($request) { @@ -246,7 +246,7 @@ public function withRequest($request) * * @param mixed $response * - * @return mixed + * @return $this */ public function withResponse($response) { @@ -260,7 +260,7 @@ public function withResponse($response) * * @param mixed $logger * - * @return mixed + * @return $this */ public function withLogger($logger) { @@ -272,7 +272,7 @@ public function withLogger($logger) /** * Set the controller's URI, with method chaining. * - * @return mixed + * @return $this */ public function withUri(string $uri) { @@ -286,7 +286,7 @@ public function withUri(string $uri) * * @param string|null $body * - * @return mixed + * @return $this */ public function withBody($body) { diff --git a/system/Test/Mock/MockConnection.php b/system/Test/Mock/MockConnection.php index c9d03e76..2d95b496 100644 --- a/system/Test/Mock/MockConnection.php +++ b/system/Test/Mock/MockConnection.php @@ -19,6 +19,14 @@ class MockConnection extends BaseConnection { protected $returnValues = []; + + /** + * Database schema for Postgre and SQLSRV + * + * @var string + */ + protected $schema; + public $database; public $lastQuery; diff --git a/system/Test/Mock/MockLogger.php b/system/Test/Mock/MockLogger.php index 6d6cdb9c..2ee2500b 100644 --- a/system/Test/Mock/MockLogger.php +++ b/system/Test/Mock/MockLogger.php @@ -65,7 +65,7 @@ class MockLogger | The logging system supports multiple actions to be taken when something | is logged. This is done by allowing for multiple Handlers, special classes | designed to write the log to their chosen destinations, whether that is - | a file on the getServer, a cloud-based service, or even taking actions such + | a file on the server, a cloud-based service, or even taking actions such | as emailing the dev team. | | Each handler is defined by the class name used for that handler, and it diff --git a/system/ThirdParty/Kint/Parser/Parser.php b/system/ThirdParty/Kint/Parser/Parser.php index d658b092..75781206 100644 --- a/system/ThirdParty/Kint/Parser/Parser.php +++ b/system/ThirdParty/Kint/Parser/Parser.php @@ -34,6 +34,7 @@ use Kint\Zval\Value; use ReflectionObject; use stdClass; +use TypeError; class Parser { @@ -524,7 +525,11 @@ private function parseObject(&$var, Value $o) } $stash = $val; - $copy[$i] = $refmarker; + try { + $copy[$i] = $refmarker; + } catch (TypeError $e) { + $child->reference = true; + } if ($val === $refmarker) { $child->reference = true; $val = $stash; diff --git a/system/ThirdParty/Kint/Utils.php b/system/ThirdParty/Kint/Utils.php index 5143731c..aa62bf62 100644 --- a/system/ThirdParty/Kint/Utils.php +++ b/system/ThirdParty/Kint/Utils.php @@ -109,6 +109,10 @@ public static function composerGetExtras($key = 'kint') if (\file_exists($installed) && \is_readable($installed)) { $packages = \json_decode(\file_get_contents($installed), true); + if (!\is_array($packages)) { + continue; + } + foreach ($packages as $package) { if (isset($package['extra'][$key]) && \is_array($package['extra'][$key])) { $extras = \array_replace($extras, $package['extra'][$key]); diff --git a/system/ThirdParty/Kint/resources/compiled/rich.js b/system/ThirdParty/Kint/resources/compiled/rich.js index 7ab616cf..f15d38ff 100644 --- a/system/ThirdParty/Kint/resources/compiled/rich.js +++ b/system/ThirdParty/Kint/resources/compiled/rich.js @@ -1 +1 @@ -void 0===window.kintRich&&(window.kintRich=function(){"use strict";var l={selectText:function(e){var t=window.getSelection(),a=document.createRange();a.selectNodeContents(e),t.removeAllRanges(),t.addRange(a)},each:function(e,t){Array.prototype.slice.call(document.querySelectorAll(e),0).forEach(t)},hasClass:function(e,t){return!!e.classList&&e.classList.contains(t=void 0===t?"kint-show":t)},addClass:function(e,t){e.classList.add(t=void 0===t?"kint-show":t)},removeClass:function(e,t){return e.classList.remove(t=void 0===t?"kint-show":t),e},toggle:function(e,t){var a=l.getChildren(e);a&&((t=void 0===t?l.hasClass(e):t)?l.removeClass(e):l.addClass(e),1===a.childNodes.length&&(a=a.childNodes[0].childNodes[0])&&l.hasClass(a,"kint-parent")&&l.toggle(a,t))},toggleChildren:function(e,t){var a=l.getChildren(e);if(a){var o=a.getElementsByClassName("kint-parent"),r=o.length;for(void 0===t&&(t=!l.hasClass(e));r--;)l.toggle(o[r],t)}},toggleAll:function(e){for(var t=document.getElementsByClassName("kint-parent"),a=t.length,o=!l.hasClass(e.parentNode);a--;)l.toggle(t[a],o)},switchTab:function(e){var t=e.previousSibling,a=0;for(l.removeClass(e.parentNode.getElementsByClassName("kint-active-tab")[0],"kint-active-tab"),l.addClass(e,"kint-active-tab");t;)1===t.nodeType&&a++,t=t.previousSibling;for(var o=e.parentNode.nextSibling.childNodes,r=0;r '+e.parentNode.outerHTML+""+l.mktag("/body")),t.document.close())},sortTable:function(e,a){var t=e.tBodies[0];[].slice.call(e.tBodies[0].rows).sort(function(e,t){if(e=e.cells[a].textContent.trim().toLocaleLowerCase(),t=t.cells[a].textContent.trim().toLocaleLowerCase(),isNaN(e)||isNaN(t)){if(isNaN(e)&&!isNaN(t))return 1;if(isNaN(t)&&!isNaN(e))return-1}else e=parseFloat(e),t=parseFloat(t);return e'+e.parentNode.outerHTML+""+l.mktag("/body")),t.document.close())},sortTable:function(e,a){var t=e.tBodies[0];[].slice.call(e.tBodies[0].rows).sort(function(e,t){if(e=e.cells[a].textContent.trim().toLocaleLowerCase(),t=t.cells[a].textContent.trim().toLocaleLowerCase(),isNaN(e)||isNaN(t)){if(isNaN(e)&&!isNaN(t))return 1;if(isNaN(t)&&!isNaN(e))return-1}else e=parseFloat(e),t=parseFloat(t);return enamed "database". This will make -the tests run quite a bit faster. - ## Running the tests The entire test suite can be run by simply typing one command-line command from the main directory. - > ./phpunit +```console +> ./phpunit +``` If you are using Windows, use the following command. - > vendor\bin\phpunit +```console +> vendor\bin\phpunit +``` -You can limit tests to those within a single test directory by specifying the -directory name after phpunit. +You can limit tests to those within a single test directory by specifying the +directory name after phpunit. - > ./phpunit app/Models +```console +> ./phpunit app/Models +``` ## Generating Code Coverage -To generate coverage information, including HTML reports you can view in your browser, -you can use the following command: +To generate coverage information, including HTML reports you can view in your browser, +you can use the following command: - > ./phpunit --colors --coverage-text=tests/coverage.txt --coverage-html=tests/coverage/ -d memory_limit=1024m +```console +> ./phpunit --colors --coverage-text=tests/coverage.txt --coverage-html=tests/coverage/ -d memory_limit=1024m +``` -This runs all of the tests again collecting information about how many lines, -functions, and files are tested. It also reports the percentage of the code that is covered by tests. -It is collected in two formats: a simple text file that provides an overview as well -as a comprehensive collection of HTML files that show the status of every line of code in the project. +This runs all of the tests again collecting information about how many lines, +functions, and files are tested. It also reports the percentage of the code that is covered by tests. +It is collected in two formats: a simple text file that provides an overview as well +as a comprehensive collection of HTML files that show the status of every line of code in the project. -The text file can be found at **tests/coverage.txt**. +The text file can be found at **tests/coverage.txt**. The HTML files can be viewed by opening **tests/coverage/index.html** in your favorite browser. ## PHPUnit XML Configuration @@ -77,7 +86,7 @@ do not have your own configuration file in the project root. The normal practice would be to copy ``phpunit.xml.dist`` to ``phpunit.xml`` (which is git ignored), and to tailor it as you see fit. -For instance, you might wish to exclude database tests, or automatically generate +For instance, you might wish to exclude database tests, or automatically generate HTML code coverage reports. ## Test Cases