Thank you. diff --git a/app/Config/App.php b/app/Config/App.php index c6c716822756..1a5e562ddd30 100644 --- a/app/Config/App.php +++ b/app/Config/App.php @@ -44,7 +44,7 @@ class App extends BaseConfig * URI PROTOCOL * -------------------------------------------------------------------------- * - * This item determines which getServer global should be used to retrieve the + * This item determines which server global should be used to retrieve the * URI string. The default setting of 'REQUEST_URI' works for most servers. * If your links do not seem to work, try one of the other delicious flavors: * diff --git a/app/Config/Constants.php b/app/Config/Constants.php index 0c1b53487cd9..47b92f832935 100644 --- a/app/Config/Constants.php +++ b/app/Config/Constants.php @@ -67,16 +67,16 @@ | http://tldp.org/LDP/abs/html/exitcodes.html | */ -defined('EXIT_SUCCESS') || define('EXIT_SUCCESS', 0); // no errors -defined('EXIT_ERROR') || define('EXIT_ERROR', 1); // generic error -defined('EXIT_CONFIG') || define('EXIT_CONFIG', 3); // configuration error -defined('EXIT_UNKNOWN_FILE') || define('EXIT_UNKNOWN_FILE', 4); // file not found -defined('EXIT_UNKNOWN_CLASS') || define('EXIT_UNKNOWN_CLASS', 5); // unknown class +defined('EXIT_SUCCESS') || define('EXIT_SUCCESS', 0); // no errors +defined('EXIT_ERROR') || define('EXIT_ERROR', 1); // generic error +defined('EXIT_CONFIG') || define('EXIT_CONFIG', 3); // configuration error +defined('EXIT_UNKNOWN_FILE') || define('EXIT_UNKNOWN_FILE', 4); // file not found +defined('EXIT_UNKNOWN_CLASS') || define('EXIT_UNKNOWN_CLASS', 5); // unknown class defined('EXIT_UNKNOWN_METHOD') || define('EXIT_UNKNOWN_METHOD', 6); // unknown class member -defined('EXIT_USER_INPUT') || define('EXIT_USER_INPUT', 7); // invalid user input -defined('EXIT_DATABASE') || define('EXIT_DATABASE', 8); // database error -defined('EXIT__AUTO_MIN') || define('EXIT__AUTO_MIN', 9); // lowest automatically-assigned error code -defined('EXIT__AUTO_MAX') || define('EXIT__AUTO_MAX', 125); // highest automatically-assigned error code +defined('EXIT_USER_INPUT') || define('EXIT_USER_INPUT', 7); // invalid user input +defined('EXIT_DATABASE') || define('EXIT_DATABASE', 8); // database error +defined('EXIT__AUTO_MIN') || define('EXIT__AUTO_MIN', 9); // lowest automatically-assigned error code +defined('EXIT__AUTO_MAX') || define('EXIT__AUTO_MAX', 125); // highest automatically-assigned error code /** * @deprecated Use \CodeIgniter\Events\Events::PRIORITY_LOW instead. diff --git a/app/Config/Logger.php b/app/Config/Logger.php index 406d9aaccc85..fe389d8a2078 100644 --- a/app/Config/Logger.php +++ b/app/Config/Logger.php @@ -60,7 +60,7 @@ class Logger extends BaseConfig * 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/app/Config/Paths.php b/app/Config/Paths.php index f701b7570507..1b313a7f2a45 100644 --- a/app/Config/Paths.php +++ b/app/Config/Paths.php @@ -34,8 +34,8 @@ class Paths * * If you want this front controller to use a different "app" * folder than the default one you can set its name here. The folder - * can also be renamed or relocated anywhere on your getServer. If - * you do, use a full getServer path. + * can also be renamed or relocated anywhere on your server. If + * you do, use a full server path. * * @see http://codeigniter.com/user_guide/general/managing_apps.html * diff --git a/app/Views/errors/html/error_404.php b/app/Views/errors/html/error_404.php index f81717fdd0f5..5ba9f8add075 100644 --- a/app/Views/errors/html/error_404.php +++ b/app/Views/errors/html/error_404.php @@ -73,7 +73,7 @@
404 - File Not Found
- + Sorry! Cannot seem to find the page you were looking for. diff --git a/app/Views/welcome_message.php b/app/Views/welcome_message.php index c66a9615c6be..c5325b57a813 100644 --- a/app/Views/welcome_message.php +++ b/app/Views/welcome_message.php @@ -200,9 +200,10 @@
-
-
+ - + + +
-
diff --git a/composer.json b/composer.json
index 961f9770379d..683702412d3d 100644
--- a/composer.json
+++ b/composer.json
@@ -24,10 +24,21 @@
"phpstan/phpstan": "^1.7.1",
"phpunit/phpunit": "^9.1",
"predis/predis": "^1.1 || ^2.0",
- "rector/rector": "0.13.5"
+ "rector/rector": "0.13.10"
},
"suggest": {
- "ext-fileinfo": "Improves mime type detection for files"
+ "ext-imagick": "If you use Image class ImageMagickHandler",
+ "ext-simplexml": "If you format XML",
+ "ext-mysqli": "If you use MySQL",
+ "ext-oci8": "If you use Oracle Database",
+ "ext-pgsql": "If you use PostgreSQL",
+ "ext-sqlsrv": "If you use SQL Server",
+ "ext-sqlite3": "If you use SQLite3",
+ "ext-memcache": "If you use Cache class MemcachedHandler with Memcache",
+ "ext-memcached": "If you use Cache class MemcachedHandler with Memcached",
+ "ext-redis": "If you use Cache class RedisHandler",
+ "ext-fileinfo": "Improves mime type detection for files",
+ "ext-readline": "Improves CLI::input() usability"
},
"config": {
"optimize-autoloader": true,
diff --git a/contributing/pull_request.md b/contributing/pull_request.md
index b8fe38a9fe8e..628d5593da5a 100644
--- a/contributing/pull_request.md
+++ b/contributing/pull_request.md
@@ -55,6 +55,8 @@ You can check the coding style violations:
### Unit Testing
+If you are not familiar with Unit Testing, see [the forum thread](https://forum.codeigniter.com/showthread.php?tid=81830).
+
Unit testing is expected for all CodeIgniter components. We use PHPUnit,
and run unit tests using GitHub Actions for each PR submitted or changed.
@@ -171,8 +173,9 @@ PRs with any enhancement should be sent to next minor version branch, e.g. __"4.
The __"master"__ branch will always contain the latest stable version and is kept clean so a "hotfix" (e.g. an
emergency security patch) can be applied to the "master" branch to create a new version, without worrying
-about other features holding it up. For this reason, all commits need to be made to the "develop" branch,
-and any sent to the "master" branch will be closed automatically. If you have multiple changes to submit,
+about other features holding it up. Any sent to the "master" branch will be closed automatically.
+
+If you have multiple changes to submit,
please place all changes into their own branch on your fork.
**One thing at a time:** A pull request should only contain one change. That does not mean only one commit,
@@ -237,7 +240,12 @@ The best way to contribute is to fork the CodeIgniter4 repository, and "clone" t
- `> cd CodeIgniter4/`
- `> composer update`
6. Create a new [branch](https://help.github.com/en/articles/about-branches) in your project for each set of changes you want to make.
- - `> git checkout -b
` + - If your PR is for bug fixes: + - `> git switch develop` + - `> git switch -c ` + - If your PR has any enhancement, create new branch from next minor version branch, e.g. __"4.3"__: + - `> git switch ` + - `> git switch -c ` 7. Fix existing bugs on the [Issue tracker](https://github.com/codeigniter4/CodeIgniter4/issues) after confirming that no one else is working on them. 8. [Commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) the changed files in your contribution branch. - `> git commit` diff --git a/contributing/workflow.md b/contributing/workflow.md index c4c4bb073865..9badbde428f3 100644 --- a/contributing/workflow.md +++ b/contributing/workflow.md @@ -16,16 +16,16 @@ values for when you try these: ## Branching -CodeIgniter uses the -[Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/) -branching model, which requires all pull requests to be sent to the -"develop" branch. This is where the next planned version will be -developed. The "master" branch will always contain the latest stable +- All bug fix PRs should be sent to the __"develop"__ branch, this is where the next bug fix version will be developed. +- PRs with any enhancement should be sent to next minor version branch, e.g. __"4.3"__ + +The "master" branch will always contain the latest stable version and is kept clean so a "hotfix" (e.g: an emergency security patch) can be applied to master to create a new version, without -worrying about other features holding it up. For this reason, all -commits need to be made to "develop" and any sent to "master" will be -closed automatically. If you have multiple changes to submit, please +worrying about other features holding it up. Any sent to "master" will be +closed automatically. + +If you have multiple changes to submit, please place each change into their own branch on your fork. One thing at a time: a pull request should only contain one change. That @@ -61,10 +61,12 @@ ORIGIN\_URL. Clone your repository, leaving a local folder for you to work with: - cd ALL_PROJECTS - git clone ORIGIN_URL +```console +> cd ALL_PROJECTS +> git clone ORIGIN_URL +``` -## Syncing develop +## Syncing your repository Within your local repository, Git will have created an alias, **origin**, for the GitHub repository it is bound to. You want to create @@ -72,16 +74,20 @@ an alias for the shared repository as well, so that you can "synch" the two, making sure that your repository includes any other contributions that have been merged by us into the shared repo: - git remote add upstream UPSTREAM_URL +```console +> git remote add upstream UPSTREAM_URL +``` Then synchronizing is done by pulling from us and pushing to you. This is normally done locally, so that you can resolve any merge conflicts. For instance, to synchronize **develop** branches: - git switch develop - git fetch upstream - git merge upstream/develop - git push origin develop +```console +> git switch develop +> git fetch upstream +> git merge upstream/develop +> git push origin develop +``` You might get merge conflicts when you merge. It is your responsibility to resolve those locally, so that you can continue @@ -105,12 +111,25 @@ This local branch should be named appropriately, for instance "fix/problem123" or "new/mind-reader". The slashes in these branch names is optional, and implies a sort of namespacing if used. -For instance, make sure you are in the *develop* branch, and create a -new feature branch, based on *develop*, for a new feature you are +- All bug fix PRs should be sent to the __"develop"__ branch, this is where the next bug fix version will be developed. +- PRs with any enhancement should be sent to next minor version branch, e.g. __"4.3"__ + +For instance, if you send a PR to __"develop"__ branch, make sure you are in the *develop* branch, and create a +new bugfix branch, based on *develop*, for a new feature you are creating: - git switch develop - git switch -c new/mind-reader +```console +> git switch develop +> git switch -c fix/problem123 +``` + +If you send a PR with an enhancement, make sure you are in the *next minor version* branch, +and create a new feature branch, based on, e.g., *4.3*, for a new feature you are creating: + +```console +> git switch 4.3 +> git switch -c new/mind-reader +``` Saving changes only updates your local working area. @@ -123,23 +142,27 @@ in. You can have as many commits in a branch as you need to "get it right". For instance, to commit your work from a debugging session: - git add . - git commit -S -m "Find and fix the broken reference problem" +```console +> git add . +> git commit -S -m "Find and fix the broken reference problem" +``` Just make sure that your commits in a feature branch are all related. If you are working on two features at a time, then you will want to switch between them to keep the contributions separate. For instance: - git switch new/mind-reader - // work away - git add . - git commit -S -m "Added adapter for abc" - git switch fix/issue-123 - // work away - git add . - git commit -S -m "Fixed problem in DEF\Something" - git switch develop +```console +> git switch new/mind-reader +> ## work away +> git add . +> git commit -S -m "Added adapter for abc" +> git switch fix/issue-123 +> ## work away +> git add . +> git commit -S -m "Fixed problem in DEF\Something" +> git switch develop +``` The last checkout makes sure that you end up in your *develop* branch as a starting point for your next session working with your repository. @@ -157,19 +180,25 @@ It is a lot easier to resolve conflicts at this stage. Synchronize your repository: - git switch develop - git fetch upstream - git merge upstream/develop - git push origin develop +```console +> git switch develop +> git fetch upstream +> git merge upstream/develop +> git push origin develop +``` Bring your feature branch up to date: - git switch new/mind-reader - git rebase upstream/develop +```console +> git switch fix/issue-123 +> git rebase upstream/develop +``` And finally push your local branch to your GitHub repository: - git push --force-with-lease origin new/mind-reader +```console +> git push --force-with-lease origin fix/issue-123 +``` ## Pull Requests @@ -177,7 +206,7 @@ On GitHub, you propose your changes one feature branch at a time, by switching to the branch you wish to contribute, and then clicking on "New pull request". -Make sure the pull request is for the shared **develop** branch, or it +Make sure the pull request is for the shared __"develop"__ or next minor version branch, e.g. __"4.3"__, or it may be rejected. Make sure that the PR title is helpful for the maintainers and other @@ -218,20 +247,24 @@ And if your PRs have the breaking changes, label the following label: If you are asked for changes in the review, commit the fix in your branch and push it to GitHub again. -If the `develop` branch progresses and conflicts arise that prevent merging, or if you are asked to *rebase*, +If the __"develop"__ or next minor version branch, e.g. __"4.3"__, progresses and conflicts arise that prevent merging, or if you are asked to *rebase*, do the following: Synchronize your repository: - git switch develop - git fetch upstream - git merge upstream/develop - git push origin develop +```console +> git switch develop +> git fetch upstream +> git merge upstream/develop +> git push origin develop +``` Bring your feature branch up to date: - git switch new/mind-reader - git rebase upstream/develop +```console +> git switch fix/problem123 +> git rebase upstream/develop +``` You might get conflicts when you rebase. It is your responsibility to resolve those locally, so that you can continue @@ -239,7 +272,9 @@ collaborating with the shared repository. And finally push your local branch to your GitHub repository: - git push --force-with-lease origin new/mind-reader +```console +> git push --force-with-lease origin fix/problem123 +``` ## Cleanup diff --git a/env b/env index 67faaee5b57a..cc0681c67711 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/phpstan-baseline.neon.dist b/phpstan-baseline.neon.dist index b855e1f7664c..feeeaf9b7980 100644 --- a/phpstan-baseline.neon.dist +++ b/phpstan-baseline.neon.dist @@ -70,11 +70,6 @@ parameters: count: 1 path: system/Cache/Handlers/MemcachedHandler.php - - - message: "#^Variable \\$config in empty\\(\\) always exists and is not falsy\\.$#" - count: 1 - path: system/Cache/Handlers/MemcachedHandler.php - - message: "#^Variable \\$data might not be defined\\.$#" count: 1 @@ -90,11 +85,6 @@ parameters: count: 1 path: system/Cache/Handlers/RedisHandler.php - - - message: "#^Variable \\$config in empty\\(\\) always exists and is not falsy\\.$#" - count: 1 - path: system/Cache/Handlers/RedisHandler.php - - message: "#^Call to an undefined method CodeIgniter\\\\HTTP\\\\Request\\:\\:getPost\\(\\)\\.$#" count: 1 @@ -135,11 +125,6 @@ parameters: count: 1 path: system/Database/BaseConnection.php - - - message: "#^Negated boolean expression is always true\\.$#" - count: 2 - path: system/Database/BaseConnection.php - - message: "#^Negated boolean expression is always false\\.$#" count: 3 @@ -342,7 +327,7 @@ parameters: - message: "#^Access to an undefined property CodeIgniter\\\\Database\\\\BaseConnection\\:\\:\\$schema\\.$#" - count: 14 + count: 13 path: system/Database/SQLSRV/Forge.php - @@ -450,11 +435,6 @@ parameters: count: 1 path: system/Database/Seeder.php - - - message: "#^Expression on left side of \\?\\? is not nullable\\.$#" - count: 1 - path: system/Debug/Exceptions.php - - message: "#^Property Config\\\\Exceptions\\:\\:\\$sensitiveDataInTrace \\(array\\) in isset\\(\\) is not nullable\\.$#" count: 1 diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 6965a686f8e2..741cd106e080 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -70,7 +70,6 @@ - diff --git a/public/index.php b/public/index.php index 51f4be81e731..96e7f45ff4ac 100644 --- a/public/index.php +++ b/public/index.php @@ -1,5 +1,17 @@ parallel(); // paths to refactor; solid alternative to CLI arguments - $rectorConfig->paths([__DIR__ . '/app', __DIR__ . '/system', __DIR__ . '/tests', __DIR__ . '/utils/Rector']); + $rectorConfig->paths([__DIR__ . '/app', __DIR__ . '/system', __DIR__ . '/tests', __DIR__ . '/utils']); // do you need to include constants, class aliases or custom autoloader? files listed will be executed $rectorConfig->bootstrapFiles([ __DIR__ . '/system/Test/bootstrap.php', ]); + $rectorConfig->phpstanConfig(__DIR__ . '/phpstan.neon.dist'); + // is there a file you need to skip? $rectorConfig->skip([ __DIR__ . '/app/Views', @@ -120,6 +125,17 @@ // use mt_rand instead of random_int on purpose on non-cryptographically random RandomFunctionRector::class, + + // @TODO remove if https://github.com/rectorphp/rector-phpunit/issues/86 is fixed + GetMockBuilderGetMockToCreateMockRector::class => [ + __DIR__ . '/tests/system/Email/EmailTest.php', + ], + + // buggy on read based on @var on property on Trait + RemoveAlwaysTrueIfConditionRector::class => [ + '**Trait.php', + __DIR__ . '/system/Test/ControllerTester.php', + ], ]); // auto import fully qualified class names @@ -160,4 +176,5 @@ 'SQLite3', ]); $rectorConfig->rule(PrivatizeFinalClassPropertyRector::class); + $rectorConfig->rule(CompleteDynamicPropertiesRector::class); }; diff --git a/spark b/spark index 225422aace74..49a00aa8a699 100755 --- a/spark +++ b/spark @@ -26,6 +26,18 @@ if (strpos(PHP_SAPI, 'cgi') === 0) { exit("The cli tool is not supported when running php-cgi. It needs php-cli to function!\n\n"); } +// Check PHP version. +$minPhpVersion = '7.4'; // If you update this, don't forget to update `public/index.php`. +if (version_compare(PHP_VERSION, $minPhpVersion, '<')) { + $message = sprintf( + 'Your PHP version must be %s or higher to run CodeIgniter. Current version: %s', + $minPhpVersion, + PHP_VERSION + ); + + exit($message); +} + // We want errors to be shown when using it from the CLI. error_reporting(-1); ini_set('display_errors', '1'); diff --git a/system/API/ResponseTrait.php b/system/API/ResponseTrait.php index f20affaffaf5..5f6a52c497e5 100644 --- a/system/API/ResponseTrait.php +++ b/system/API/ResponseTrait.php @@ -320,8 +320,15 @@ protected function format($data = null) $mime = "application/{$this->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 311428fe4165..f87e4485c6a7 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 39bd9ce2cb4c..8817d6b4e7d4 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 d88374e80944..7a5030314948 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 51706b477cd4..e1452f3be814 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 875dcd3f7bcd..380491192066 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 2517c6a5df11..babb7c037be1 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 b317652dd99e..6b6f60e0a6b7 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 553825f615e8..df179e7455e6 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 a4a05233a071..7dbfbc8e5705 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 7e3d6a4807ff..4666a54ca888 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 f36ddd9e362d..0f25eebf47f1 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 30e28a1dc840..962483bb68b2 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 d77cfb1bbc51..5213f426bca7 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 31188c1b03a1..9e02fc43e3f5 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 9dca50115f51..169795c77a44 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 af7dd2f0e437..d3f3223b608a 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 2d54b90f6961..f18417c55155 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 0e103a515f00..413c0a4726ee 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 a2b3b7637ce7..13f58dc12954 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 0ffd245fa7a0..d46dfdfde498 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 5badaf1c4881..e4fd5b3f5463 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 dc0b26f57c0e..b84111fb0aa8 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 9cd5bad945cd..42393cd63aa9 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 72a1b0980a28..1342378733d6 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 1d80f687568c..b0a94670ff18 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 6827ba70b54f..7b58bdb237d8 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 a5bf829a6b74..8d0e0b419620 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 67ef057e12de..95ec9ff0b601 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 35ede04c2c9c..1085b30b461e 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 1f48f20bd54e..154c9f97b554 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 879dab718a16..9994aa7a045a 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 b91fb16023b0..462a019eae15 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 753dfe7d2bf7..55c9c95e2205 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 c79dfc5f56b4..bfb156da3e53 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 e4a36384dba0..c1dcf1c40ead 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 99f425a410be..41af062cfe2b 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 194f7441717b..39adf0661215 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 2cda4d72238d..224bbdc7eb68 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 5e41631536c7..06511f73907f 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 41ae4959e594..ced8afc6e04f 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 2a773f1785dc..531df0e48f11 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 853c15c07ae1..20b208fded43 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 69788a0582c1..d5d5e3aae42e 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 04ba3e8973e9..f2b211152b87 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 b9b3daaebb25..7933351a0507 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 0563be287cd4..5f2c70b19ff7 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 ff2ee3111ebe..36292621397e 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 abd666fbca52..04ad8b80167e 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 f66c2a926b87..459c30709b0b 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 d37f498e2d44..08e2d7b4b91a 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 99a4e39588b9..fb65d5436802 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 2addc2b2a80a..2746a66913da 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 e4fb73841c1d..90e36ad5dccc 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 b379a6e16999..dfb9dcedf9b4 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 b9cabbba6793..1040c1578628 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 c24827721c00..c551dee9e09d 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 493c990e1eae..bcaffa49fbe8 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 c1d615c515a8..9cf729bb841e 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 f8dd174b4332..66c7ce263fed 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 e0a6ff9f2386..7634b415ec7e 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 9d2b44876cc9..5a72efed67d3 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 2466900d0d3e..aaab2a46e0be 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 0a1e16cedc29..c61229dad345 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 6914f318829c..a939060ad73f 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 8efd11c1ea6a..a533f5240f7a 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 659a0a252db2..dd26979af13d 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 5e0bafe00841..a1482db7d49a 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 8902b8ea4d89..5ee3cae27bc3 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 4b2087d9dfed..04bd6b15fd1f 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 32843ba9e98d..80861646efdc 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 809545c1513b..42bf93831e85 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 467e2687c40d..3b832a2412be 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 b2456f367676..d5a1616b481b 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 4998a16c9ba6..66a950e72fee 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 e5e4350a5db6..b12de34b5d94 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 3adb7bf68857..529e10b0a8f7 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 965edf88d9ed..f38de5a33580 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 c5e255b732e4..2c60c250cf34 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 c9d03e7638d6..2d95b496aab8 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 6d6cdb9c9c7a..2ee2500b0679 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 d658b092479d..75781206bf01 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 5143731c75c4..aa62bf623435 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 7ab616cf62c1..f15d38ff0616 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 e` named `Database`. This will make the tests run quite a bit faster. @@ -38,38 +49,50 @@ the tests run quite a bit faster. 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 +You can limit tests to those within a single test directory by specifying the directory name after phpunit. All core tests are stored under **tests/system**. - > ./phpunit tests/system/HTTP/ +```console +> ./phpunit tests/system/HTTP/ +``` Individual tests can be run by including the relative path to the test file. - > ./phpunit tests/system/HTTP/RequestTest.php +```console +> ./phpunit tests/system/HTTP/RequestTest.php +``` You can run the tests without running the live database and the live cache tests. - > ./phpunit --exclude-group DatabaseLive,CacheLive +```console +> ./phpunit --exclude-group DatabaseLive,CacheLive +``` ## 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 @@ -80,5 +103,5 @@ 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. diff --git a/tests/_support/Validation/uploads/abc77tz b/tests/_support/Validation/uploads/abc77tz new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/tests/system/CLI/ConsoleTest.php b/tests/system/CLI/ConsoleTest.php index 61905e71c613..1d24e1dd778c 100644 --- a/tests/system/CLI/ConsoleTest.php +++ b/tests/system/CLI/ConsoleTest.php @@ -24,6 +24,7 @@ */ final class ConsoleTest extends CIUnitTestCase { + private DotEnv $env; private $stream_filter; protected function setUp(): void diff --git a/tests/system/CodeIgniterTest.php b/tests/system/CodeIgniterTest.php index 29d511d2a9d3..642539eb545f 100644 --- a/tests/system/CodeIgniterTest.php +++ b/tests/system/CodeIgniterTest.php @@ -15,8 +15,10 @@ use CodeIgniter\HTTP\Response; use CodeIgniter\Router\RouteCollection; use CodeIgniter\Test\CIUnitTestCase; +use CodeIgniter\Test\Filters\CITestStreamFilter; use CodeIgniter\Test\Mock\MockCodeIgniter; use Config\App; +use Config\Filters; use Config\Modules; use Tests\Support\Filters\Customfilter; @@ -531,4 +533,64 @@ public function testSpoofRequestMethodCannotUseGET() $this->assertSame('post', Services::request()->getMethod()); } + + /** + * @see https://github.com/codeigniter4/CodeIgniter4/issues/6281 + */ + public function testPageCacheSendSecureHeaders() + { + // Suppress command() output + CITestStreamFilter::$buffer = ''; + $outputStreamFilter = stream_filter_append(STDOUT, 'CITestStreamFilter'); + $errorStreamFilter = stream_filter_append(STDERR, 'CITestStreamFilter'); + + // Clear Page cache + command('cache:clear'); + + $_SERVER['REQUEST_URI'] = '/test'; + + $routes = Services::routes(); + $routes->add('test', static function () { + CodeIgniter::cache(3600); + + $response = Services::response(); + $string = 'This is a test page. Elapsed time: {elapsed_time}'; + + return $response->setBody($string); + }); + $router = Services::router($routes, Services::request()); + Services::injectMock('router', $router); + + /** @var Filters $filterConfig */ + $filterConfig = config('Filters'); + $filterConfig->globals['after'] = ['secureheaders']; + Services::filters($filterConfig); + + // The first response to be cached. + ob_start(); + $this->codeigniter->useSafeOutput(true)->run(); + $output = ob_get_clean(); + + $this->assertStringContainsString('This is a test page', $output); + $response = Services::response(); + $headers = $response->headers(); + $this->assertArrayHasKey('X-Frame-Options', $headers); + + // The second response from the Page cache. + ob_start(); + $this->codeigniter->useSafeOutput(true)->run(); + $output = ob_get_clean(); + + $this->assertStringContainsString('This is a test page', $output); + $response = Services::response(); + $headers = $response->headers(); + $this->assertArrayHasKey('X-Frame-Options', $headers); + + // Clear Page cache + command('cache:clear'); + + // Remove stream fliters + stream_filter_remove($outputStreamFilter); + stream_filter_remove($errorStreamFilter); + } } diff --git a/tests/system/CommonFunctionsTest.php b/tests/system/CommonFunctionsTest.php index 4f27a8ab2f2c..5c2b6efa7f83 100644 --- a/tests/system/CommonFunctionsTest.php +++ b/tests/system/CommonFunctionsTest.php @@ -12,6 +12,7 @@ namespace CodeIgniter; use CodeIgniter\Config\BaseService; +use CodeIgniter\HTTP\IncomingRequest; use CodeIgniter\HTTP\RedirectResponse; use CodeIgniter\HTTP\Response; use CodeIgniter\HTTP\URI; @@ -43,10 +44,13 @@ */ final class CommonFunctionsTest extends CIUnitTestCase { + private ?App $config = null; + private IncomingRequest $request; + protected function setUp(): void { unset($_ENV['foo'], $_SERVER['foo']); - Services::reset(); + $this->resetServices(); parent::setUp(); } @@ -589,8 +593,6 @@ public function testTraceWithCSP() public function testCspStyleNonce() { - $this->resetServices(); - $config = config('App'); $config->CSPEnabled = true; @@ -599,11 +601,20 @@ public function testCspStyleNonce() public function testCspScriptNonce() { - $this->resetServices(); - $config = config('App'); $config->CSPEnabled = true; $this->assertStringStartsWith('nonce="', csp_script_nonce()); } + + public function testLangOnCLI() + { + Services::createRequest(new App(), true); + + $message = lang('CLI.generator.fileCreate', ['TestController.php']); + + $this->assertSame('File created: TestController.php', $message); + + $this->resetServices(); + } } diff --git a/tests/system/CommonSingleServiceTest.php b/tests/system/CommonSingleServiceTest.php index 7d078a6f9a2e..1d96305c35c1 100644 --- a/tests/system/CommonSingleServiceTest.php +++ b/tests/system/CommonSingleServiceTest.php @@ -95,6 +95,7 @@ public static function serviceNamesProvider(): iterable static $services = []; static $excl = [ '__callStatic', + 'createRequest', 'serviceExists', 'reset', 'resetSingle', diff --git a/tests/system/Config/DotEnvTest.php b/tests/system/Config/DotEnvTest.php index dbd296040117..aa718bd6dea6 100644 --- a/tests/system/Config/DotEnvTest.php +++ b/tests/system/Config/DotEnvTest.php @@ -13,6 +13,7 @@ use CodeIgniter\Test\CIUnitTestCase; use org\bovigo\vfs\vfsStream; +use org\bovigo\vfs\vfsStreamDirectory; /** * @backupGlobals enabled @@ -23,6 +24,8 @@ */ final class DotEnvTest extends CIUnitTestCase { + private ?vfsStreamDirectory $root; + private string $path; private $fixturesFolder; protected function setUp(): void diff --git a/tests/system/ControllerTest.php b/tests/system/ControllerTest.php index 6a16ea7bb17f..cc77c7507b15 100644 --- a/tests/system/ControllerTest.php +++ b/tests/system/ControllerTest.php @@ -33,6 +33,8 @@ */ final class ControllerTest extends CIUnitTestCase { + private App $config; + /** * @var Controller */ diff --git a/tests/system/Database/BaseConnectionTest.php b/tests/system/Database/BaseConnectionTest.php index a4dd9d55015a..3c1be631d73e 100644 --- a/tests/system/Database/BaseConnectionTest.php +++ b/tests/system/Database/BaseConnectionTest.php @@ -14,6 +14,7 @@ use CodeIgniter\Database\Exceptions\DatabaseException; use CodeIgniter\Test\CIUnitTestCase; use CodeIgniter\Test\Mock\MockConnection; +use Generator; use Throwable; /** @@ -163,4 +164,111 @@ public function testMagicGetMissing() $this->assertNull($db->foobar); } + + /** + * These tests are intended to confirm the current behavior. + * We do not know if all of these are the correct behavior. + * + * @dataProvider identifiersProvider + */ + public function testProtectIdentifiers( + bool $prefixSingle, + bool $protectIdentifiers, + bool $fieldExists, + string $item, + string $expected + ) { + $db = new MockConnection($this->options); + + $return = $db->protectIdentifiers($item, $prefixSingle, $protectIdentifiers, $fieldExists); + + $this->assertSame($expected, $return); + } + + public function identifiersProvider(): Generator + { + yield from [ + // $prefixSingle, $protectIdentifiers, $fieldExists, $item, $expected + 'empty string' => [false, true, true, '', ''], + 'empty string prefix' => [true, true, true, '', '"test_"'], // Incorrect usage? or should be ''? + + 'single table' => [false, true, false, 'jobs', '"jobs"'], + 'single table prefix' => [true, true, false, 'jobs', '"test_jobs"'], + + 'string' => [false, true, true, "'Accountant'", "'Accountant'"], + 'single prefix' => [true, true, true, "'Accountant'", "'Accountant'"], + + 'numbers only' => [false, true, false, '12345', '12345'], // Should be quoted? + 'numbers only prefix' => [true, true, false, '12345', '"test_12345"'], + + 'table AS alias' => [false, true, false, 'role AS myRole', '"role" AS "myRole"'], + 'table AS alias prefix' => [true, true, false, 'role AS myRole', '"test_role" AS "myRole"'], + + 'quoted table' => [false, true, false, '"jobs"', '"jobs"'], + 'quoted table prefix' => [true, true, false, '"jobs"', '"test_jobs"'], + + 'quoted table alias' => [false, true, false, '"jobs" "j"', '"jobs" "j"'], + 'quoted table alias prefix' => [true, true, false, '"jobs" "j"', '"test_jobs" "j"'], + + 'table.*' => [false, true, true, 'jobs.*', '"test_jobs".*'], // Prefixed because it has segments + 'table.* prefix' => [true, true, true, 'jobs.*', '"test_jobs".*'], + 'table.column' => [false, true, true, 'users.id', '"test_users"."id"'], // Prefixed because it has segments + 'table.column prefix' => [true, true, true, 'users.id', '"test_users"."id"'], + 'table.column AS' => [ + false, true, true, + 'users.id AS user_id', + '"test_users"."id" AS "user_id"', // Prefixed because it has segments + ], + 'table.column AS prefix' => [ + true, true, true, + 'users.id AS user_id', + '"test_users"."id" AS "user_id"', + ], + + 'function table.column' => [false, true, true, 'LOWER(jobs.name)', 'LOWER(jobs.name)'], + 'function table.column prefix' => [true, true, true, 'LOWER(jobs.name)', 'LOWER(jobs.name)'], + + 'function only' => [false, true, true, 'RAND()', 'RAND()'], + 'function column' => [false, true, true, 'SUM(id)', 'SUM(id)'], + + 'function column AS' => [ + false, true, true, + 'COUNT(payments) AS myAlias', + 'COUNT(payments) AS myAlias', + ], + 'function column AS prefix' => [ + true, true, true, + 'COUNT(payments) AS myAlias', + 'COUNT(payments) AS myAlias', + ], + + 'function quoted table column AS' => [ + false, true, true, + 'MAX("db"."payments") AS "payments"', + 'MAX("db"."payments") AS "payments"', + ], + + 'quoted column operator AS' => [ + false, true, true, + '"numericValue1" + "numericValue2" AS "numericResult"', + '"numericValue1"" + ""numericValue2" AS "numericResult"', // Cannot process correctly + ], + 'quoted column operator AS no-protect' => [ + false, false, true, + '"numericValue1" + "numericValue2" AS "numericResult"', + '"numericValue1" + "numericValue2" AS "numericResult"', + ], + + 'sub query' => [ + false, true, true, + '(SELECT SUM(payments.amount) FROM payments WHERE payments.invoice_id=4) AS amount_paid)', + '(SELECT SUM(payments.amount) FROM payments WHERE payments.invoice_id=4) AS amount_paid)', + ], + 'sub query with missing `)` at the end' => [ + false, true, true, + '(SELECT MAX(advance_amount) FROM "orders" WHERE "id" > 2', + '(SELECT MAX(advance_amount) FROM "orders" WHERE "id" > 2', + ], + ]; + } } diff --git a/tests/system/Database/Builder/DeleteTest.php b/tests/system/Database/Builder/DeleteTest.php index 777a646992c4..ab27a2ec9266 100644 --- a/tests/system/Database/Builder/DeleteTest.php +++ b/tests/system/Database/Builder/DeleteTest.php @@ -60,6 +60,20 @@ public function testGetCompiledDelete() $this->assertSame($expectedSQL, $sql); } + public function testGetCompiledDeleteWithTableAlias() + { + $builder = $this->db->table('jobs j'); + + $builder->where('id', 1); + $sql = $builder->getCompiledDelete(); + + $expectedSQL = <<<'EOL' + DELETE FROM "jobs" + WHERE "id" = 1 + EOL; + $this->assertSame($expectedSQL, $sql); + } + public function testGetCompiledDeleteWithLimit() { $builder = $this->db->table('jobs'); diff --git a/tests/system/Database/Builder/InsertTest.php b/tests/system/Database/Builder/InsertTest.php index 2e6d3b89650e..774dd1082ed0 100644 --- a/tests/system/Database/Builder/InsertTest.php +++ b/tests/system/Database/Builder/InsertTest.php @@ -33,7 +33,7 @@ protected function setUp(): void $this->db = new MockConnection([]); } - public function testSimpleInsert() + public function testInsertArray() { $builder = $this->db->table('jobs'); @@ -59,6 +59,61 @@ public function testSimpleInsert() $this->assertSame($expectedBinds, $builder->getBinds()); } + public function testInsertObject() + { + $builder = $this->db->table('jobs'); + + $insertData = (object) [ + 'id' => 1, + 'name' => 'Grocery Sales', + ]; + $builder->testMode()->insert($insertData, true); + + $expectedSQL = 'INSERT INTO "jobs" ("id", "name") VALUES (1, \'Grocery Sales\')'; + $expectedBinds = [ + 'id' => [ + 1, + true, + ], + 'name' => [ + 'Grocery Sales', + true, + ], + ]; + + $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledInsert())); + $this->assertSame($expectedBinds, $builder->getBinds()); + } + + /** + * @see https://github.com/codeigniter4/CodeIgniter4/issues/5365 + */ + public function testInsertWithTableAlias() + { + $builder = $this->db->table('jobs as j'); + + $insertData = [ + 'id' => 1, + 'name' => 'Grocery Sales', + ]; + $builder->testMode()->insert($insertData, true); + + $expectedSQL = 'INSERT INTO "jobs" ("id", "name") VALUES (1, \'Grocery Sales\')'; + $expectedBinds = [ + 'id' => [ + 1, + true, + ], + 'name' => [ + 'Grocery Sales', + true, + ], + ]; + + $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledInsert())); + $this->assertSame($expectedBinds, $builder->getBinds()); + } + public function testThrowsExceptionOnNoValuesSet() { $builder = $this->db->table('jobs'); diff --git a/tests/system/Database/Builder/SelectTest.php b/tests/system/Database/Builder/SelectTest.php index 7c2c44bd246f..19dff466cf03 100644 --- a/tests/system/Database/Builder/SelectTest.php +++ b/tests/system/Database/Builder/SelectTest.php @@ -110,6 +110,39 @@ public function testSelectWorksWithRawSql() $this->assertSame($expected, str_replace("\n", ' ', $builder->getCompiledSelect())); } + /** + * @see https://github.com/codeigniter4/CodeIgniter4/issues/4311 + */ + public function testSelectWorksWithEscpaeFalse() + { + $builder = new BaseBuilder('users', $this->db); + + $builder->select('"numericValue1" + "numericValue2" AS "numericResult"', false); + + $expected = 'SELECT "numericValue1" + "numericValue2" AS "numericResult" FROM "users"'; + + $this->assertSame($expected, str_replace("\n", ' ', $builder->getCompiledSelect())); + } + + /** + * @see https://github.com/codeigniter4/CodeIgniter4/issues/4355 + */ + public function testSelectRegularExpressionWorksWithEscpaeFalse() + { + $builder = new BaseBuilder('ob_human_resources', $this->db); + + $builder->select( + 'REGEXP_SUBSTR(ral_anno,"[0-9]{1,2}([,.][0-9]{1,3})([,.][0-9]{1,3})") AS ral', + false + ); + + $expected = <<<'SQL' + SELECT REGEXP_SUBSTR(ral_anno,"[0-9]{1,2}([,.][0-9]{1,3})([,.][0-9]{1,3})") AS ral + FROM "ob_human_resources" + SQL; + $this->assertSame($expected, $builder->getCompiledSelect()); + } + public function testSelectMinWithNoAlias() { $builder = new BaseBuilder('invoices', $this->db); diff --git a/tests/system/Database/Builder/UpdateTest.php b/tests/system/Database/Builder/UpdateTest.php index 5af1490f6f66..55eec68b8f2a 100644 --- a/tests/system/Database/Builder/UpdateTest.php +++ b/tests/system/Database/Builder/UpdateTest.php @@ -34,11 +34,35 @@ protected function setUp(): void $this->db = new MockConnection([]); } - public function testUpdate() + public function testUpdateArray() { $builder = new BaseBuilder('jobs', $this->db); - $builder->testMode()->where('id', 1)->update(['name' => 'Programmer'], null, null); + $data = ['name' => 'Programmer']; + $builder->testMode()->where('id', 1)->update($data, null, null); + + $expectedSQL = 'UPDATE "jobs" SET "name" = \'Programmer\' WHERE "id" = 1'; + $expectedBinds = [ + 'id' => [ + 1, + true, + ], + 'name' => [ + 'Programmer', + true, + ], + ]; + + $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledUpdate())); + $this->assertSame($expectedBinds, $builder->getBinds()); + } + + public function testUpdateObject() + { + $builder = new BaseBuilder('jobs', $this->db); + + $data = (object) ['name' => 'Programmer']; + $builder->testMode()->where('id', 1)->update($data, null, null); $expectedSQL = 'UPDATE "jobs" SET "name" = \'Programmer\' WHERE "id" = 1'; $expectedBinds = [ diff --git a/tests/system/Database/Builder/WhereTest.php b/tests/system/Database/Builder/WhereTest.php index a10f20e8545d..b98e470ffb17 100644 --- a/tests/system/Database/Builder/WhereTest.php +++ b/tests/system/Database/Builder/WhereTest.php @@ -15,6 +15,9 @@ use CodeIgniter\Database\RawSql; use CodeIgniter\Test\CIUnitTestCase; use CodeIgniter\Test\Mock\MockConnection; +use DateTime; +use Error; +use ErrorException; use stdClass; /** @@ -460,4 +463,144 @@ public function testWhereWithLower() $expectedSQL = 'SELECT * FROM "jobs" WHERE LOWER(jobs.name) = \'accountant\''; $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledSelect())); } + + public function testWhereValueIsString() + { + $builder = $this->db->table('users'); + + $builder->where('id', '1'); + + $expectedSQL = <<<'SQL' + SELECT * FROM "users" WHERE "id" = '1' + SQL; + $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledSelect())); + } + + public function testWhereValueIsFloat() + { + $builder = $this->db->table('users'); + + $builder->where('id', 1.234); + + $expectedSQL = <<<'SQL' + SELECT * FROM "users" WHERE "id" = 1.234 + SQL; + $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledSelect())); + } + + /** + * The current behavior assumes MySQL. + * Other databases may not work well, so we may want to change the behavior + * to match the specifications of the database driver. + */ + public function testWhereValueIsTrue() + { + $builder = $this->db->table('users'); + + $builder->where('id', true); + + $expectedSQL = 'SELECT * FROM "users" WHERE "id" = 1'; + $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledSelect())); + } + + /** + * The current behavior assumes MySQL. + * Other databases may not work well, so we may want to change the behavior + * to match the specifications of the database driver. + */ + public function testWhereValueIsFalse() + { + $builder = $this->db->table('users'); + + $builder->where('id', false); + + $expectedSQL = 'SELECT * FROM "users" WHERE "id" = 0'; + $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledSelect())); + } + + /** + * Check if SQL injection is not possible when unexpected values are passed + */ + public function testWhereValueIsArray() + { + $builder = $this->db->table('users'); + + $builder->where('id', ['a', 'b']); + + // SQL syntax error + $expectedSQL = <<<'SQL' + SELECT * FROM "users" WHERE "id" = ('a','b') + SQL; + $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledSelect())); + } + + /** + * Check if SQL injection is not possible when unexpected values are passed + */ + public function testWhereValueIsArrayOfArray() + { + $this->expectException(ErrorException::class); + $this->expectExceptionMessage('Array to string conversion'); + + $builder = $this->db->table('users'); + + $builder->where('id', [['a', 'b'], ['c', 'd']]); + + $builder->getCompiledSelect(); + } + + /** + * Check if SQL injection is not possible when unexpected values are passed + */ + public function testWhereValueIsArrayOfObject() + { + $this->expectException(Error::class); + $this->expectExceptionMessage('Object of class stdClass could not be converted to string'); + + $builder = $this->db->table('users'); + + $builder->where('id', [(object) ['a' => 'b'], (object) ['c' => 'd']]); + + $builder->getCompiledSelect(); + } + + public function testWhereValueIsNull() + { + $builder = $this->db->table('users'); + + $builder->where('id', null); + + $expectedSQL = 'SELECT * FROM "users" WHERE "id" IS NULL'; + $this->assertSame($expectedSQL, str_replace("\n", ' ', $builder->getCompiledSelect())); + } + + /** + * Check if SQL injection is not possible when unexpected values are passed + */ + public function testWhereValueIsStdClass() + { + $this->expectException(Error::class); + $this->expectExceptionMessage('Object of class stdClass could not be converted to string'); + + $builder = $this->db->table('users'); + + $builder->where('id', (object) ['a' => 'b']); + + $builder->getCompiledSelect(); + } + + /** + * Check if SQL injection is not possible when unexpected values are passed + */ + public function testWhereValueIsDateTime() + { + $this->expectException(Error::class); + $this->expectExceptionMessage('Object of class DateTime could not be converted to string'); + + $builder = $this->db->table('users'); + + $builder->where('id', new DateTime('2022-02-19 12:00')); + + $builder->getCompiledSelect(); + } } diff --git a/tests/system/Database/Live/IncrementTest.php b/tests/system/Database/Live/IncrementTest.php index 0c3ddf600833..104bb1371c51 100644 --- a/tests/system/Database/Live/IncrementTest.php +++ b/tests/system/Database/Live/IncrementTest.php @@ -49,6 +49,20 @@ public function testIncrementWithValue() $this->seeInDatabase('job', ['name' => 'incremental', 'description' => '8']); } + public function testResetStateAfterIncrement() + { + $this->hasInDatabase('job', ['name' => 'account1', 'description' => '10']); + $this->hasInDatabase('job', ['name' => 'account2', 'description' => '10']); + + $builder = $this->db->table('job'); + + $builder->where('name', 'account1')->increment('description'); + $builder->where('name', 'account2')->increment('description'); + + $this->seeInDatabase('job', ['name' => 'account1', 'description' => '11']); + $this->seeInDatabase('job', ['name' => 'account2', 'description' => '11']); + } + public function testDecrement() { $this->hasInDatabase('job', ['name' => 'incremental', 'description' => '6']); @@ -70,4 +84,18 @@ public function testDecrementWithValue() $this->seeInDatabase('job', ['name' => 'incremental', 'description' => '4']); } + + public function testResetStateAfterDecrement() + { + $this->hasInDatabase('job', ['name' => 'account1', 'description' => '10']); + $this->hasInDatabase('job', ['name' => 'account2', 'description' => '10']); + + $builder = $this->db->table('job'); + + $builder->where('name', 'account1')->decrement('description'); + $builder->where('name', 'account2')->decrement('description'); + + $this->seeInDatabase('job', ['name' => 'account1', 'description' => '9']); + $this->seeInDatabase('job', ['name' => 'account2', 'description' => '9']); + } } diff --git a/tests/system/Database/Live/MetadataTest.php b/tests/system/Database/Live/MetadataTest.php index c72329d7bc71..40a16043c76a 100644 --- a/tests/system/Database/Live/MetadataTest.php +++ b/tests/system/Database/Live/MetadataTest.php @@ -11,6 +11,7 @@ namespace CodeIgniter\Database\Live; +use CodeIgniter\Database\Forge; use CodeIgniter\Test\CIUnitTestCase; use CodeIgniter\Test\DatabaseTestTrait; use Config\Database; @@ -25,8 +26,9 @@ final class MetadataTest extends CIUnitTestCase { use DatabaseTestTrait; - protected $refresh = true; - protected $seed = CITestSeeder::class; + private ?Forge $forge = null; + protected $refresh = true; + protected $seed = CITestSeeder::class; /** * Array of expected tables. diff --git a/tests/system/Database/Live/PreparedQueryTest.php b/tests/system/Database/Live/PreparedQueryTest.php index ef71e1500065..9169f2446c8d 100644 --- a/tests/system/Database/Live/PreparedQueryTest.php +++ b/tests/system/Database/Live/PreparedQueryTest.php @@ -32,6 +32,7 @@ final class PreparedQueryTest extends CIUnitTestCase protected function setUp(): void { parent::setUp(); + $this->query = null; } @@ -47,8 +48,9 @@ protected function tearDown(): void public function testPrepareReturnsPreparedQuery() { $this->query = $this->db->prepare(static fn ($db) => $db->table('user')->insert([ - 'name' => 'a', - 'email' => 'b@example.com', + 'name' => 'a', + 'email' => 'b@example.com', + 'country' => 'JP', ])); $this->assertInstanceOf(BasePreparedQuery::class, $this->query); @@ -56,17 +58,17 @@ public function testPrepareReturnsPreparedQuery() $ec = $this->db->escapeChar; $pre = $this->db->DBPrefix; - $placeholders = '?, ?'; + $placeholders = '?, ?, ?'; if ($this->db->DBDriver === 'Postgre') { - $placeholders = '$1, $2'; + $placeholders = '$1, $2, $3'; } if ($this->db->DBDriver === 'SQLSRV') { $database = $this->db->getDatabase(); - $expected = "INSERT INTO {$ec}{$database}{$ec}.{$ec}{$this->db->schema}{$ec}.{$ec}{$pre}user{$ec} ({$ec}name{$ec},{$ec}email{$ec}) VALUES ({$placeholders})"; + $expected = "INSERT INTO {$ec}{$database}{$ec}.{$ec}{$this->db->schema}{$ec}.{$ec}{$pre}user{$ec} ({$ec}name{$ec},{$ec}email{$ec},{$ec}country{$ec}) VALUES ({$placeholders})"; } else { - $expected = "INSERT INTO {$ec}{$pre}user{$ec} ({$ec}name{$ec}, {$ec}email{$ec}) VALUES ({$placeholders})"; + $expected = "INSERT INTO {$ec}{$pre}user{$ec} ({$ec}name{$ec}, {$ec}email{$ec}, {$ec}country{$ec}) VALUES ({$placeholders})"; } $this->assertSame($expected, $this->query->getQueryString()); @@ -105,6 +107,7 @@ public function testExecuteRunsQueryAndReturnsResultObject() $this->query->execute('foo', 'foo@example.com', 'US'); $this->query->execute('bar', 'bar@example.com', 'GB'); + $this->dontSeeInDatabase($this->db->DBPrefix . 'user', ['name' => 'a', 'email' => 'b@example.com']); $this->seeInDatabase($this->db->DBPrefix . 'user', ['name' => 'foo', 'email' => 'foo@example.com']); $this->seeInDatabase($this->db->DBPrefix . 'user', ['name' => 'bar', 'email' => 'bar@example.com']); } diff --git a/tests/system/Debug/ExceptionsTest.php b/tests/system/Debug/ExceptionsTest.php index 8bd4f01e0925..3ef643c831e3 100644 --- a/tests/system/Debug/ExceptionsTest.php +++ b/tests/system/Debug/ExceptionsTest.php @@ -11,6 +11,9 @@ namespace CodeIgniter\Debug; +use CodeIgniter\Database\Exceptions\DatabaseException; +use CodeIgniter\Entity\Exceptions\CastException; +use CodeIgniter\Exceptions\ConfigException; use CodeIgniter\Exceptions\PageNotFoundException; use CodeIgniter\Test\CIUnitTestCase; use CodeIgniter\Test\ReflectionHelper; @@ -57,9 +60,16 @@ public function testDetermineCodes(): void { $determineCodes = $this->getPrivateMethodInvoker($this->exception, 'determineCodes'); - $this->assertSame([500, 9], $determineCodes(new RuntimeException('This.'))); - $this->assertSame([500, 1], $determineCodes(new RuntimeException('That.', 600))); - $this->assertSame([404, 1], $determineCodes(new RuntimeException('There.', 404))); + $this->assertSame([500, EXIT__AUTO_MIN], $determineCodes(new RuntimeException('This.'))); + $this->assertSame([500, EXIT_ERROR], $determineCodes(new RuntimeException('That.', 600))); + $this->assertSame([404, EXIT_ERROR], $determineCodes(new RuntimeException('There.', 404))); + $this->assertSame([167, EXIT_ERROR], $determineCodes(new RuntimeException('This.', 167))); + // @TODO This exit code should be EXIT_CONFIG. + $this->assertSame([500, 12], $determineCodes(new ConfigException('This.'))); + // @TODO This exit code should be EXIT_CONFIG. + $this->assertSame([500, 9], $determineCodes(new CastException('This.'))); + // @TODO This exit code should be EXIT_DATABASE. + $this->assertSame([500, 17], $determineCodes(new DatabaseException('This.'))); } public function testRenderBacktrace(): void diff --git a/tests/system/Email/EmailTest.php b/tests/system/Email/EmailTest.php index e4fc3ec26780..da428519071d 100644 --- a/tests/system/Email/EmailTest.php +++ b/tests/system/Email/EmailTest.php @@ -14,6 +14,7 @@ use CodeIgniter\Events\Events; use CodeIgniter\Test\CIUnitTestCase; use CodeIgniter\Test\Mock\MockEmail; +use ErrorException; /** * @internal @@ -44,9 +45,8 @@ public function autoClearProvider() */ public function testEmailSendWithClearance($autoClear) { - $config = config('Email'); - $config->validate = true; - $email = new MockEmail($config); + $email = $this->createMockEmail(); + $email->setTo('foo@foo.com'); $this->assertTrue($email->send($autoClear)); @@ -58,9 +58,8 @@ public function testEmailSendWithClearance($autoClear) public function testEmailSendStoresArchive() { - $config = config('Email'); - $config->validate = true; - $email = new MockEmail($config); + $email = $this->createMockEmail(); + $email->setTo('foo@foo.com'); $email->setFrom('bar@foo.com'); $email->setSubject('Archive Test'); @@ -75,9 +74,8 @@ public function testEmailSendStoresArchive() public function testAutoClearLeavesArchive() { - $config = config('Email'); - $config->validate = true; - $email = new MockEmail($config); + $email = $this->createMockEmail(); + $email->setTo('foo@foo.com'); $this->assertTrue($email->send(true)); @@ -89,6 +87,7 @@ public function testEmailSendRepeatUpdatesArchive() { $config = config('Email'); $email = new MockEmail($config); + $email->setTo('foo@foo.com'); $email->setFrom('bar@foo.com'); @@ -104,9 +103,8 @@ public function testEmailSendRepeatUpdatesArchive() public function testSuccessDoesTriggerEvent() { - $config = config('Email'); - $config->validate = true; - $email = new MockEmail($config); + $email = $this->createMockEmail(); + $email->setTo('foo@foo.com'); $result = null; @@ -123,9 +121,8 @@ public function testSuccessDoesTriggerEvent() public function testFailureDoesNotTriggerEvent() { - $config = config('Email'); - $config->validate = true; - $email = new MockEmail($config); + $email = $this->createMockEmail(); + $email->setTo('foo@foo.com'); $email->returnValue = false; @@ -139,4 +136,28 @@ public function testFailureDoesNotTriggerEvent() $this->assertNull($result); } + + public function testDestructDoesNotThrowException() + { + $email = $this->getMockBuilder(Email::class) + ->disableOriginalConstructor() + ->onlyMethods(['sendCommand']) + ->getMock(); + $email->expects($this->once())->method('sendCommand') + ->willThrowException(new ErrorException('SMTP Error.')); + + // Force resource to be injected into the property + $SMTPConnect = fopen(__FILE__, 'rb'); + $this->setPrivateProperty($email, 'SMTPConnect', $SMTPConnect); + + $email->__destruct(); + } + + private function createMockEmail(): MockEmail + { + $config = config('Email'); + $config->validate = true; + + return new MockEmail($config); + } } diff --git a/tests/system/Entity/EntityTest.php b/tests/system/Entity/EntityTest.php index d88f509694f7..2838aa02269e 100644 --- a/tests/system/Entity/EntityTest.php +++ b/tests/system/Entity/EntityTest.php @@ -929,6 +929,24 @@ public function testHasChangedNoChange() $this->assertFalse($entity->hasChanged('default')); } + public function testHasChangedMappedNoChange() + { + $entity = $this->getEntity(); + + $entity->createdAt = null; + + $this->assertFalse($entity->hasChanged('createdAt')); + } + + public function testHasChangedMappedChanged() + { + $entity = $this->getEntity(); + + $entity->createdAt = '2022-11-11 11:11:11'; + + $this->assertTrue($entity->hasChanged('createdAt')); + } + public function testHasChangedWholeEntity() { $entity = $this->getEntity(); diff --git a/tests/system/Events/EventsTest.php b/tests/system/Events/EventsTest.php index 77b233f9c1d5..9b69a219b929 100644 --- a/tests/system/Events/EventsTest.php +++ b/tests/system/Events/EventsTest.php @@ -25,7 +25,7 @@ final class EventsTest extends CIUnitTestCase /** * Accessible event manager instance */ - private MockEvents $manager; + private Events $manager; protected function setUp(): void { diff --git a/tests/system/Files/FileCollectionTest.php b/tests/system/Files/FileCollectionTest.php index ced5b38873d2..7936cc2e62da 100644 --- a/tests/system/Files/FileCollectionTest.php +++ b/tests/system/Files/FileCollectionTest.php @@ -178,7 +178,24 @@ public function testAddStringDirectoryRecursive() $this->assertSame($expected, $files->get()); } - public function testAddArray() + public function testAddArrayFiles() + { + $files = new FileCollection(); + + $expected = [ + $this->directory . 'apple.php', + SUPPORTPATH . 'Files/baker/banana.php', + ]; + + $files->add([ + $this->directory . 'apple.php', + SUPPORTPATH . 'Files/baker/banana.php', + ]); + + $this->assertSame($expected, $files->get()); + } + + public function testAddArrayDirectoryAndFile() { $files = new FileCollection(); @@ -190,7 +207,7 @@ public function testAddArray() ]; $files->add([ - SUPPORTPATH . 'Files/able', + SUPPORTPATH . 'Files/able', // directory SUPPORTPATH . 'Files/baker/banana.php', ]); diff --git a/tests/system/HTTP/CURLRequestDoNotShareOptionsTest.php b/tests/system/HTTP/CURLRequestDoNotShareOptionsTest.php index e6e7449d2987..7a79ca3e354c 100644 --- a/tests/system/HTTP/CURLRequestDoNotShareOptionsTest.php +++ b/tests/system/HTTP/CURLRequestDoNotShareOptionsTest.php @@ -25,7 +25,7 @@ */ final class CURLRequestDoNotShareOptionsTest extends CIUnitTestCase { - private MockCURLRequest $request; + private CURLRequest $request; protected function setUp(): void { diff --git a/tests/system/HTTP/CURLRequestTest.php b/tests/system/HTTP/CURLRequestTest.php index 30ba8adcc102..e6d7072c09a0 100644 --- a/tests/system/HTTP/CURLRequestTest.php +++ b/tests/system/HTTP/CURLRequestTest.php @@ -25,7 +25,7 @@ */ final class CURLRequestTest extends CIUnitTestCase { - private MockCURLRequest $request; + private CURLRequest $request; protected function setUp(): void { diff --git a/tests/system/HTTP/ContentSecurityPolicyTest.php b/tests/system/HTTP/ContentSecurityPolicyTest.php index 4b51d9dbc46d..7e41c9a0d4a5 100644 --- a/tests/system/HTTP/ContentSecurityPolicyTest.php +++ b/tests/system/HTTP/ContentSecurityPolicyTest.php @@ -27,6 +27,9 @@ */ final class ContentSecurityPolicyTest extends CIUnitTestCase { + private ?Response $response = null; + private ?ContentSecurityPolicy $csp = null; + // Having this method as setUp() doesn't work - can't find Config\App !? protected function prepare(bool $CSPEnabled = true) { @@ -129,7 +132,7 @@ public function testConnectSrc() $result = $this->work(); $result = $this->getHeaderEmitted('Content-Security-Policy-Report-Only'); - $this->assertStringContainsString('connect-src iffy.com maybe.com;', $result); + $this->assertStringContainsString("connect-src 'self' iffy.com maybe.com;", $result); } /** @@ -162,9 +165,10 @@ public function testFormAction() $result = $this->work(); $result = $this->getHeaderEmitted('Content-Security-Policy-Report-Only'); - $this->assertStringContainsString('form-action surveysrus.com;', $result); + $this->assertStringContainsString("form-action 'self' surveysrus.com;", $result); + $result = $this->getHeaderEmitted('Content-Security-Policy'); - $this->assertStringContainsString("form-action 'self';", $result); + $this->assertStringNotContainsString("form-action 'self';", $result); } /** diff --git a/tests/system/HTTP/Files/FileMovingTest.php b/tests/system/HTTP/Files/FileMovingTest.php index 209e18b2a903..204579dd3da0 100644 --- a/tests/system/HTTP/Files/FileMovingTest.php +++ b/tests/system/HTTP/Files/FileMovingTest.php @@ -14,12 +14,18 @@ use CodeIgniter\HTTP\Exceptions\HTTPException; use CodeIgniter\Test\CIUnitTestCase; use org\bovigo\vfs\vfsStream; +use org\bovigo\vfs\vfsStreamDirectory; /** * @internal */ final class FileMovingTest extends CIUnitTestCase { + private ?vfsStreamDirectory $root; + private string $path; + private string $start; + private string $destination; + protected function setUp(): void { parent::setUp(); diff --git a/tests/system/HTTP/IncomingRequestTest.php b/tests/system/HTTP/IncomingRequestTest.php index 603f493df932..f19f9cf53ee4 100644 --- a/tests/system/HTTP/IncomingRequestTest.php +++ b/tests/system/HTTP/IncomingRequestTest.php @@ -438,8 +438,7 @@ public function testCanGrabGetRawInput() public function testIsCLI() { - // this should be the case in unit testing - $this->assertTrue($this->request->isCLI()); + $this->assertFalse($this->request->isCLI()); } public function testIsAJAX() diff --git a/tests/system/HTTP/RedirectResponseTest.php b/tests/system/HTTP/RedirectResponseTest.php index 9773ab8c7b72..95cd6003f275 100644 --- a/tests/system/HTTP/RedirectResponseTest.php +++ b/tests/system/HTTP/RedirectResponseTest.php @@ -81,9 +81,10 @@ public function testRedirectRoute() $this->assertSame('http://example.com/index.php/exampleRoute', $response->getHeaderLine('Location')); } - public function testRedirectRouteBad() + public function testRedirectRouteBadNamedRoute() { $this->expectException(HTTPException::class); + $this->expectExceptionMessage('The route for "differentRoute" cannot be found.'); $response = new RedirectResponse(new App()); @@ -92,6 +93,18 @@ public function testRedirectRouteBad() $response->route('differentRoute'); } + public function testRedirectRouteBadControllerMethod() + { + $this->expectException(HTTPException::class); + $this->expectExceptionMessage('The route for "Bad::badMethod" cannot be found.'); + + $response = new RedirectResponse(new App()); + + $this->routes->add('exampleRoute', 'Home::index'); + + $response->route('Bad::badMethod'); + } + public function testRedirectRelativeConvertsToFullURI() { $response = new RedirectResponse($this->config); diff --git a/tests/system/Helpers/CookieHelperTest.php b/tests/system/Helpers/CookieHelperTest.php index 640a43cb3551..852b13361f70 100755 --- a/tests/system/Helpers/CookieHelperTest.php +++ b/tests/system/Helpers/CookieHelperTest.php @@ -28,6 +28,7 @@ */ final class CookieHelperTest extends CIUnitTestCase { + private IncomingRequest $request; private $name; private string $value; private int $expire; diff --git a/tests/system/Helpers/FilesystemHelperTest.php b/tests/system/Helpers/FilesystemHelperTest.php index c9f5789a9d4c..00acb804394d 100644 --- a/tests/system/Helpers/FilesystemHelperTest.php +++ b/tests/system/Helpers/FilesystemHelperTest.php @@ -20,6 +20,11 @@ */ final class FilesystemHelperTest extends CIUnitTestCase { + /** + * @var array `` will be replaced with the command to check. +.. note:: Do you need to have the generated code in a subfolder? Let's say if you want to create a controller + class to reside in the ``Admin`` subfolder of the main ``Controllers`` folder, you will just need + to prepend the subfolder to the class name, like this: ``php spark make:controller admin/login``. This + command will create the ``Login`` controller in the ``Controllers/Admin`` subfolder with + a namespace of ``App\Controllers\Admin``. + +.. note:: Working on modules? Code generation will set the root namespace to a default of ``APP_NAMESPACE``. + Should you need to have the generated code elsewhere in your module namespace, make sure to set + the ``--namespace`` option in your command, e.g., ``php spark make:model blog --namespace Acme\Blog``. + +.. warning:: Make sure when setting the ``--namespace`` option that the supplied namespace is a valid + namespace defined in your ``$psr4`` array in ``Config\Autoload`` or defined in your composer autoload + file. Otherwise, code generation will be interrupted. + +.. warning:: Use of ``migrate:create`` to create migration files is now deprecated. It will be removed in + future releases. Please use ``make:migration`` as replacement. Also, please use ``make:migration --session`` + to use instead of the deprecated ``session:migration``. + ******************* Built-in Generators ******************* @@ -94,6 +112,13 @@ Options: * ``--suffix``: Append the component suffix to the generated class name. * ``--force``: Set this flag to overwrite existing files on destination. +.. note:: If you use ``--suffix``, the generated controller name will be like + ``ProductController``. That violates the Controller naming convention + when using :ref:`Auto Routing ` + (Controller class names MUST start with an uppercase letter and + ONLY the first character can be uppercase). So ``--suffix`` can be used + when you use :ref:`Defined Routes `. + make:entity ----------- @@ -226,24 +251,6 @@ Options: * ``--suffix``: Append the component suffix to the generated class name. * ``--force``: Set this flag to overwrite existing files on destination. -.. note:: Do you need to have the generated code in a subfolder? Let's say if you want to create a controller - class to reside in the ``Admin`` subfolder of the main ``Controllers`` folder, you will just need - to prepend the subfolder to the class name, like this: ``php spark make:controller admin/login``. This - command will create the ``Login`` controller in the ``Controllers/Admin`` subfolder with - a namespace of ``App\Controllers\Admin``. - -.. note:: Working on modules? Code generation will set the root namespace to a default of ``APP_NAMESPACE``. - Should you need to have the generated code elsewhere in your module namespace, make sure to set - the ``--namespace`` option in your command, e.g., ``php spark make:model blog --namespace Acme\Blog``. - -.. warning:: Make sure when setting the ``--namespace`` option that the supplied namespace is a valid - namespace defined in your ``$psr4`` array in ``Config\Autoload`` or defined in your composer autoload - file. Otherwise, code generation will be interrupted. - -.. warning:: Use of ``migrate:create`` to create migration files is now deprecated. It will be removed in - future releases. Please use ``make:migration`` as replacement. Also, please use ``make:migration --session`` - to use instead of the deprecated ``session:migration``. - **************************************** Scaffolding a Complete Set of Stock Code **************************************** diff --git a/user_guide_src/source/concepts/autoloader.rst b/user_guide_src/source/concepts/autoloader.rst index db60dce9a427..ee2dc5a8a3d8 100644 --- a/user_guide_src/source/concepts/autoloader.rst +++ b/user_guide_src/source/concepts/autoloader.rst @@ -47,6 +47,10 @@ The key of each row is the namespace itself. This does not need a trailing back The value is the location to the directory the classes can be found in. They should have a trailing slash. +.. note:: You can check the namespace configuration by ``spark namespaces`` command:: + + > php spark namespaces + By default, the application folder is namespace to the ``App`` namespace. While you are not forced to namespace the controllers, libraries, or models in the application directory, if you do, they will be found under the ``App`` namespace. You may change this namespace by editing the **app/Config/Constants.php** file and setting the diff --git a/user_guide_src/source/conf.py b/user_guide_src/source/conf.py index 79d03fee730f..35d868a4ff49 100644 --- a/user_guide_src/source/conf.py +++ b/user_guide_src/source/conf.py @@ -24,7 +24,7 @@ version = '4.2' # The full version, including alpha/beta/rc tags. -release = '4.2.1' +release = '4.2.2' # -- General configuration --------------------------------------------------- diff --git a/user_guide_src/source/database/metadata.rst b/user_guide_src/source/database/metadata.rst index 5ba9453672a3..458f70004102 100644 --- a/user_guide_src/source/database/metadata.rst +++ b/user_guide_src/source/database/metadata.rst @@ -121,7 +121,8 @@ The key types may be unique to the database you are using. For instance, MySQL will return one of primary, fulltext, spatial, index or unique for each key associated with a table. -**$db->getForeignKeyData()** +$db->getForeignKeyData() +------------------------ Returns an array of objects containing foreign key information. diff --git a/user_guide_src/source/database/metadata/001.php b/user_guide_src/source/database/metadata/001.php index a4d50427b93a..195b3882135d 100644 --- a/user_guide_src/source/database/metadata/001.php +++ b/user_guide_src/source/database/metadata/001.php @@ -1,5 +1,7 @@ listTables(); foreach ($tables as $table) { diff --git a/user_guide_src/source/database/metadata/002.php b/user_guide_src/source/database/metadata/002.php index 5198eaff081b..5385acb407db 100644 --- a/user_guide_src/source/database/metadata/002.php +++ b/user_guide_src/source/database/metadata/002.php @@ -1,5 +1,7 @@ tableExists('table_name')) { // some code... } diff --git a/user_guide_src/source/database/metadata/003.php b/user_guide_src/source/database/metadata/003.php index 64e708bbeda7..0450be53058c 100644 --- a/user_guide_src/source/database/metadata/003.php +++ b/user_guide_src/source/database/metadata/003.php @@ -1,5 +1,7 @@ getFieldNames('table_name'); foreach ($fields as $field) { diff --git a/user_guide_src/source/database/metadata/004.php b/user_guide_src/source/database/metadata/004.php index a9d866b42d06..317e8fc3dad4 100644 --- a/user_guide_src/source/database/metadata/004.php +++ b/user_guide_src/source/database/metadata/004.php @@ -1,5 +1,7 @@ query('SELECT * FROM some_table'); foreach ($query->getFieldNames() as $field) { diff --git a/user_guide_src/source/database/metadata/005.php b/user_guide_src/source/database/metadata/005.php index 14d6b49b4fe6..fdb7e9eb1c32 100644 --- a/user_guide_src/source/database/metadata/005.php +++ b/user_guide_src/source/database/metadata/005.php @@ -1,5 +1,7 @@ fieldExists('field_name', 'table_name')) { // some code... } diff --git a/user_guide_src/source/database/metadata/006.php b/user_guide_src/source/database/metadata/006.php index c7a05c9d152b..3f57499ec4ef 100644 --- a/user_guide_src/source/database/metadata/006.php +++ b/user_guide_src/source/database/metadata/006.php @@ -1,5 +1,7 @@ getFieldData('table_name'); foreach ($fields as $field) { diff --git a/user_guide_src/source/database/metadata/007.php b/user_guide_src/source/database/metadata/007.php index 2c68fc14b5f4..d0ec9021bc9a 100644 --- a/user_guide_src/source/database/metadata/007.php +++ b/user_guide_src/source/database/metadata/007.php @@ -1,4 +1,6 @@ query('YOUR QUERY'); -$fields = $query->fieldData(); +$fields = $query->getFieldData(); diff --git a/user_guide_src/source/database/metadata/008.php b/user_guide_src/source/database/metadata/008.php index 7014fb11fe1a..5b3e158149bf 100644 --- a/user_guide_src/source/database/metadata/008.php +++ b/user_guide_src/source/database/metadata/008.php @@ -1,5 +1,7 @@ getIndexData('table_name'); foreach ($keys as $key) { diff --git a/user_guide_src/source/database/metadata/009.php b/user_guide_src/source/database/metadata/009.php index c46169afab22..c4878c5186b2 100644 --- a/user_guide_src/source/database/metadata/009.php +++ b/user_guide_src/source/database/metadata/009.php @@ -1,5 +1,7 @@ getForeignKeyData('table_name'); foreach ($keys as $key) { diff --git a/user_guide_src/source/database/query_builder.rst b/user_guide_src/source/database/query_builder.rst index eca7b2bd2cf0..74801f73035b 100755 --- a/user_guide_src/source/database/query_builder.rst +++ b/user_guide_src/source/database/query_builder.rst @@ -78,10 +78,8 @@ will be reset (by default it will be reset, just like when using ``$builder->get .. literalinclude:: query_builder/006.php The key thing to notice in the above example is that the second query did not -utilize ``$builder->from()`` and did not pass a table name into the first -parameter. The reason for this outcome is because the query has not been -executed using ``$builder->get()`` which resets values or reset directly -using ``$builder->resetQuery()``. +utilize ``limit(10, 20)`` but the generated SQL query has ``LIMIT 20, 10``. +The reason for this outcome is because the first parameter is set to ``false``. $builder->getWhere() -------------------- @@ -829,9 +827,7 @@ will be reset (by default it will be--just like ``$builder->insert()``): .. literalinclude:: query_builder/080.php -The reason the second query worked is that the query has not been executed -using ``$builder->insert()`` which resets values or reset directly using -``$builder->resetQuery()``. +The reason the second query worked is that the first parameter is set to ``false``. .. note:: This method doesn't work for batch inserts. diff --git a/user_guide_src/source/dbmgmt/forge.rst b/user_guide_src/source/dbmgmt/forge.rst index 804a0e6ac9d1..2fb13c72d3e1 100644 --- a/user_guide_src/source/dbmgmt/forge.rst +++ b/user_guide_src/source/dbmgmt/forge.rst @@ -191,8 +191,7 @@ with .. literalinclude:: forge/014.php -An optional second parameter set to true adds an ``IF NOT EXISTS`` clause -into the definition +An optional second parameter set to true will create the table only if it doesn't already exist. .. literalinclude:: forge/015.php diff --git a/user_guide_src/source/dbmgmt/forge/015.php b/user_guide_src/source/dbmgmt/forge/015.php index ad478406a903..ec116bf6d00d 100644 --- a/user_guide_src/source/dbmgmt/forge/015.php +++ b/user_guide_src/source/dbmgmt/forge/015.php @@ -1,4 +1,4 @@ createTable('table_name', true); -// gives CREATE TABLE IF NOT EXISTS table_name +// creates table only if table does not exist diff --git a/user_guide_src/source/dbmgmt/migration.rst b/user_guide_src/source/dbmgmt/migration.rst index 5fc93f79aa6f..71148ad98bff 100644 --- a/user_guide_src/source/dbmgmt/migration.rst +++ b/user_guide_src/source/dbmgmt/migration.rst @@ -108,11 +108,13 @@ to update the schema: ******************* Command-Line Tools ******************* -CodeIgniter ships with several :doc:`commands ` that are available from the command line to help + +CodeIgniter ships with several :doc:`commands ` that are available from the command line to help you work with migrations. These tools are not required to use migrations but might make things easier for those of you that wish to use them. The tools primarily provide access to the same methods that are available within the MigrationRunner class. -**migrate** +migrate +======= Migrates a database group with all available migrations:: @@ -132,7 +134,8 @@ When using the ``--all`` option, it will scan through all namespaces attempting not been run. These will all be collected and then sorted as a group by date created. This should help to minimize any potential conflicts between the main application and any modules. -**rollback** +rollback +======== Rolls back all migrations, taking the database group to a blank slate, effectively migration 0:: @@ -144,7 +147,8 @@ You can use (rollback) with the following options: - ``-b`` - to choose a batch: natural numbers specify the batch, negatives indicate a relative batch - ``-f`` - to force a bypass confirmation question, it is only asked in a production environment -**refresh** +refresh +======= Refreshes the database state by first rolling back all migrations, and then migrating all:: @@ -157,7 +161,8 @@ You can use (refresh) with the following options: - ``--all`` - to refresh all namespaces - ``-f`` - to force a bypass confirmation question, it is only asked in a production environment -**status** +status +====== Displays a list of all migrations and the date and time they ran, or '--' if they have not been run:: @@ -174,7 +179,8 @@ You can use (status) with the following options: - ``-g`` - to choose database group, otherwise default database group will be used. -**make:migration** +make:migration +============== Creates a skeleton migration file in **app/Database/Migrations**. It automatically prepends the current timestamp. The class name it diff --git a/user_guide_src/source/extending/basecontroller/003.php b/user_guide_src/source/extending/basecontroller/003.php index 5c9fcf1fc255..2f6fcb9d08cb 100644 --- a/user_guide_src/source/extending/basecontroller/003.php +++ b/user_guide_src/source/extending/basecontroller/003.php @@ -8,6 +8,11 @@ abstract class BaseController extends Controller { // ... + /** + * @var \CodeIgniter\Session\Session; + */ + protected $session; + public function initController(/* ... */) { // Do Not Edit This Line diff --git a/user_guide_src/source/extending/core_classes.rst b/user_guide_src/source/extending/core_classes.rst index 8f923a2e14bd..efb42c53034e 100644 --- a/user_guide_src/source/extending/core_classes.rst +++ b/user_guide_src/source/extending/core_classes.rst @@ -9,7 +9,7 @@ the core versions. **Most users will never have any need to do this, but the option to replace or extend them does exist for those who would like to significantly alter the CodeIgniter core.** -.. note:: Messing with a core system class has a lot of implications, so make sure you know what you are doing before +.. important:: Messing with a core system class has a lot of implications, so make sure you know what you are doing before attempting it. .. contents:: @@ -47,15 +47,23 @@ The following is a list of the core system classes that are invoked every time C Replacing Core Classes ====================== -To use one of your own system classes instead of a default one, ensure that the :doc:`Autoloader <../concepts/autoloader>` -can find your class, that your new class implements the appropriate interface, and modify the appropriate -:doc:`Service <../concepts/services>` to load your class in place of the core class. +To use one of your own system classes instead of a default one, ensure: + + 1. the :doc:`Autoloader <../concepts/autoloader>` can find your class, + 2. your new class implements the appropriate interface, + 3. and modify the appropriate :doc:`Service <../concepts/services>` to load your class in place of the core class. + +Creating Your Class +------------------- For example, if you have a new ``App\Libraries\RouteCollection`` class that you would like to use in place of the core system class, you would create your class like this: .. literalinclude:: core_classes/001.php +Adding the Service +------------------ + Then you would add the ``routes`` service in **app/Config/Services.php** to load your class instead: .. literalinclude:: core_classes/002.php @@ -65,7 +73,7 @@ Extending Core Classes If all you need to is add some functionality to an existing library - perhaps add a method or two - then it's overkill to recreate the entire library. In this case, it's better to simply extend the class. Extending the class is nearly -identical to replacing a class with one exception: +identical to `Replacing Core Classes`_ with one exception: * The class declaration must extend the parent class. diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst index 4b8ef4e92cc2..ed6a88a7e6bb 100755 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -65,7 +65,7 @@ Service Accessors values that are specific to the environment itself, like database settings, API keys, etc. -.. php:function:: esc($data[, $context = 'html' [, $encoding]]) +.. php:function:: esc($data[, $context = 'html'[, $encoding]]) :param string|array $data: The information to be escaped. :param string $context: The escaping context. Default is 'html'. @@ -89,7 +89,7 @@ Service Accessors For full details, see the :doc:`helpers` page. -.. php:function:: lang($line[, $args[, $locale ]]) +.. php:function:: lang($line[, $args[, $locale]]) :param string $line: The line of text to retrieve :param array $args: An array of data to substitute for placeholders. @@ -99,7 +99,7 @@ Service Accessors For more information, see the :doc:`Localization ` page. -.. php:function:: model($name [, $getShared = true [, &$conn = null ]]) +.. php:function:: model($name[, $getShared = true[, &$conn = null]]) :param string $name: :param boolean $getShared: @@ -107,7 +107,7 @@ Service Accessors :returns: More simple way of getting model instances :rtype: mixed -.. php:function:: old( $key[, $default = null, [, $escape = 'html' ]] ) +.. php:function:: old($key[, $default = null,[, $escape = 'html']]) :param string $key: The name of the old form data to check for. :param mixed $default: The default value to return if $key doesn't exist. @@ -124,7 +124,7 @@ Service Accessors .. note:: If you are using the :doc:`form helper `, this feature is built-in. You only need to use this function when not using the form helper. -.. php:function:: session( [$key] ) +.. php:function:: session([$key]) :param string $key: The name of the session item to check for. :returns: An instance of the Session object if no $key, the value found in the session for $key, or null. @@ -133,7 +133,7 @@ Service Accessors Provides a convenient way to access the session class and to retrieve a stored value. For more information, see the :doc:`Sessions ` page. -.. php:function:: timer( [$name] ) +.. php:function:: timer([$name]) :param string $name: The name of the benchmark point. :returns: The Timer instance @@ -147,7 +147,7 @@ Service Accessors .. literalinclude:: common_functions/003.php -.. php:function:: view ($name [, $data [, $options ]]) +.. php:function:: view($name[, $data[, $options]]) :param string $name: The name of the file to load :param array $data: An array of key/value pairs to make available within the view. @@ -175,7 +175,7 @@ Service Accessors For more details, see the :doc:`Views ` page. -.. php:function:: view_cell ( $library [, $params = null [, $ttl = 0 [, $cacheName = null]]] ) +.. php:function:: view_cell($library[, $params = null[, $ttl = 0[, $cacheName = null]]]) :param string $library: :param null $params: @@ -189,14 +189,14 @@ Service Accessors Miscellaneous Functions ======================= -.. php:function:: app_timezone () +.. php:function:: app_timezone() :returns: The timezone the application has been set to display dates in. :rtype: string Returns the timezone the application has been set to display dates in. -.. php:function:: csp_script_nonce () +.. php:function:: csp_script_nonce() :returns: The CSP nonce attribute for script tag. :rtype: string @@ -204,7 +204,7 @@ Miscellaneous Functions Returns the nonce attribute for a script tag. For example: ``nonce="Eskdikejidojdk978Ad8jf"``. See :ref:`content-security-policy`. -.. php:function:: csp_style_nonce () +.. php:function:: csp_style_nonce() :returns: The CSP nonce attribute for style tag. :rtype: string @@ -212,28 +212,28 @@ Miscellaneous Functions Returns the nonce attribute for a style tag. For example: ``nonce="Eskdikejidojdk978Ad8jf"``. See :ref:`content-security-policy`. -.. php:function:: csrf_token () +.. php:function:: csrf_token() :returns: The name of the current CSRF token. :rtype: string Returns the name of the current CSRF token. -.. php:function:: csrf_header () +.. php:function:: csrf_header() :returns: The name of the header for current CSRF token. :rtype: string The name of the header for current CSRF token. -.. php:function:: csrf_hash () +.. php:function:: csrf_hash() :returns: The current value of the CSRF hash. :rtype: string Returns the current CSRF hash value. -.. php:function:: csrf_field () +.. php:function:: csrf_field() :returns: A string with the HTML for hidden input with all required CSRF information. :rtype: string @@ -242,7 +242,7 @@ Miscellaneous Functions -.. php:function:: csrf_meta () +.. php:function:: csrf_meta() :returns: A string with the HTML for meta tag with all required CSRF information. :rtype: string @@ -251,7 +251,7 @@ Miscellaneous Functions -.. php:function:: force_https ( $duration = 31536000 [, $request = null [, $response = null]] ) +.. php:function:: force_https($duration = 31536000[, $request = null[, $response = null]]) :param int $duration: The number of seconds browsers should convert links to this resource to HTTPS. :param RequestInterface $request: An instance of the current Request object. @@ -262,24 +262,24 @@ Miscellaneous Functions but through HTTPS. Will set the HTTP Strict Transport Security header, which instructs modern browsers to automatically modify any HTTP requests to HTTPS requests for the $duration. -.. php:function:: function_usable ( $function_name ) +.. php:function:: function_usable($function_name) :param string $function_name: Function to check for :returns: true if the function exists and is safe to call, false otherwise. :rtype: bool -.. php:function:: is_cli () +.. php:function:: is_cli() :returns: true if the script is being executed from the command line or false otherwise. :rtype: bool -.. php:function:: is_really_writable ( $file ) +.. php:function:: is_really_writable($file) :param string $file: The filename being checked. :returns: true if you can write to the file, false otherwise. :rtype: bool -.. php:function:: log_message ($level, $message [, $context]) +.. php:function:: log_message($level, $message [, $context]) :param string $level: The level of severity :param string $message: The message that is to be logged. @@ -295,9 +295,15 @@ Miscellaneous Functions Context can be used to substitute values in the message string. For full details, see the :doc:`Logging Information ` page. -.. php:function:: redirect( string $route ) +.. php:function:: redirect(string $route) :param string $route: The reverse-routed or named route to redirect the user to. + :rtype: RedirectResponse + + .. important:: When you use this function, an instance of ``RedirectResponse`` must be returned + in the method of the :doc:`Controller <../incoming/controllers>` or + the :doc:`Controller Filter <../incoming/filters>`. If you forget to return it, + no redirection will occur. Returns a RedirectResponse instance allowing you to easily create redirects: @@ -326,19 +332,25 @@ Miscellaneous Functions .. literalinclude:: common_functions/007.php -.. php:function:: route_to ( $method [, ...$params] ) +.. php:function:: route_to($method[, ...$params]) :param string $method: The named route alias, or name of the controller/method to match. - :param mixed $params: One or more parameters to be passed to be matched in the route. + :param int|string $params: One or more parameters to be passed to be matched in the route. .. note:: This function requires the controller/method to have a route defined in **app/Config/routes.php**. - Generates a URI relative to the domain name (not **baseUrl**) for you based on either a named route alias, + Generates a route for you based on either a named route alias, or a controller::method combination. Will take parameters into effect, if provided. - For full details, see the :doc:`/incoming/routing` page. + .. literalinclude:: common_functions/009.php + + .. literalinclude:: common_functions/010.php + + .. note:: ``route_to()`` returns a route, not a full URI path for your site. + If your **baseURL** contains sub folders, the return value is not the same + as the URI to link. In that case, just use :php:func:`url_to` instead. -.. php:function:: service ( $name [, ...$params] ) +.. php:function:: service($name[, ...$params]) :param string $name: The name of the service to load :param mixed $params: One or more parameters to pass to the service method. @@ -353,7 +365,7 @@ Miscellaneous Functions .. literalinclude:: common_functions/008.php -.. php:function:: single_service ( $name [, ...$params] ) +.. php:function:: single_service($name [, ...$params]) :param string $name: The name of the service to load :param mixed $params: One or more parameters to pass to the service method. @@ -372,7 +384,7 @@ Miscellaneous Functions Fetch a config file item with slash appended (if not empty) -.. php:function:: stringify_attributes ( $attributes [, $js] ) +.. php:function:: stringify_attributes($attributes [, $js]) :param mixed $attributes: string, array of key value pairs, or object :param boolean $js: true if values do not need quotes (Javascript-style) diff --git a/user_guide_src/source/general/common_functions/009.php b/user_guide_src/source/general/common_functions/009.php new file mode 100644 index 000000000000..41c725478d3f --- /dev/null +++ b/user_guide_src/source/general/common_functions/009.php @@ -0,0 +1,12 @@ +get('users/(:num)/gallery(:any)', 'Galleries::showUserGallery/$1/$2'); + +?> + +get('users/(:num)/gallery(:any)', 'Galleries::showUserGallery/$1/$2', ['as' => 'user_gallery']); + +?> + + 45, - 'actual' => 72, ]; } } diff --git a/user_guide_src/source/general/environments.rst b/user_guide_src/source/general/environments.rst index 49ec2d6ed788..bac1f4c394cb 100644 --- a/user_guide_src/source/general/environments.rst +++ b/user_guide_src/source/general/environments.rst @@ -13,17 +13,23 @@ tools loaded that you don't in production environments, etc. :local: :depth: 2 +.. _environment-constant: + The ENVIRONMENT Constant ======================== -By default, CodeIgniter comes with the environment constant set to use +By default, CodeIgniter comes with the ``ENVIRONMENT`` constant set to use the value provided in ``$_SERVER['CI_ENVIRONMENT']``, otherwise defaulting to -'production'. This can be set in several ways depending on your server setup. +``production``. This can be set in several ways depending on your server setup. .. note:: The environment ``testing`` is the special one for PHPUnit testing. It has special conditions built into the framework at various places to assist with that. You can't use it for your development. +.. note:: You can check the current environment by ``spark env`` command:: + + > php spark env + .env ---- @@ -33,6 +39,12 @@ The simplest method to set the variable is in your :doc:`.env file php spark env production + +.. _environment-apache: + Apache ------ @@ -43,6 +55,9 @@ config using `SetEnv ` for + information on how to set the status code. + Route processing by priority ============================ diff --git a/user_guide_src/source/incoming/routing/029.php b/user_guide_src/source/incoming/routing/029.php index c1a8d5947cd8..58a0e81e25f3 100644 --- a/user_guide_src/source/incoming/routing/029.php +++ b/user_guide_src/source/incoming/routing/029.php @@ -5,6 +5,6 @@ ?> - -View Gallery - + +View Gallery + diff --git a/user_guide_src/source/incoming/routing/030.php b/user_guide_src/source/incoming/routing/030.php index 1c1c629893e3..b17465e4f88b 100644 --- a/user_guide_src/source/incoming/routing/030.php +++ b/user_guide_src/source/incoming/routing/030.php @@ -5,6 +5,6 @@ ?> - -View Gallery - + +View Gallery + diff --git a/user_guide_src/source/incoming/routing/043.php b/user_guide_src/source/incoming/routing/043.php index 29fc83e59f17..20b82c7d353c 100644 --- a/user_guide_src/source/incoming/routing/043.php +++ b/user_guide_src/source/incoming/routing/043.php @@ -3,7 +3,7 @@ // First you need to enable sorting. $routes->setPrioritize(); -// App\Config\Routes +// Config\Routes $routes->get('(.*)', 'Posts::index', ['priority' => 1]); // Modules\Acme\Config\Routes diff --git a/user_guide_src/source/installation/index.rst b/user_guide_src/source/installation/index.rst index 243dd1a5b314..4807b9a06620 100644 --- a/user_guide_src/source/installation/index.rst +++ b/user_guide_src/source/installation/index.rst @@ -2,9 +2,8 @@ Installation ############ -CodeIgniter4 can be installed in a number of different ways: manually, -using `Composer `, and check Breaking Changes and Enhancements. Pros ----- +==== Download and run Cons ----- +==== You are responsible for merge conflicts when updating Structure ---------- +========= Folders in your project after set up: app, public, system, writable diff --git a/user_guide_src/source/installation/running.rst b/user_guide_src/source/installation/running.rst index 9d53658257c8..4f24edd76950 100644 --- a/user_guide_src/source/installation/running.rst +++ b/user_guide_src/source/installation/running.rst @@ -12,24 +12,31 @@ This section addresses how to use each technique, and explains some of the pros If you're new to CodeIgniter, please read the :doc:`Getting Started ` section of the User Guide to begin learning how to build dynamic PHP applications. Enjoy! -Initial Configuration & Set Up -============================== +.. _initial-configuration: + +Initial Configuration +===================== #. Open the **app/Config/App.php** file with a text editor and - set your base URL. If you need more flexibility, the baseURL may - be set within the **.env** file as ``app.baseURL="http://example.com/"``. + set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may + be set within the **.env** file as ``app.baseURL = 'http://example.com/'``. (Always use a trailing slash on your base URL!) + + .. note:: If you don't set the ``baseURL`` correctly, in development mode, + the debug toolbar may not load properly and web pages may take considerably + longer to display. + #. If you intend to use a database, open the **app/Config/Database.php** file with a text editor and set your database settings. Alternately, these could be set in your **.env** file. +#. If it is not on the production server, set ``CI_ENVIRONMENT`` to ``development`` + in **.env** file to take advantage of the debugging tools provided. See + :ref:`setting-development-mode` for the detail. -One additional measure to take in production environments is to disable -PHP error reporting and any other development-only functionality. In -CodeIgniter, this can be done by setting the ``ENVIRONMENT`` constant, which -is more fully described on the :doc:`environments page `. -By default, the application will run using the "production" environment. To -take advantage of the debugging tools provided, you should set the environment -to "development". + .. important:: In production environments, you should disable error display and + any other development-only functionality. In CodeIgniter, this can be done + by setting the environment to "production". By default, the application will + run using the "production" environment. See also :ref:`environment-constant`. .. note:: If you will be running your site using a web server (e.g., Apache or Nginx), you will need to modify the permissions for the ``writable`` folder inside @@ -99,6 +106,11 @@ in the "AllowOverride" setting:: Require all granted +Removing the index.php +---------------------- + +See :ref:`CodeIgniter URLs `. + Virtual Hosting --------------- @@ -195,6 +207,11 @@ Be sure to specify options and permissions for the CodeIgniter public directory +Setting Environment +------------------- + +See :ref:`Handling Multiple Environments `. + Testing ------- @@ -204,9 +221,13 @@ Apache needs to be restarted whenever you change its configuration. Hosting with Nginx ================== + Nginx is the second most widely used HTTP server for web hosting. Here you can find an example configuration using PHP 7.3 FPM (unix sockets) under Ubuntu Server. +default.conf +------------ + This configuration enables URLs without "index.php" in them and using CodeIgniter's "404 - File Not Found" for URLs ending with ".php". .. code-block:: nginx @@ -241,39 +262,10 @@ This configuration enables URLs without "index.php" in them and using CodeIgnite } } -Hosting with Vagrant -==================== - -Virtualization is an effective way to test your webapp in the environment you -plan to deploy on, even if you develop on a different one. -Even if you are using the same platform for both, virtualization provides an -isolated environment for testing. - -The codebase comes with a ``VagrantFile.dist``, that can be copied to ``VagrantFile`` -and tailored for your system, for instance enabling access to specific database or caching engines. - -Setting Up ----------- - -It assumes that you have installed `VirtualBox `. Bootstrapping the App ===================== diff --git a/user_guide_src/source/installation/troubleshooting.rst b/user_guide_src/source/installation/troubleshooting.rst index 071f4cf9d5ce..992c6969ef94 100644 --- a/user_guide_src/source/installation/troubleshooting.rst +++ b/user_guide_src/source/installation/troubleshooting.rst @@ -4,6 +4,10 @@ Troubleshooting Here are some common installation problems, and suggested workarounds. +.. contents:: + :local: + :depth: 2 + How do I know if my install is working? --------------------------------------- @@ -64,10 +68,11 @@ That is a sign that you are in production mode and have hit an unrecoverable error, which we don't want to show to the viewer of the webapp, for better security. -You can see the error in the debug toolbar display by setting your environment to -"development" (in **.env**), and reloading the page. +You can see the error in the log file. See `CodeIgniter Error Logs`_ below. -Don't forget to reset the environment to "production" once you fix the problem! +If you reach this page while developing you should change your environment to +"development" (in **.env**). See :ref:`setting-development-mode` for more details. +After that, reload the page. You will see the error and the back trace. CodeIgniter Error Logs ---------------------- diff --git a/user_guide_src/source/installation/upgrade_422.rst b/user_guide_src/source/installation/upgrade_422.rst new file mode 100644 index 000000000000..f42eea08d17e --- /dev/null +++ b/user_guide_src/source/installation/upgrade_422.rst @@ -0,0 +1,70 @@ +############################# +Upgrading from 4.2.1 to 4.2.2 +############################# + +Please refer to the upgrade instructions corresponding to your installation method. + +- :ref:`Composer Installation App Starter Upgrading ` +- :ref:`Composer Installation Adding CodeIgniter4 to an Existing Project Upgrading ` +- :ref:`Manual Installation Upgrading ` + +.. contents:: + :local: + :depth: 2 + +Mandatory File Changes +********************** + + +Breaking Changes +**************** + +Web Page Caching Bug Fix +======================== + +- :doc:`../general/caching` now caches the Response data after :ref:`after-filters` are executed. +- For example, if you enable :ref:`secureheaders`, the Response headers are now sent when the page comes from the cache. + +.. important:: If you have written **code based on this bug** that assumes changes to the Response in "after" filters are not cached then **sensitive information could be cached and compromised**. If this is the case, change your code to disable caching of the page. + +Others +====== + +- The method ``Forge::createTable()`` no longer executes a ``CREATE TABLE IF NOT EXISTS``. If table is not found in ``$db->tableExists($table)`` then ``CREATE TABLE`` is executed. +- The second parameter ``$ifNotExists`` of ``Forge::_createTable()`` is deprecated. It is no longer used and will be removed in a future release. +- When you use :php:func:`random_string` with the first parameter ``'crypto'``, now if you set the second parameter ``$len`` to an odd number, ``InvalidArgumentException`` will be thrown. Change the parameter to an even number. + +Breaking Enhancements +********************* + + +Project Files +************* + +Numerous files in the **project space** (root, app, public, writable) received updates. Due to +these files being outside of the **system** scope they will not be changed without your intervention. +There are some third-party CodeIgniter modules available to assist with merging changes to +the project space: `Explore on Packagist Username
- +Username
+ -Password
- +Password
+ -Password Confirm
- +Password Confirm
+ -Email Address
- +Email Address
+ - + - + @@ -97,7 +97,7 @@ code and save it to your **app/Views/** folder:: The Success Page ================ -Using a text editor, create a form called **Success.php**. In it, place +Using a text editor, create a form called **success.php**. In it, place this code and save it to your **app/Views/** folder:: @@ -121,6 +121,14 @@ this code and save it to your **app/Controllers/** folder: .. literalinclude:: validation/001.php +The Routes +========== + +Then add routes for the controller in **app/Config/Routes.php**: + +.. literalinclude:: validation/039.php + :lines: 2- + Try it! ======= @@ -142,11 +150,15 @@ the **Validation class** inside. See :ref:`controllers-validating-data`. Explanation =========== -You'll notice several things about the above pages: +You'll notice several things about the above pages. -The form (**Signup.php**) is a standard web form with a couple of exceptions: +signup.php +---------- -#. It uses a :doc:`form helper ` to create the form opening. Technically, this +The form (**signup.php**) is a standard web form with a couple of exceptions: + +#. It uses a :doc:`form helper ` to create the form opening + and closing. Technically, this isn't necessary. You could create the form using standard HTML. However, the benefit of using the helper is that it generates the action URL for you, based on the URL in your config file. This makes @@ -159,9 +171,15 @@ The form (**Signup.php**) is a standard web form with a couple of exceptions: This function will return any error messages sent back by the validator. If there are no messages it returns an empty string. -The controller (**Form.php**) has one method: ``index()``. This method -uses the Controller-provided ``validate()`` method and loads the form helper and URL -helper used by your view files. It also runs the validation routine. +Form.php +-------- + +The controller (**Form.php**) has one property: ``$helpers``. +It loads the form helper used by your view files. + +The controller has one method: ``index()``. This method returns +the **signup** view to show the form when a non-POST request comes. Otherwise, it +uses the Controller-provided ``validate()`` method. It also runs the validation routine. Based on whether the validation was successful it either presents the form or the success page. @@ -171,6 +189,7 @@ Add Validation Rules Then add validation rules in the controller (**Form.php**): .. literalinclude:: validation/002.php + :lines: 2- If you submit the form you should see the success page or the form with error messages. diff --git a/user_guide_src/source/libraries/validation/001.php b/user_guide_src/source/libraries/validation/001.php index 41d51f1b8a25..b5e8a6f13812 100644 --- a/user_guide_src/source/libraries/validation/001.php +++ b/user_guide_src/source/libraries/validation/001.php @@ -2,20 +2,28 @@ namespace App\Controllers; -use CodeIgniter\Controller; +use Config\Services; -class Form extends Controller +class Form extends BaseController { + protected $helpers = ['form']; + public function index() { - helper(['form', 'url']); + if (strtolower($this->request->getMethod()) !== 'post') { + return view('signup', [ + 'validation' => Services::validation(), + ]); + } + + $rules = []; - if (! $this->validate([])) { - return view('Signup', [ + if (! $this->validate($rules)) { + return view('signup', [ 'validation' => $this->validator, ]); } - return view('Success'); + return view('success'); } } diff --git a/user_guide_src/source/libraries/validation/002.php b/user_guide_src/source/libraries/validation/002.php index 30b845e20701..d1eeff19c329 100644 --- a/user_guide_src/source/libraries/validation/002.php +++ b/user_guide_src/source/libraries/validation/002.php @@ -1,10 +1,12 @@ validate([ +// ... + +$rules = [ 'username' => 'required', 'password' => 'required|min_length[10]', 'passconf' => 'required|matches[password]', - 'email' => 'required|valid_email', -])) { - // ... -} + 'email' => 'required|valid_email', +]; + +// ... diff --git a/user_guide_src/source/libraries/validation/006.php b/user_guide_src/source/libraries/validation/006.php index 24a771f70e31..5f7cbf645ab2 100644 --- a/user_guide_src/source/libraries/validation/006.php +++ b/user_guide_src/source/libraries/validation/006.php @@ -4,3 +4,8 @@ 'username' => 'required', 'password' => 'required|min_length[10]', ]); +// or +$validation->setRules([ + 'username' => 'required', + 'password' => ['required', 'min_length[10]'], +]); diff --git a/user_guide_src/source/libraries/validation/007.php b/user_guide_src/source/libraries/validation/007.php index b211d9c1cec5..cb12c5a61a79 100644 --- a/user_guide_src/source/libraries/validation/007.php +++ b/user_guide_src/source/libraries/validation/007.php @@ -4,3 +4,8 @@ 'username' => ['label' => 'Username', 'rules' => 'required'], 'password' => ['label' => 'Password', 'rules' => 'required|min_length[10]'], ]); +// or +$validation->setRules([ + 'username' => ['label' => 'Username', 'rules' => 'required'], + 'password' => ['label' => 'Password', 'rules' => ['required', 'min_length[10]']], +]); diff --git a/user_guide_src/source/libraries/validation/039.php b/user_guide_src/source/libraries/validation/039.php new file mode 100644 index 000000000000..041e8a782240 --- /dev/null +++ b/user_guide_src/source/libraries/validation/039.php @@ -0,0 +1,8 @@ +get('form', 'Form::index'); +$routes->post('form', 'Form::index'); + +// ... diff --git a/user_guide_src/source/models/entities.rst b/user_guide_src/source/models/entities.rst index d2c99c8623b6..55187ae7a0ad 100644 --- a/user_guide_src/source/models/entities.rst +++ b/user_guide_src/source/models/entities.rst @@ -144,9 +144,9 @@ As an example, imagine you have the simplified User Entity that is used througho .. literalinclude:: entities/008.php Your boss comes to you and says that no one uses usernames anymore, so you're switching to just use emails for login. -But they do want to personalize the application a bit, so they want you to change the name field to represent a user's +But they do want to personalize the application a bit, so they want you to change the ``name`` field to represent a user's full name now, not their username like it does currently. To keep things tidy and ensure things continue making sense -in the database you whip up a migration to rename the `name` field to `full_name` for clarity. +in the database you whip up a migration to rename the ``name`` field to ``full_name`` for clarity. Ignoring how contrived this example is, we now have two choices on how to fix the User class. We could modify the class property from ``$name`` to ``$full_name``, but that would require changes throughout the application. Instead, we can @@ -164,6 +164,10 @@ through the original ``$user->full_name``, also, as this is needed for the model to the database. However, ``unset()`` and ``isset()`` only work on the mapped property, ``$user->name``, not on the database column name, ``$user->full_name``. +.. note:: When you use Data Mapping, you must define ``set*()`` and ``get*()`` method + for the database column name. In this example, you must define ``setFullName()`` and + ``getFullName()``. + Mutators ======== diff --git a/user_guide_src/source/models/entities/009.php b/user_guide_src/source/models/entities/009.php index 411961833749..772cb6509d38 100644 --- a/user_guide_src/source/models/entities/009.php +++ b/user_guide_src/source/models/entities/009.php @@ -8,7 +8,7 @@ class User extends Entity { protected $attributes = [ 'id' => null, - 'full_name' => null, // In the $attributes, the key is the column name + 'full_name' => null, // In the $attributes, the key is the db column name 'email' => null, 'password' => null, 'created_at' => null, @@ -16,6 +16,7 @@ class User extends Entity ]; protected $datamap = [ + // property_name => db_column_name 'name' => 'full_name', ]; } diff --git a/user_guide_src/source/models/model.rst b/user_guide_src/source/models/model.rst index f671fc10a709..b88f1761d841 100644 --- a/user_guide_src/source/models/model.rst +++ b/user_guide_src/source/models/model.rst @@ -34,7 +34,7 @@ CodeIgniter does provide a model class that provides a few nice features, includ - automatic database connection - basic CRUD methods - in-model validation -- automatic pagination +- :ref:`automatic pagination` - and more This class provides a solid base from which to build your own models, allowing you to @@ -116,7 +116,7 @@ The Model's CRUD methods will take a step of work away from you and automaticall the resulting data, instead of the Result object. This setting allows you to define the type of data that is returned. Valid values are '**array**' (the default), '**object**', or the **fully qualified name of a class** that can be used with the Result object's ``getCustomResultObject()`` -method. Using the special ``::class`` constant of the class will allow most IDEs to +method. Using the special ``::class`` constant of the class will allow most IDEs to auto-complete the name and allow functions like refactoring to better understand your code. $useSoftDeletes diff --git a/user_guide_src/source/outgoing/response.rst b/user_guide_src/source/outgoing/response.rst index e03106ab6ffe..7a535794dc85 100644 --- a/user_guide_src/source/outgoing/response.rst +++ b/user_guide_src/source/outgoing/response.rst @@ -147,9 +147,9 @@ When enabled, the response object will contain an instance of ``CodeIgniter\HTTP values set in **app/Config/ContentSecurityPolicy.php** are applied to that instance, and if no changes are needed during runtime, then the correctly formatted header is sent and you're all done. -With CSP enabled, two header lines are added to the HTTP response: a Content-Security-Policy header, with +With CSP enabled, two header lines are added to the HTTP response: a **Content-Security-Policy** header, with policies identifying content types or origins that are explicitly allowed for different -contexts, and a Content-Security-Policy-Report-Only header, which identifies content types +contexts, and a **Content-Security-Policy-Report-Only** header, which identifies content types or origins that will be allowed but which will also be reported to the destination of your choice. @@ -161,7 +161,7 @@ call basis, by providing an optional second parameter to the adding method call. Runtime Configuration --------------------- -If your application needs to make changes at run-time, you can access the instance at ``$response->CSP``. The +If your application needs to make changes at run-time, you can access the instance at ``$this->response->CSP`` in your controllers. The class holds a number of methods that map pretty clearly to the appropriate header value that you need to set. Examples are shown below, with different combinations of parameters, though all accept either a directive name or an array of them: diff --git a/user_guide_src/source/outgoing/response/004.php b/user_guide_src/source/outgoing/response/004.php index 0497dea06e58..0ddaf8d93d5e 100644 --- a/user_guide_src/source/outgoing/response/004.php +++ b/user_guide_src/source/outgoing/response/004.php @@ -1,4 +1,4 @@ setHeader('Location', 'http://example.com') +$this->response->setHeader('Location', 'http://example.com') ->setHeader('WWW-Authenticate', 'Negotiate'); diff --git a/user_guide_src/source/outgoing/response/005.php b/user_guide_src/source/outgoing/response/005.php index 39276d3f80f1..1ee29e5d3c05 100644 --- a/user_guide_src/source/outgoing/response/005.php +++ b/user_guide_src/source/outgoing/response/005.php @@ -1,4 +1,4 @@ setHeader('Cache-Control', 'no-cache') +$this->response->setHeader('Cache-Control', 'no-cache') ->appendHeader('Cache-Control', 'must-revalidate'); diff --git a/user_guide_src/source/outgoing/response/006.php b/user_guide_src/source/outgoing/response/006.php index a2fdee1e9ed5..c1c5b5ae4e66 100644 --- a/user_guide_src/source/outgoing/response/006.php +++ b/user_guide_src/source/outgoing/response/006.php @@ -1,3 +1,3 @@ removeHeader('Location'); +$this->response->removeHeader('Location'); diff --git a/user_guide_src/source/outgoing/response/007.php b/user_guide_src/source/outgoing/response/007.php index 9f80218ee669..f36109c28be1 100644 --- a/user_guide_src/source/outgoing/response/007.php +++ b/user_guide_src/source/outgoing/response/007.php @@ -3,4 +3,4 @@ $data = 'Here is some text!'; $name = 'mytext.txt'; -return $response->download($name, $data); +return $this->response->download($name, $data); diff --git a/user_guide_src/source/outgoing/response/008.php b/user_guide_src/source/outgoing/response/008.php index 832d75fc0616..f8c521bcd3f6 100644 --- a/user_guide_src/source/outgoing/response/008.php +++ b/user_guide_src/source/outgoing/response/008.php @@ -1,4 +1,4 @@ download('/path/to/photo.jpg', null); +return $this->response->download('/path/to/photo.jpg', null); diff --git a/user_guide_src/source/outgoing/response/009.php b/user_guide_src/source/outgoing/response/009.php index e75c386647cb..ab01add9bf1b 100644 --- a/user_guide_src/source/outgoing/response/009.php +++ b/user_guide_src/source/outgoing/response/009.php @@ -1,3 +1,3 @@ download('awkwardEncryptedFileName.fakeExt', null)->setFileName('expenses.csv'); +return $this->response->download('awkwardEncryptedFileName.fakeExt', null)->setFileName('expenses.csv'); diff --git a/user_guide_src/source/outgoing/response/012.php b/user_guide_src/source/outgoing/response/012.php index 6d0d84b19143..a9487e9379a0 100644 --- a/user_guide_src/source/outgoing/response/012.php +++ b/user_guide_src/source/outgoing/response/012.php @@ -1,30 +1,30 @@ CSP->reportOnly(false); +$this->response->CSP->reportOnly(false); // specify the origin to use if none provided for a directive -$response->CSP->setDefaultSrc('cdn.example.com'); +$this->response->CSP->setDefaultSrc('cdn.example.com'); // specify the URL that "report-only" reports get sent to -$response->CSP->setReportURI('http://example.com/csp/reports'); +$this->response->CSP->setReportURI('http://example.com/csp/reports'); // specify that HTTP requests be upgraded to HTTPS -$response->CSP->upgradeInsecureRequests(true); +$this->response->CSP->upgradeInsecureRequests(true); // add types or origins to CSP directives // assuming that the default treatment is to block rather than just report -$response->CSP->addBaseURI('example.com', true); // report only -$response->CSP->addChildSrc('https://youtube.com'); // blocked -$response->CSP->addConnectSrc('https://*.facebook.com', false); // blocked -$response->CSP->addFontSrc('fonts.example.com'); -$response->CSP->addFormAction('self'); -$response->CSP->addFrameAncestor('none', true); // report this one -$response->CSP->addImageSrc('cdn.example.com'); -$response->CSP->addMediaSrc('cdn.example.com'); -$response->CSP->addManifestSrc('cdn.example.com'); -$response->CSP->addObjectSrc('cdn.example.com', false); // reject from here -$response->CSP->addPluginType('application/pdf', false); // reject this media type -$response->CSP->addScriptSrc('scripts.example.com', true); // allow but report requests from here -$response->CSP->addStyleSrc('css.example.com'); -$response->CSP->addSandbox(['allow-forms', 'allow-scripts']); +$this->response->CSP->addBaseURI('example.com', true); // report only +$this->response->CSP->addChildSrc('https://youtube.com'); // blocked +$this->response->CSP->addConnectSrc('https://*.facebook.com', false); // blocked +$this->response->CSP->addFontSrc('fonts.example.com'); +$this->response->CSP->addFormAction('self'); +$this->response->CSP->addFrameAncestor('none', true); // report this one +$this->response->CSP->addImageSrc('cdn.example.com'); +$this->response->CSP->addMediaSrc('cdn.example.com'); +$this->response->CSP->addManifestSrc('cdn.example.com'); +$this->response->CSP->addObjectSrc('cdn.example.com', false); // reject from here +$this->response->CSP->addPluginType('application/pdf', false); // reject this media type +$this->response->CSP->addScriptSrc('scripts.example.com', true); // allow but report requests from here +$this->response->CSP->addStyleSrc('css.example.com'); +$this->response->CSP->addSandbox(['allow-forms', 'allow-scripts']); diff --git a/user_guide_src/source/outgoing/response/013.php b/user_guide_src/source/outgoing/response/013.php index 273d72c29a1d..959a7bfcabef 100644 --- a/user_guide_src/source/outgoing/response/013.php +++ b/user_guide_src/source/outgoing/response/013.php @@ -1,6 +1,6 @@ addChildSrc('https://youtube.com'); // allowed -$response->reportOnly(true); -$response->addChildSrc('https://metube.com'); // allowed but reported -$response->addChildSrc('https://ourtube.com', false); // allowed +$this->response->CSP->addChildSrc('https://youtube.com'); // allowed +$this->response->CSP->reportOnly(true); +$this->response->CSP->addChildSrc('https://metube.com'); // allowed but reported +$this->response->CSP->addChildSrc('https://ourtube.com', false); // allowed diff --git a/user_guide_src/source/testing/benchmark.rst b/user_guide_src/source/testing/benchmark.rst index 1e7a5c9607b7..fb92eb19dfec 100644 --- a/user_guide_src/source/testing/benchmark.rst +++ b/user_guide_src/source/testing/benchmark.rst @@ -3,7 +3,7 @@ Benchmarking ############ CodeIgniter provides two separate tools to help you benchmark your code and test different options: -the Timer and the Iterator. The Timer allows you to easily calculate the time between two points in the +the **Timer** and the **Iterator**. The Timer allows you to easily calculate the time between two points in the execution of your script. The Iterator allows you to set up several variations and runs those tests, recording performance and memory statistics to help you decide which version is the best. @@ -14,9 +14,9 @@ sending the output to the user, enabling a very accurate timing of the entire sy :local: :depth: 2 -=============== +*************** Using the Timer -=============== +*************** With the Timer, you can measure the time between two moments in the execution of your application. This makes it simple to measure the performance of different aspects of your application. All measurement is done using @@ -58,14 +58,14 @@ Displaying Execution Time ========================= While the ``getTimers()`` method will give you the raw data for all of the timers in your project, you can retrieve -the duration of a single timer, in seconds, with the `getElapsedTime()` method. The first parameter is the name of +the duration of a single timer, in seconds, with the ``getElapsedTime()`` method. The first parameter is the name of the timer to display. The second is the number of decimal places to display. This defaults to 4: .. literalinclude:: benchmark/006.php -================== +****************** Using the Iterator -================== +****************** The Iterator is a simple tool that is designed to allow you to try out multiple variations on a solution to see the speed differences and different memory usage patterns. You can add any number of "tasks" for it to @@ -76,7 +76,7 @@ Creating Tasks To Run ===================== Tasks are defined within Closures. Any output the task creates will be discarded automatically. They are -added to the Iterator class through the `add()` method. The first parameter is a name you want to refer to +added to the Iterator class through the ``add()`` method. The first parameter is a name you want to refer to this test by. The second parameter is the Closure, itself: .. literalinclude:: benchmark/007.php @@ -90,7 +90,7 @@ to run the tests more times than that, you can pass the number as the first para .. literalinclude:: benchmark/008.php -Once it has run, it will return an HTML table with the results of the test. If you don't want the results -displayed, you can pass in `false` as the second parameter: +Once it has run, it will return an HTML table with the results of the test. +If you don't want the results, you can pass in ``false`` as the second parameter: .. literalinclude:: benchmark/009.php diff --git a/user_guide_src/source/testing/benchmark/007.php b/user_guide_src/source/testing/benchmark/007.php index 13a95ec66e29..00c1b7aa2b8f 100644 --- a/user_guide_src/source/testing/benchmark/007.php +++ b/user_guide_src/source/testing/benchmark/007.php @@ -1,6 +1,6 @@ add('single_concat', static function () { diff --git a/user_guide_src/source/testing/benchmark/008.php b/user_guide_src/source/testing/benchmark/008.php index da0f6a83b5fa..931250447f6c 100644 --- a/user_guide_src/source/testing/benchmark/008.php +++ b/user_guide_src/source/testing/benchmark/008.php @@ -1,4 +1,4 @@ run(3000); +$htmlTable = $iterator->run(3000); diff --git a/user_guide_src/source/testing/benchmark/009.php b/user_guide_src/source/testing/benchmark/009.php index 1f30692559b2..0e966c638e70 100644 --- a/user_guide_src/source/testing/benchmark/009.php +++ b/user_guide_src/source/testing/benchmark/009.php @@ -1,4 +1,4 @@ run(1000, false); diff --git a/user_guide_src/source/testing/controllers/006.php b/user_guide_src/source/testing/controllers/006.php index 0fc7670487de..5e101f1bbfbb 100644 --- a/user_guide_src/source/testing/controllers/006.php +++ b/user_guide_src/source/testing/controllers/006.php @@ -1,6 +1,12 @@ setLocale($locale); $results = $this->withRequest($request) diff --git a/user_guide_src/source/testing/response/012.php b/user_guide_src/source/testing/response/012.php index 671330ac32a4..0af2b74f0662 100644 --- a/user_guide_src/source/testing/response/012.php +++ b/user_guide_src/source/testing/response/012.php @@ -1,3 +1,3 @@ assertSessionMissin('logged_in'); +$result->assertSessionMissing('logged_in'); diff --git a/user_guide_src/source/tutorial/index.rst b/user_guide_src/source/tutorial/index.rst index e940ec849057..83a58aa61c5c 100644 --- a/user_guide_src/source/tutorial/index.rst +++ b/user_guide_src/source/tutorial/index.rst @@ -53,6 +53,9 @@ Enjoy your exploration of the CodeIgniter framework. Getting Up and Running ********************** +Installing CodeIgnier +===================== + You can download a release manually from the site, but for this tutorial we will use the recommended way and install the AppStarter package through Composer. From your command line type the following:: @@ -62,6 +65,11 @@ From your command line type the following:: This creates a new folder, **ci-news**, which contains your application code, with CodeIgniter installed in the vendor folder. +.. _setting-development-mode: + +Setting Development Mode +======================== + By default, CodeIgniter starts up in production mode. This is a safety feature to keep your site a bit more secure in case settings are messed up once it is live. So first let's fix that. Copy or rename the ``env`` file to ``.env``. Open it up. @@ -74,6 +82,9 @@ out. So uncomment the line with ``CI_ENVIRONMENT`` on it, and change ``productio CI_ENVIRONMENT = development +Running Development Server +========================== + With that out of the way it's time to view your application in a browser. You can serve it through any server of your choice, Apache, Nginx, etc, but CodeIgniter comes with a simple command that takes advantage of PHP's built-in server to get diff --git a/user_guide_src/source/tutorial/static_pages.rst b/user_guide_src/source/tutorial/static_pages.rst index 6fde0a671da7..00a384e3a9fb 100644 --- a/user_guide_src/source/tutorial/static_pages.rst +++ b/user_guide_src/source/tutorial/static_pages.rst @@ -183,18 +183,19 @@ controller you made above produces... +---------------------------------+-----------------------------------------------------------------+ | URL | Will show | +=================================+=================================================================+ + | localhost:8080/ | the CodeIgniter "welcome" page. the results from the ``index()``| + | | method in the ``Home`` controller. | + +---------------------------------+-----------------------------------------------------------------+ | localhost:8080/pages | the results from the ``index()`` method inside our ``Pages`` | | | controller, which is to display the CodeIgniter "welcome" page. | +---------------------------------+-----------------------------------------------------------------+ - | localhost:8080/pages/view | the "home" page that you made above, because it is the default | - | | "page" parameter to the ``view()`` method. | - +---------------------------------+-----------------------------------------------------------------+ - | localhost:8080/pages/view/home | show the "home" page that you made above, because we explicitly | - | | asked for it. | + | localhost:8080/home | show the "home" page that you made above, because we explicitly | + | | asked for it. the results from the ``view()`` method inside our | + | | ``Pages`` controller. | +---------------------------------+-----------------------------------------------------------------+ - | localhost:8080/pages/view/about | the "about" page that you made above, because we explicitly | + | localhost:8080/about | the "about" page that you made above, because we explicitly | | | asked for it. | +---------------------------------+-----------------------------------------------------------------+ - | localhost:8080/pages/view/shop | a "404 - File Not Found" error page, because there is no | + | localhost:8080/shop | a "404 - File Not Found" error page, because there is no | | | **app/Views/pages/shop.php**. | +---------------------------------+-----------------------------------------------------------------+ diff --git a/utils/PHPStan/CheckFrameworkExceptionInstantiationViaNamedConstructorRule.php b/utils/PHPStan/CheckFrameworkExceptionInstantiationViaNamedConstructorRule.php index a2cefaddfdd7..5cca5ec8f4d4 100644 --- a/utils/PHPStan/CheckFrameworkExceptionInstantiationViaNamedConstructorRule.php +++ b/utils/PHPStan/CheckFrameworkExceptionInstantiationViaNamedConstructorRule.php @@ -22,9 +22,6 @@ final class CheckFrameworkExceptionInstantiationViaNamedConstructorRule implements Rule { - /** - * @var string - */ private const ERROR_MESSAGE = 'FrameworkException instance creation via new expression is not allowed, use its named constructor instead'; public function getNodeType(): string diff --git a/utils/PHPStan/CheckUseStatementsAfterLicenseRule.php b/utils/PHPStan/CheckUseStatementsAfterLicenseRule.php index 2bcd0e20f9a9..a3ccaf215d6e 100644 --- a/utils/PHPStan/CheckUseStatementsAfterLicenseRule.php +++ b/utils/PHPStan/CheckUseStatementsAfterLicenseRule.php @@ -22,14 +22,7 @@ final class CheckUseStatementsAfterLicenseRule implements Rule { - /** - * @var string - */ - private const ERROR_MESSAGE = 'Use statement must be located after license docblock'; - - /** - * @var string - */ + private const ERROR_MESSAGE = 'Use statement must be located after license docblock'; private const COPYRIGHT_REGEX = '/\* \(c\) CodeIgniter Foundation [^:]+):(?P [0-9]+):(?P .+)$/', $line, $matches); + preg_match('/^(?P[^:]+):(?P \d+):(?P .+)$/', $line, $matches); return [ 'file' => $matches['file'], @@ -44,20 +46,16 @@ "%s\n\n%s\n", CLI::color('Tabs in RST files were detected:', 'light_gray', 'red'), implode("\n", array_map( - static function (string $file, array $parts): string { - return sprintf( - "%s%s\n%s\n", - CLI::color('* in ', 'light_red'), - CLI::color($file, 'yellow'), - implode("\n", array_map(static function (array $line): string { - return sprintf( - '%s | %s', - str_pad($line['line'], 4, ' ', STR_PAD_LEFT), - str_replace("\t", CLI::color('....', 'light_gray', 'red'), $line['code']), - ); - }, $parts)), - ); - }, + static fn (string $file, array $parts): string => sprintf( + "%s%s\n%s\n", + CLI::color('* in ', 'light_red'), + CLI::color($file, 'yellow'), + implode("\n", array_map(static fn (array $line): string => sprintf( + '%s | %s', + str_pad($line['line'], 4, ' ', STR_PAD_LEFT), + str_replace("\t", CLI::color('....', 'light_gray', 'red'), $line['code']), + ), $parts)), + ), array_keys($normalizedRstFilesWithTabs), array_values($normalizedRstFilesWithTabs), )),