refactor: lazily load CSP and Cookie only when needed by Response#10121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulbalandan merged 2 commits into from
Apr 22, 2026
Merged

refactor: lazily load CSP and Cookie only when needed by Response #10121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
faa2c5b
refactor: lazily load CSP and Cookie only when needed by Response
paulbalandan Apr 18, 2026
d0e8a07
address review
paulbalandan Apr 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 6 additions & 18 deletions system/HTTP/Response.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,7 @@
namespace CodeIgniter\HTTP;

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use Config\Cookie as CookieConfig;

/**
* Representation of an outgoing, server-side response.
Expand All@@ -38,7 +36,7 @@ class Response extends Message implements ResponseInterface
/**
* HTTP status codes
*
* @var array
* @var array<int, string>
*/
protected static $statusCodes = [
// 1xx: Informational
Expand DownExpand Up@@ -140,23 +138,14 @@ class Response extends Message implements ResponseInterface
*/
protected $pretend = false;

/**
* Construct a non-caching response with a default content type of `text/html`.
*/
public function __construct()
{
// Default to a non-caching page.
// Also ensures that a Cache-control header exists.
$this->noCache();

// We need CSP object even if not enabled to avoid calls to non existing methods
$this->CSP = service('csp');

$this->cookieStore = new CookieStore([]);

$cookie = config(CookieConfig::class);

Cookie::setDefaults($cookie);
Cookie::setDefaults(config('Cookie'));

// Default to an HTML Content-Type. Devs can override if needed.
$this->setContentType('text/html');
$this->noCache()->setContentType('text/html');
Comment thread
michalsn marked this conversation as resolved.
}

/**
Expand All@@ -168,7 +157,6 @@ public function __construct()
* @return $this
*
* @internal For testing purposes only.
* @testTag only available to test code
*/
public function pretend(bool $pretend = true)
{
Expand Down
98 changes: 82 additions & 16 deletions system/HTTP/ResponseTrait.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Config\Services;
use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\Cookie\Exceptions\CookieException;
Expand All@@ -21,6 +22,8 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\App;
use Config\ContentSecurityPolicy as ContentSecurityPolicyConfig;
use Config\Cookie as CookieConfig;
use DateTime;
use DateTimeZone;
Expand All@@ -31,21 +34,30 @@
* Additional methods to make a PSR-7 Response class
* compliant with the framework's own ResponseInterface.
*
* @property array<int, string> $statusCodes
* @property string|null $body
*
* @see https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php
*/
trait ResponseTrait
{
/**
* Content security policy handler
* Content security policy handler.
*
* Lazily instantiated on first use via `self::getCSP()` so that the
* ContentSecurityPolicy class is not loaded on requests that do not use CSP.
*
* @var ContentSecurityPolicy
* @var ContentSecurityPolicy|null
*/
protected $CSP;

/**
* CookieStore instance.
*
* @var CookieStore
* Lazily instantiated on first cookie-related call so that the Cookie and
* CookieStore classes are not loaded on requests that do not use cookies.
*
* @var CookieStore|null
*/
protected $cookieStore;

Expand DownExpand Up@@ -77,19 +89,17 @@ trait ResponseTrait
*/
public function setStatusCode(int $code, string $reason = '')
{
// Valid range?
if ($code < 100 || $code > 599) {
throw HTTPException::forInvalidStatusCode($code);
}

// Unknown and no message?
if (! array_key_exists($code, static::$statusCodes) && ($reason === '')) {
if (! array_key_exists($code, static::$statusCodes) && $reason === '') {
throw HTTPException::forUnkownStatusCode($code);
}

$this->statusCode = $code;

$this->reason = ($reason !== '') ? $reason : static::$statusCodes[$code];
$this->reason = $reason !== '' ? $reason : static::$statusCodes[$code];

return $this;
}
Expand DownExpand Up@@ -366,8 +376,10 @@ public function setLastModified($date)
public function send()
{
// If we're enforcing a Content Security Policy,
// we need to give it a chance to build out it's headers.
$this->CSP->finalize($this);
// we need to give it a chance to build out its headers.
if ($this->shouldFinalizeCsp()) {
$this->getCSP()->finalize($this);
}

$this->sendHeaders();
$this->sendCookies();
Expand All@@ -376,6 +388,44 @@ public function send()
return $this;
}

/**
* Decides whether {@see ContentSecurityPolicy::finalize()} should run for
* this response. Keeping the CSP class unloaded on requests that do not
* need it avoids the cost of constructing a 1000+ line service on every
* request.
*/
private function shouldFinalizeCsp(): bool
{
// Developer already touched CSP through getCSP(); respect it.
if ($this->CSP !== null) {
return true;
}

// A CSP instance has been registered (e.g., via Services::injectMock()
// or any earlier service('csp') call) — reuse it instead of skipping.
if (Services::has('csp')) {
return true;
}

if (config(App::class)->CSPEnabled) {
return true;
}

// Placeholders in the body still need to be stripped even when CSP
// is disabled, so the body is scanned for the configured nonce tags
// before committing to loading the full CSP class.
$body = (string) $this->body;

if ($body === '') {
return false;
}

$cspConfig = config(ContentSecurityPolicyConfig::class);

return str_contains($body, $cspConfig->scriptNonceTag)
|| str_contains($body, $cspConfig->styleNonceTag);
}

/**
* Sends the headers of this HTTP response to the browser.
*
Expand DownExpand Up@@ -518,8 +568,10 @@ public function setCookie(
$httponly = null,
$samesite = null,
) {
$store = $this->getCookieStore();

if ($name instanceof Cookie) {
$this->cookieStore = $this->cookieStore->put($name);
$this->cookieStore = $store->put($name);

return $this;
}
Expand DownExpand Up@@ -553,18 +605,23 @@ public function setCookie(
'samesite' => $samesite ?? '',
]);

$this->cookieStore = $this->cookieStore->put($cookie);
$this->cookieStore = $store->put($cookie);

return $this;
}

/**
* Returns the `CookieStore` instance.
*
* Lazily instantiates the `CookieStore` on first call, so that the Cookie and
* CookieStore classes are not loaded on requests that do not use cookies.
*
* @return CookieStore
*/
public function getCookieStore()
{
$this->cookieStore ??= new CookieStore([]);

return $this->cookieStore;
}

Expand All@@ -573,9 +630,10 @@ public function getCookieStore()
*/
public function hasCookie(string $name, ?string $value = null, string $prefix = ''): bool
{
$store = $this->getCookieStore();
$prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

return $this->cookieStore->has($name, $prefix, $value);
return $store->has($name, $prefix, $value);
}

/**
Expand All@@ -588,14 +646,16 @@ public function hasCookie(string $name, ?string $value = null, string $prefix =
*/
public function getCookie(?string $name = null, string $prefix = '')
{
$store = $this->getCookieStore();

if ((string) $name === '') {
return $this->cookieStore->display();
return $store->display();
}

try {
$prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

return $this->cookieStore->get($name, $prefix);
return $store->get($name, $prefix);
} catch (CookieException $e) {
log_message('error', (string) $e);

Expand All@@ -614,10 +674,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
return $this;
}

$store = $this->getCookieStore();
$prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

$prefixed = $prefix . $name;
$store = $this->cookieStore;
$found = false;

/** @var Cookie $cookie */
Expand DownExpand Up@@ -653,6 +713,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
*/
public function getCookies()
{
if ($this->cookieStore === null) {
return [];
}

return $this->cookieStore->display();
}

Expand All@@ -663,7 +727,7 @@ public function getCookies()
*/
protected function sendCookies()
{
if ($this->pretend) {
if ($this->pretend || $this->cookieStore === null) {
return;
}

Expand DownExpand Up@@ -753,6 +817,8 @@ public function download(string $filename = '', $data = '', bool $setMime = fals

public function getCSP(): ContentSecurityPolicy
{
$this->CSP ??= service('csp');

return $this->CSP;
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
refactor: lazily load CSP and Cookie only when needed by Response#10121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 2 commits into

from

Apr 22, 2026
 Merged


refactor: lazily load CSP and Cookie only when needed by Response
#10121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
faa2c5b

refactor: lazily load CSP and Cookie only when needed by Response


paulbalandan Apr 18, 2026
d0e8a07

address review


paulbalandan Apr 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 6 additions & 18 deletions
system/HTTP/Response.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,7 @@
namespace CodeIgniter\HTTP;

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use Config\Cookie as CookieConfig;

/**
 * Representation of an outgoing, server-side response.
Expand All@@ -38,7 +36,7 @@ class Response extends Message implements ResponseInterface
 /**
 * HTTP status codes
 *
 * @var array
 * @var array<int, string>
 */
 protected static $statusCodes = [
 // 1xx: Informational
Expand DownExpand Up@@ -140,23 +138,14 @@ class Response extends Message implements ResponseInterface
 */
 protected $pretend = false;

 /**
 * Construct a non-caching response with a default content type of `text/html`.
 */
 public function __construct()
 {
 // Default to a non-caching page.
 // Also ensures that a Cache-control header exists.
 $this->noCache();

 // We need CSP object even if not enabled to avoid calls to non existing methods
 $this->CSP = service('csp');

 $this->cookieStore = new CookieStore([]);

 $cookie = config(CookieConfig::class);

 Cookie::setDefaults($cookie);
 Cookie::setDefaults(config('Cookie'));

 // Default to an HTML Content-Type. Devs can override if needed.
 $this->setContentType('text/html');
 $this->noCache()->setContentType('text/html');
Comment thread
michalsn marked this conversation as resolved.

 }

 /**
Expand All@@ -168,7 +157,6 @@ public function __construct()
 * @return $this
 *
 * @internal For testing purposes only.
 * @testTag only available to test code
 */
 public function pretend(bool $pretend = true)
 {
Expand Down

98 changes: 82 additions & 16 deletions
system/HTTP/ResponseTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Config\Services;
use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\Cookie\Exceptions\CookieException;
Expand All@@ -21,6 +22,8 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\App;
use Config\ContentSecurityPolicy as ContentSecurityPolicyConfig;
use Config\Cookie as CookieConfig;
use DateTime;
use DateTimeZone;
Expand All@@ -31,21 +34,30 @@
 * Additional methods to make a PSR-7 Response class
 * compliant with the framework's own ResponseInterface.
 *
 * @property array<int, string> $statusCodes
 * @property string|null $body
 *
 * @see https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php
 */
trait ResponseTrait
{
 /**
 * Content security policy handler
 * Content security policy handler.
 *
 * Lazily instantiated on first use via `self::getCSP()` so that the
 * ContentSecurityPolicy class is not loaded on requests that do not use CSP.
 *
 * @var ContentSecurityPolicy
 * @var ContentSecurityPolicy|null
 */
 protected $CSP;

 /**
 * CookieStore instance.
 *
 * @var CookieStore
 * Lazily instantiated on first cookie-related call so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @var CookieStore|null
 */
 protected $cookieStore;

Expand DownExpand Up@@ -77,19 +89,17 @@ trait ResponseTrait
 */
 public function setStatusCode(int $code, string $reason = '')
 {
 // Valid range?
 if ($code < 100 || $code > 599) {
 throw HTTPException::forInvalidStatusCode($code);
 }

 // Unknown and no message?
 if (! array_key_exists($code, static::$statusCodes) && ($reason === '')) {
 if (! array_key_exists($code, static::$statusCodes) && $reason === '') {
 throw HTTPException::forUnkownStatusCode($code);
 }

 $this->statusCode = $code;

 $this->reason = ($reason !== '') ? $reason : static::$statusCodes[$code];
 $this->reason = $reason !== '' ? $reason : static::$statusCodes[$code];

 return $this;
 }
Expand DownExpand Up@@ -366,8 +376,10 @@ public function setLastModified($date)
 public function send()
 {
 // If we're enforcing a Content Security Policy,
 // we need to give it a chance to build out it's headers.
 $this->CSP->finalize($this);
 // we need to give it a chance to build out its headers.
 if ($this->shouldFinalizeCsp()) {
 $this->getCSP()->finalize($this);
 }

 $this->sendHeaders();
 $this->sendCookies();
Expand All@@ -376,6 +388,44 @@ public function send()
 return $this;
 }

 /**
 * Decides whether {@see ContentSecurityPolicy::finalize()} should run for
 * this response. Keeping the CSP class unloaded on requests that do not
 * need it avoids the cost of constructing a 1000+ line service on every
 * request.
 */
 private function shouldFinalizeCsp(): bool
 {
 // Developer already touched CSP through getCSP(); respect it.
 if ($this->CSP !== null) {
 return true;
 }

 // A CSP instance has been registered (e.g., via Services::injectMock()
 // or any earlier service('csp') call) — reuse it instead of skipping.
 if (Services::has('csp')) {
 return true;
 }

 if (config(App::class)->CSPEnabled) {
 return true;
 }

 // Placeholders in the body still need to be stripped even when CSP
 // is disabled, so the body is scanned for the configured nonce tags
 // before committing to loading the full CSP class.
 $body = (string) $this->body;

 if ($body === '') {
 return false;
 }

 $cspConfig = config(ContentSecurityPolicyConfig::class);

 return str_contains($body, $cspConfig->scriptNonceTag)
 || str_contains($body, $cspConfig->styleNonceTag);
 }

 /**
 * Sends the headers of this HTTP response to the browser.
 *
Expand DownExpand Up@@ -518,8 +568,10 @@ public function setCookie(
 $httponly = null,
 $samesite = null,
 ) {
 $store = $this->getCookieStore();

 if ($name instanceof Cookie) {
 $this->cookieStore = $this->cookieStore->put($name);
 $this->cookieStore = $store->put($name);

 return $this;
 }
Expand DownExpand Up@@ -553,18 +605,23 @@ public function setCookie(
 'samesite' => $samesite ?? '',
 ]);

 $this->cookieStore = $this->cookieStore->put($cookie);
 $this->cookieStore = $store->put($cookie);

 return $this;
 }

 /**
 * Returns the `CookieStore` instance.
 *
 * Lazily instantiates the `CookieStore` on first call, so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @return CookieStore
 */
 public function getCookieStore()
 {
 $this->cookieStore ??= new CookieStore([]);

 return $this->cookieStore;
 }

Expand All@@ -573,9 +630,10 @@ public function getCookieStore()
 */
 public function hasCookie(string $name, ?string $value = null, string $prefix = ''): bool
 {
 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->has($name, $prefix, $value);
 return $store->has($name, $prefix, $value);
 }

 /**
Expand All@@ -588,14 +646,16 @@ public function hasCookie(string $name, ?string $value = null, string $prefix =
 */
 public function getCookie(?string $name = null, string $prefix = '')
 {
 $store = $this->getCookieStore();

 if ((string) $name === '') {
 return $this->cookieStore->display();
 return $store->display();
 }

 try {
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->get($name, $prefix);
 return $store->get($name, $prefix);
 } catch (CookieException $e) {
 log_message('error', (string) $e);

Expand All@@ -614,10 +674,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 return $this;
 }

 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 $prefixed = $prefix . $name;
 $store = $this->cookieStore;
 $found = false;

 /** @var Cookie $cookie */
Expand DownExpand Up@@ -653,6 +713,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 */
 public function getCookies()
 {
 if ($this->cookieStore === null) {
 return [];
 }

 return $this->cookieStore->display();
 }

Expand All@@ -663,7 +727,7 @@ public function getCookies()
 */
 protected function sendCookies()
 {
 if ($this->pretend) {
 if ($this->pretend || $this->cookieStore === null) {
 return;
 }

Expand DownExpand Up@@ -753,6 +817,8 @@ public function download(string $filename = '', $data = '', bool $setMime = fals

 public function getCSP(): ContentSecurityPolicy
 {
 $this->CSP ??= service('csp');

 return $this->CSP;
 }
}
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor: lazily load CSP and Cookie only when needed by Response#10121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 2 commits into

from

Apr 22, 2026
 Merged


refactor: lazily load CSP and Cookie only when needed by Response
#10121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
faa2c5b

refactor: lazily load CSP and Cookie only when needed by Response


paulbalandan Apr 18, 2026
d0e8a07

address review


paulbalandan Apr 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 6 additions & 18 deletions
system/HTTP/Response.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,7 @@
namespace CodeIgniter\HTTP;

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use Config\Cookie as CookieConfig;

/**
 * Representation of an outgoing, server-side response.
Expand All@@ -38,7 +36,7 @@ class Response extends Message implements ResponseInterface
 /**
 * HTTP status codes
 *
 * @var array
 * @var array<int, string>
 */
 protected static $statusCodes = [
 // 1xx: Informational
Expand DownExpand Up@@ -140,23 +138,14 @@ class Response extends Message implements ResponseInterface
 */
 protected $pretend = false;

 /**
 * Construct a non-caching response with a default content type of `text/html`.
 */
 public function __construct()
 {
 // Default to a non-caching page.
 // Also ensures that a Cache-control header exists.
 $this->noCache();

 // We need CSP object even if not enabled to avoid calls to non existing methods
 $this->CSP = service('csp');

 $this->cookieStore = new CookieStore([]);

 $cookie = config(CookieConfig::class);

 Cookie::setDefaults($cookie);
 Cookie::setDefaults(config('Cookie'));

 // Default to an HTML Content-Type. Devs can override if needed.
 $this->setContentType('text/html');
 $this->noCache()->setContentType('text/html');
Comment thread
michalsn marked this conversation as resolved.

 }

 /**
Expand All@@ -168,7 +157,6 @@ public function __construct()
 * @return $this
 *
 * @internal For testing purposes only.
 * @testTag only available to test code
 */
 public function pretend(bool $pretend = true)
 {
Expand Down

98 changes: 82 additions & 16 deletions
system/HTTP/ResponseTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Config\Services;
use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\Cookie\Exceptions\CookieException;
Expand All@@ -21,6 +22,8 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\App;
use Config\ContentSecurityPolicy as ContentSecurityPolicyConfig;
use Config\Cookie as CookieConfig;
use DateTime;
use DateTimeZone;
Expand All@@ -31,21 +34,30 @@
 * Additional methods to make a PSR-7 Response class
 * compliant with the framework's own ResponseInterface.
 *
 * @property array<int, string> $statusCodes
 * @property string|null $body
 *
 * @see https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php
 */
trait ResponseTrait
{
 /**
 * Content security policy handler
 * Content security policy handler.
 *
 * Lazily instantiated on first use via `self::getCSP()` so that the
 * ContentSecurityPolicy class is not loaded on requests that do not use CSP.
 *
 * @var ContentSecurityPolicy
 * @var ContentSecurityPolicy|null
 */
 protected $CSP;

 /**
 * CookieStore instance.
 *
 * @var CookieStore
 * Lazily instantiated on first cookie-related call so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @var CookieStore|null
 */
 protected $cookieStore;

Expand DownExpand Up@@ -77,19 +89,17 @@ trait ResponseTrait
 */
 public function setStatusCode(int $code, string $reason = '')
 {
 // Valid range?
 if ($code < 100 || $code > 599) {
 throw HTTPException::forInvalidStatusCode($code);
 }

 // Unknown and no message?
 if (! array_key_exists($code, static::$statusCodes) && ($reason === '')) {
 if (! array_key_exists($code, static::$statusCodes) && $reason === '') {
 throw HTTPException::forUnkownStatusCode($code);
 }

 $this->statusCode = $code;

 $this->reason = ($reason !== '') ? $reason : static::$statusCodes[$code];
 $this->reason = $reason !== '' ? $reason : static::$statusCodes[$code];

 return $this;
 }
Expand DownExpand Up@@ -366,8 +376,10 @@ public function setLastModified($date)
 public function send()
 {
 // If we're enforcing a Content Security Policy,
 // we need to give it a chance to build out it's headers.
 $this->CSP->finalize($this);
 // we need to give it a chance to build out its headers.
 if ($this->shouldFinalizeCsp()) {
 $this->getCSP()->finalize($this);
 }

 $this->sendHeaders();
 $this->sendCookies();
Expand All@@ -376,6 +388,44 @@ public function send()
 return $this;
 }

 /**
 * Decides whether {@see ContentSecurityPolicy::finalize()} should run for
 * this response. Keeping the CSP class unloaded on requests that do not
 * need it avoids the cost of constructing a 1000+ line service on every
 * request.
 */
 private function shouldFinalizeCsp(): bool
 {
 // Developer already touched CSP through getCSP(); respect it.
 if ($this->CSP !== null) {
 return true;
 }

 // A CSP instance has been registered (e.g., via Services::injectMock()
 // or any earlier service('csp') call) — reuse it instead of skipping.
 if (Services::has('csp')) {
 return true;
 }

 if (config(App::class)->CSPEnabled) {
 return true;
 }

 // Placeholders in the body still need to be stripped even when CSP
 // is disabled, so the body is scanned for the configured nonce tags
 // before committing to loading the full CSP class.
 $body = (string) $this->body;

 if ($body === '') {
 return false;
 }

 $cspConfig = config(ContentSecurityPolicyConfig::class);

 return str_contains($body, $cspConfig->scriptNonceTag)
 || str_contains($body, $cspConfig->styleNonceTag);
 }

 /**
 * Sends the headers of this HTTP response to the browser.
 *
Expand DownExpand Up@@ -518,8 +568,10 @@ public function setCookie(
 $httponly = null,
 $samesite = null,
 ) {
 $store = $this->getCookieStore();

 if ($name instanceof Cookie) {
 $this->cookieStore = $this->cookieStore->put($name);
 $this->cookieStore = $store->put($name);

 return $this;
 }
Expand DownExpand Up@@ -553,18 +605,23 @@ public function setCookie(
 'samesite' => $samesite ?? '',
 ]);

 $this->cookieStore = $this->cookieStore->put($cookie);
 $this->cookieStore = $store->put($cookie);

 return $this;
 }

 /**
 * Returns the `CookieStore` instance.
 *
 * Lazily instantiates the `CookieStore` on first call, so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @return CookieStore
 */
 public function getCookieStore()
 {
 $this->cookieStore ??= new CookieStore([]);

 return $this->cookieStore;
 }

Expand All@@ -573,9 +630,10 @@ public function getCookieStore()
 */
 public function hasCookie(string $name, ?string $value = null, string $prefix = ''): bool
 {
 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->has($name, $prefix, $value);
 return $store->has($name, $prefix, $value);
 }

 /**
Expand All@@ -588,14 +646,16 @@ public function hasCookie(string $name, ?string $value = null, string $prefix =
 */
 public function getCookie(?string $name = null, string $prefix = '')
 {
 $store = $this->getCookieStore();

 if ((string) $name === '') {
 return $this->cookieStore->display();
 return $store->display();
 }

 try {
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->get($name, $prefix);
 return $store->get($name, $prefix);
 } catch (CookieException $e) {
 log_message('error', (string) $e);

Expand All@@ -614,10 +674,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 return $this;
 }

 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 $prefixed = $prefix . $name;
 $store = $this->cookieStore;
 $found = false;

 /** @var Cookie $cookie */
Expand DownExpand Up@@ -653,6 +713,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 */
 public function getCookies()
 {
 if ($this->cookieStore === null) {
 return [];
 }

 return $this->cookieStore->display();
 }

Expand All@@ -663,7 +727,7 @@ public function getCookies()
 */
 protected function sendCookies()
 {
 if ($this->pretend) {
 if ($this->pretend || $this->cookieStore === null) {
 return;
 }

Expand DownExpand Up@@ -753,6 +817,8 @@ public function download(string $filename = '', $data = '', bool $setMime = fals

 public function getCSP(): ContentSecurityPolicy
 {
 $this->CSP ??= service('csp');

 return $this->CSP;
 }
}
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor: lazily load CSP and Cookie only when needed by Response#10121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 2 commits into

from

Apr 22, 2026
 Merged


refactor: lazily load CSP and Cookie only when needed by Response
#10121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
faa2c5b

refactor: lazily load CSP and Cookie only when needed by Response


paulbalandan Apr 18, 2026
d0e8a07

address review


paulbalandan Apr 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 6 additions & 18 deletions
system/HTTP/Response.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,7 @@
namespace CodeIgniter\HTTP;

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use Config\Cookie as CookieConfig;

/**
 * Representation of an outgoing, server-side response.
Expand All@@ -38,7 +36,7 @@ class Response extends Message implements ResponseInterface
 /**
 * HTTP status codes
 *
 * @var array
 * @var array<int, string>
 */
 protected static $statusCodes = [
 // 1xx: Informational
Expand DownExpand Up@@ -140,23 +138,14 @@ class Response extends Message implements ResponseInterface
 */
 protected $pretend = false;

 /**
 * Construct a non-caching response with a default content type of `text/html`.
 */
 public function __construct()
 {
 // Default to a non-caching page.
 // Also ensures that a Cache-control header exists.
 $this->noCache();

 // We need CSP object even if not enabled to avoid calls to non existing methods
 $this->CSP = service('csp');

 $this->cookieStore = new CookieStore([]);

 $cookie = config(CookieConfig::class);

 Cookie::setDefaults($cookie);
 Cookie::setDefaults(config('Cookie'));

 // Default to an HTML Content-Type. Devs can override if needed.
 $this->setContentType('text/html');
 $this->noCache()->setContentType('text/html');
Comment thread
michalsn marked this conversation as resolved.

 }

 /**
Expand All@@ -168,7 +157,6 @@ public function __construct()
 * @return $this
 *
 * @internal For testing purposes only.
 * @testTag only available to test code
 */
 public function pretend(bool $pretend = true)
 {
Expand Down

98 changes: 82 additions & 16 deletions
system/HTTP/ResponseTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Config\Services;
use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\Cookie\Exceptions\CookieException;
Expand All@@ -21,6 +22,8 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\App;
use Config\ContentSecurityPolicy as ContentSecurityPolicyConfig;
use Config\Cookie as CookieConfig;
use DateTime;
use DateTimeZone;
Expand All@@ -31,21 +34,30 @@
 * Additional methods to make a PSR-7 Response class
 * compliant with the framework's own ResponseInterface.
 *
 * @property array<int, string> $statusCodes
 * @property string|null $body
 *
 * @see https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php
 */
trait ResponseTrait
{
 /**
 * Content security policy handler
 * Content security policy handler.
 *
 * Lazily instantiated on first use via `self::getCSP()` so that the
 * ContentSecurityPolicy class is not loaded on requests that do not use CSP.
 *
 * @var ContentSecurityPolicy
 * @var ContentSecurityPolicy|null
 */
 protected $CSP;

 /**
 * CookieStore instance.
 *
 * @var CookieStore
 * Lazily instantiated on first cookie-related call so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @var CookieStore|null
 */
 protected $cookieStore;

Expand DownExpand Up@@ -77,19 +89,17 @@ trait ResponseTrait
 */
 public function setStatusCode(int $code, string $reason = '')
 {
 // Valid range?
 if ($code < 100 || $code > 599) {
 throw HTTPException::forInvalidStatusCode($code);
 }

 // Unknown and no message?
 if (! array_key_exists($code, static::$statusCodes) && ($reason === '')) {
 if (! array_key_exists($code, static::$statusCodes) && $reason === '') {
 throw HTTPException::forUnkownStatusCode($code);
 }

 $this->statusCode = $code;

 $this->reason = ($reason !== '') ? $reason : static::$statusCodes[$code];
 $this->reason = $reason !== '' ? $reason : static::$statusCodes[$code];

 return $this;
 }
Expand DownExpand Up@@ -366,8 +376,10 @@ public function setLastModified($date)
 public function send()
 {
 // If we're enforcing a Content Security Policy,
 // we need to give it a chance to build out it's headers.
 $this->CSP->finalize($this);
 // we need to give it a chance to build out its headers.
 if ($this->shouldFinalizeCsp()) {
 $this->getCSP()->finalize($this);
 }

 $this->sendHeaders();
 $this->sendCookies();
Expand All@@ -376,6 +388,44 @@ public function send()
 return $this;
 }

 /**
 * Decides whether {@see ContentSecurityPolicy::finalize()} should run for
 * this response. Keeping the CSP class unloaded on requests that do not
 * need it avoids the cost of constructing a 1000+ line service on every
 * request.
 */
 private function shouldFinalizeCsp(): bool
 {
 // Developer already touched CSP through getCSP(); respect it.
 if ($this->CSP !== null) {
 return true;
 }

 // A CSP instance has been registered (e.g., via Services::injectMock()
 // or any earlier service('csp') call) — reuse it instead of skipping.
 if (Services::has('csp')) {
 return true;
 }

 if (config(App::class)->CSPEnabled) {
 return true;
 }

 // Placeholders in the body still need to be stripped even when CSP
 // is disabled, so the body is scanned for the configured nonce tags
 // before committing to loading the full CSP class.
 $body = (string) $this->body;

 if ($body === '') {
 return false;
 }

 $cspConfig = config(ContentSecurityPolicyConfig::class);

 return str_contains($body, $cspConfig->scriptNonceTag)
 || str_contains($body, $cspConfig->styleNonceTag);
 }

 /**
 * Sends the headers of this HTTP response to the browser.
 *
Expand DownExpand Up@@ -518,8 +568,10 @@ public function setCookie(
 $httponly = null,
 $samesite = null,
 ) {
 $store = $this->getCookieStore();

 if ($name instanceof Cookie) {
 $this->cookieStore = $this->cookieStore->put($name);
 $this->cookieStore = $store->put($name);

 return $this;
 }
Expand DownExpand Up@@ -553,18 +605,23 @@ public function setCookie(
 'samesite' => $samesite ?? '',
 ]);

 $this->cookieStore = $this->cookieStore->put($cookie);
 $this->cookieStore = $store->put($cookie);

 return $this;
 }

 /**
 * Returns the `CookieStore` instance.
 *
 * Lazily instantiates the `CookieStore` on first call, so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @return CookieStore
 */
 public function getCookieStore()
 {
 $this->cookieStore ??= new CookieStore([]);

 return $this->cookieStore;
 }

Expand All@@ -573,9 +630,10 @@ public function getCookieStore()
 */
 public function hasCookie(string $name, ?string $value = null, string $prefix = ''): bool
 {
 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->has($name, $prefix, $value);
 return $store->has($name, $prefix, $value);
 }

 /**
Expand All@@ -588,14 +646,16 @@ public function hasCookie(string $name, ?string $value = null, string $prefix =
 */
 public function getCookie(?string $name = null, string $prefix = '')
 {
 $store = $this->getCookieStore();

 if ((string) $name === '') {
 return $this->cookieStore->display();
 return $store->display();
 }

 try {
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->get($name, $prefix);
 return $store->get($name, $prefix);
 } catch (CookieException $e) {
 log_message('error', (string) $e);

Expand All@@ -614,10 +674,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 return $this;
 }

 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 $prefixed = $prefix . $name;
 $store = $this->cookieStore;
 $found = false;

 /** @var Cookie $cookie */
Expand DownExpand Up@@ -653,6 +713,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 */
 public function getCookies()
 {
 if ($this->cookieStore === null) {
 return [];
 }

 return $this->cookieStore->display();
 }

Expand All@@ -663,7 +727,7 @@ public function getCookies()
 */
 protected function sendCookies()
 {
 if ($this->pretend) {
 if ($this->pretend || $this->cookieStore === null) {
 return;
 }

Expand DownExpand Up@@ -753,6 +817,8 @@ public function download(string $filename = '', $data = '', bool $setMime = fals

 public function getCSP(): ContentSecurityPolicy
 {
 $this->CSP ??= service('csp');

 return $this->CSP;
 }
}
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
refactor: lazily load CSP and Cookie only when needed by Response#10121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 2 commits into

from

Apr 22, 2026
 Merged


refactor: lazily load CSP and Cookie only when needed by Response
#10121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
faa2c5b

refactor: lazily load CSP and Cookie only when needed by Response


paulbalandan Apr 18, 2026
d0e8a07

address review


paulbalandan Apr 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 6 additions & 18 deletions
system/HTTP/Response.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,7 @@
namespace CodeIgniter\HTTP;

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use Config\Cookie as CookieConfig;

/**
 * Representation of an outgoing, server-side response.
Expand All@@ -38,7 +36,7 @@ class Response extends Message implements ResponseInterface
 /**
 * HTTP status codes
 *
 * @var array
 * @var array<int, string>
 */
 protected static $statusCodes = [
 // 1xx: Informational
Expand DownExpand Up@@ -140,23 +138,14 @@ class Response extends Message implements ResponseInterface
 */
 protected $pretend = false;

 /**
 * Construct a non-caching response with a default content type of `text/html`.
 */
 public function __construct()
 {
 // Default to a non-caching page.
 // Also ensures that a Cache-control header exists.
 $this->noCache();

 // We need CSP object even if not enabled to avoid calls to non existing methods
 $this->CSP = service('csp');

 $this->cookieStore = new CookieStore([]);

 $cookie = config(CookieConfig::class);

 Cookie::setDefaults($cookie);
 Cookie::setDefaults(config('Cookie'));

 // Default to an HTML Content-Type. Devs can override if needed.
 $this->setContentType('text/html');
 $this->noCache()->setContentType('text/html');
Comment thread
michalsn marked this conversation as resolved.

 }

 /**
Expand All@@ -168,7 +157,6 @@ public function __construct()
 * @return $this
 *
 * @internal For testing purposes only.
 * @testTag only available to test code
 */
 public function pretend(bool $pretend = true)
 {
Expand Down

98 changes: 82 additions & 16 deletions
system/HTTP/ResponseTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Config\Services;
use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\Cookie\Exceptions\CookieException;
Expand All@@ -21,6 +22,8 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\App;
use Config\ContentSecurityPolicy as ContentSecurityPolicyConfig;
use Config\Cookie as CookieConfig;
use DateTime;
use DateTimeZone;
Expand All@@ -31,21 +34,30 @@
 * Additional methods to make a PSR-7 Response class
 * compliant with the framework's own ResponseInterface.
 *
 * @property array<int, string> $statusCodes
 * @property string|null $body
 *
 * @see https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php
 */
trait ResponseTrait
{
 /**
 * Content security policy handler
 * Content security policy handler.
 *
 * Lazily instantiated on first use via `self::getCSP()` so that the
 * ContentSecurityPolicy class is not loaded on requests that do not use CSP.
 *
 * @var ContentSecurityPolicy
 * @var ContentSecurityPolicy|null
 */
 protected $CSP;

 /**
 * CookieStore instance.
 *
 * @var CookieStore
 * Lazily instantiated on first cookie-related call so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @var CookieStore|null
 */
 protected $cookieStore;

Expand DownExpand Up@@ -77,19 +89,17 @@ trait ResponseTrait
 */
 public function setStatusCode(int $code, string $reason = '')
 {
 // Valid range?
 if ($code < 100 || $code > 599) {
 throw HTTPException::forInvalidStatusCode($code);
 }

 // Unknown and no message?
 if (! array_key_exists($code, static::$statusCodes) && ($reason === '')) {
 if (! array_key_exists($code, static::$statusCodes) && $reason === '') {
 throw HTTPException::forUnkownStatusCode($code);
 }

 $this->statusCode = $code;

 $this->reason = ($reason !== '') ? $reason : static::$statusCodes[$code];
 $this->reason = $reason !== '' ? $reason : static::$statusCodes[$code];

 return $this;
 }
Expand DownExpand Up@@ -366,8 +376,10 @@ public function setLastModified($date)
 public function send()
 {
 // If we're enforcing a Content Security Policy,
 // we need to give it a chance to build out it's headers.
 $this->CSP->finalize($this);
 // we need to give it a chance to build out its headers.
 if ($this->shouldFinalizeCsp()) {
 $this->getCSP()->finalize($this);
 }

 $this->sendHeaders();
 $this->sendCookies();
Expand All@@ -376,6 +388,44 @@ public function send()
 return $this;
 }

 /**
 * Decides whether {@see ContentSecurityPolicy::finalize()} should run for
 * this response. Keeping the CSP class unloaded on requests that do not
 * need it avoids the cost of constructing a 1000+ line service on every
 * request.
 */
 private function shouldFinalizeCsp(): bool
 {
 // Developer already touched CSP through getCSP(); respect it.
 if ($this->CSP !== null) {
 return true;
 }

 // A CSP instance has been registered (e.g., via Services::injectMock()
 // or any earlier service('csp') call) — reuse it instead of skipping.
 if (Services::has('csp')) {
 return true;
 }

 if (config(App::class)->CSPEnabled) {
 return true;
 }

 // Placeholders in the body still need to be stripped even when CSP
 // is disabled, so the body is scanned for the configured nonce tags
 // before committing to loading the full CSP class.
 $body = (string) $this->body;

 if ($body === '') {
 return false;
 }

 $cspConfig = config(ContentSecurityPolicyConfig::class);

 return str_contains($body, $cspConfig->scriptNonceTag)
 || str_contains($body, $cspConfig->styleNonceTag);
 }

 /**
 * Sends the headers of this HTTP response to the browser.
 *
Expand DownExpand Up@@ -518,8 +568,10 @@ public function setCookie(
 $httponly = null,
 $samesite = null,
 ) {
 $store = $this->getCookieStore();

 if ($name instanceof Cookie) {
 $this->cookieStore = $this->cookieStore->put($name);
 $this->cookieStore = $store->put($name);

 return $this;
 }
Expand DownExpand Up@@ -553,18 +605,23 @@ public function setCookie(
 'samesite' => $samesite ?? '',
 ]);

 $this->cookieStore = $this->cookieStore->put($cookie);
 $this->cookieStore = $store->put($cookie);

 return $this;
 }

 /**
 * Returns the `CookieStore` instance.
 *
 * Lazily instantiates the `CookieStore` on first call, so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @return CookieStore
 */
 public function getCookieStore()
 {
 $this->cookieStore ??= new CookieStore([]);

 return $this->cookieStore;
 }

Expand All@@ -573,9 +630,10 @@ public function getCookieStore()
 */
 public function hasCookie(string $name, ?string $value = null, string $prefix = ''): bool
 {
 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->has($name, $prefix, $value);
 return $store->has($name, $prefix, $value);
 }

 /**
Expand All@@ -588,14 +646,16 @@ public function hasCookie(string $name, ?string $value = null, string $prefix =
 */
 public function getCookie(?string $name = null, string $prefix = '')
 {
 $store = $this->getCookieStore();

 if ((string) $name === '') {
 return $this->cookieStore->display();
 return $store->display();
 }

 try {
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->get($name, $prefix);
 return $store->get($name, $prefix);
 } catch (CookieException $e) {
 log_message('error', (string) $e);

Expand All@@ -614,10 +674,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 return $this;
 }

 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 $prefixed = $prefix . $name;
 $store = $this->cookieStore;
 $found = false;

 /** @var Cookie $cookie */
Expand DownExpand Up@@ -653,6 +713,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 */
 public function getCookies()
 {
 if ($this->cookieStore === null) {
 return [];
 }

 return $this->cookieStore->display();
 }

Expand All@@ -663,7 +727,7 @@ public function getCookies()
 */
 protected function sendCookies()
 {
 if ($this->pretend) {
 if ($this->pretend || $this->cookieStore === null) {
 return;
 }

Expand DownExpand Up@@ -753,6 +817,8 @@ public function download(string $filename = '', $data = '', bool $setMime = fals

 public function getCSP(): ContentSecurityPolicy
 {
 $this->CSP ??= service('csp');

 return $this->CSP;
 }
}
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor: lazily load CSP and Cookie only when needed by Response#10121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 2 commits into

from

Apr 22, 2026
 Merged


refactor: lazily load CSP and Cookie only when needed by Response
#10121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
faa2c5b

refactor: lazily load CSP and Cookie only when needed by Response


paulbalandan Apr 18, 2026
d0e8a07

address review


paulbalandan Apr 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 6 additions & 18 deletions
system/HTTP/Response.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,7 @@
namespace CodeIgniter\HTTP;

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use Config\Cookie as CookieConfig;

/**
 * Representation of an outgoing, server-side response.
Expand All@@ -38,7 +36,7 @@ class Response extends Message implements ResponseInterface
 /**
 * HTTP status codes
 *
 * @var array
 * @var array<int, string>
 */
 protected static $statusCodes = [
 // 1xx: Informational
Expand DownExpand Up@@ -140,23 +138,14 @@ class Response extends Message implements ResponseInterface
 */
 protected $pretend = false;

 /**
 * Construct a non-caching response with a default content type of `text/html`.
 */
 public function __construct()
 {
 // Default to a non-caching page.
 // Also ensures that a Cache-control header exists.
 $this->noCache();

 // We need CSP object even if not enabled to avoid calls to non existing methods
 $this->CSP = service('csp');

 $this->cookieStore = new CookieStore([]);

 $cookie = config(CookieConfig::class);

 Cookie::setDefaults($cookie);
 Cookie::setDefaults(config('Cookie'));

 // Default to an HTML Content-Type. Devs can override if needed.
 $this->setContentType('text/html');
 $this->noCache()->setContentType('text/html');
Comment thread
michalsn marked this conversation as resolved.

 }

 /**
Expand All@@ -168,7 +157,6 @@ public function __construct()
 * @return $this
 *
 * @internal For testing purposes only.
 * @testTag only available to test code
 */
 public function pretend(bool $pretend = true)
 {
Expand Down

98 changes: 82 additions & 16 deletions
system/HTTP/ResponseTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Config\Services;
use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\Cookie\Exceptions\CookieException;
Expand All@@ -21,6 +22,8 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\App;
use Config\ContentSecurityPolicy as ContentSecurityPolicyConfig;
use Config\Cookie as CookieConfig;
use DateTime;
use DateTimeZone;
Expand All@@ -31,21 +34,30 @@
 * Additional methods to make a PSR-7 Response class
 * compliant with the framework's own ResponseInterface.
 *
 * @property array<int, string> $statusCodes
 * @property string|null $body
 *
 * @see https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php
 */
trait ResponseTrait
{
 /**
 * Content security policy handler
 * Content security policy handler.
 *
 * Lazily instantiated on first use via `self::getCSP()` so that the
 * ContentSecurityPolicy class is not loaded on requests that do not use CSP.
 *
 * @var ContentSecurityPolicy
 * @var ContentSecurityPolicy|null
 */
 protected $CSP;

 /**
 * CookieStore instance.
 *
 * @var CookieStore
 * Lazily instantiated on first cookie-related call so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @var CookieStore|null
 */
 protected $cookieStore;

Expand DownExpand Up@@ -77,19 +89,17 @@ trait ResponseTrait
 */
 public function setStatusCode(int $code, string $reason = '')
 {
 // Valid range?
 if ($code < 100 || $code > 599) {
 throw HTTPException::forInvalidStatusCode($code);
 }

 // Unknown and no message?
 if (! array_key_exists($code, static::$statusCodes) && ($reason === '')) {
 if (! array_key_exists($code, static::$statusCodes) && $reason === '') {
 throw HTTPException::forUnkownStatusCode($code);
 }

 $this->statusCode = $code;

 $this->reason = ($reason !== '') ? $reason : static::$statusCodes[$code];
 $this->reason = $reason !== '' ? $reason : static::$statusCodes[$code];

 return $this;
 }
Expand DownExpand Up@@ -366,8 +376,10 @@ public function setLastModified($date)
 public function send()
 {
 // If we're enforcing a Content Security Policy,
 // we need to give it a chance to build out it's headers.
 $this->CSP->finalize($this);
 // we need to give it a chance to build out its headers.
 if ($this->shouldFinalizeCsp()) {
 $this->getCSP()->finalize($this);
 }

 $this->sendHeaders();
 $this->sendCookies();
Expand All@@ -376,6 +388,44 @@ public function send()
 return $this;
 }

 /**
 * Decides whether {@see ContentSecurityPolicy::finalize()} should run for
 * this response. Keeping the CSP class unloaded on requests that do not
 * need it avoids the cost of constructing a 1000+ line service on every
 * request.
 */
 private function shouldFinalizeCsp(): bool
 {
 // Developer already touched CSP through getCSP(); respect it.
 if ($this->CSP !== null) {
 return true;
 }

 // A CSP instance has been registered (e.g., via Services::injectMock()
 // or any earlier service('csp') call) — reuse it instead of skipping.
 if (Services::has('csp')) {
 return true;
 }

 if (config(App::class)->CSPEnabled) {
 return true;
 }

 // Placeholders in the body still need to be stripped even when CSP
 // is disabled, so the body is scanned for the configured nonce tags
 // before committing to loading the full CSP class.
 $body = (string) $this->body;

 if ($body === '') {
 return false;
 }

 $cspConfig = config(ContentSecurityPolicyConfig::class);

 return str_contains($body, $cspConfig->scriptNonceTag)
 || str_contains($body, $cspConfig->styleNonceTag);
 }

 /**
 * Sends the headers of this HTTP response to the browser.
 *
Expand DownExpand Up@@ -518,8 +568,10 @@ public function setCookie(
 $httponly = null,
 $samesite = null,
 ) {
 $store = $this->getCookieStore();

 if ($name instanceof Cookie) {
 $this->cookieStore = $this->cookieStore->put($name);
 $this->cookieStore = $store->put($name);

 return $this;
 }
Expand DownExpand Up@@ -553,18 +605,23 @@ public function setCookie(
 'samesite' => $samesite ?? '',
 ]);

 $this->cookieStore = $this->cookieStore->put($cookie);
 $this->cookieStore = $store->put($cookie);

 return $this;
 }

 /**
 * Returns the `CookieStore` instance.
 *
 * Lazily instantiates the `CookieStore` on first call, so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @return CookieStore
 */
 public function getCookieStore()
 {
 $this->cookieStore ??= new CookieStore([]);

 return $this->cookieStore;
 }

Expand All@@ -573,9 +630,10 @@ public function getCookieStore()
 */
 public function hasCookie(string $name, ?string $value = null, string $prefix = ''): bool
 {
 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->has($name, $prefix, $value);
 return $store->has($name, $prefix, $value);
 }

 /**
Expand All@@ -588,14 +646,16 @@ public function hasCookie(string $name, ?string $value = null, string $prefix =
 */
 public function getCookie(?string $name = null, string $prefix = '')
 {
 $store = $this->getCookieStore();

 if ((string) $name === '') {
 return $this->cookieStore->display();
 return $store->display();
 }

 try {
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->get($name, $prefix);
 return $store->get($name, $prefix);
 } catch (CookieException $e) {
 log_message('error', (string) $e);

Expand All@@ -614,10 +674,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 return $this;
 }

 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 $prefixed = $prefix . $name;
 $store = $this->cookieStore;
 $found = false;

 /** @var Cookie $cookie */
Expand DownExpand Up@@ -653,6 +713,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 */
 public function getCookies()
 {
 if ($this->cookieStore === null) {
 return [];
 }

 return $this->cookieStore->display();
 }

Expand All@@ -663,7 +727,7 @@ public function getCookies()
 */
 protected function sendCookies()
 {
 if ($this->pretend) {
 if ($this->pretend || $this->cookieStore === null) {
 return;
 }

Expand DownExpand Up@@ -753,6 +817,8 @@ public function download(string $filename = '', $data = '', bool $setMime = fals

 public function getCSP(): ContentSecurityPolicy
 {
 $this->CSP ??= service('csp');

 return $this->CSP;
 }
}
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor: lazily load CSP and Cookie only when needed by Response#10121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 2 commits into

from

Apr 22, 2026
 Merged


refactor: lazily load CSP and Cookie only when needed by Response
#10121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
faa2c5b

refactor: lazily load CSP and Cookie only when needed by Response


paulbalandan Apr 18, 2026
d0e8a07

address review


paulbalandan Apr 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 6 additions & 18 deletions
system/HTTP/Response.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,7 @@
namespace CodeIgniter\HTTP;

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use Config\Cookie as CookieConfig;

/**
 * Representation of an outgoing, server-side response.
Expand All@@ -38,7 +36,7 @@ class Response extends Message implements ResponseInterface
 /**
 * HTTP status codes
 *
 * @var array
 * @var array<int, string>
 */
 protected static $statusCodes = [
 // 1xx: Informational
Expand DownExpand Up@@ -140,23 +138,14 @@ class Response extends Message implements ResponseInterface
 */
 protected $pretend = false;

 /**
 * Construct a non-caching response with a default content type of `text/html`.
 */
 public function __construct()
 {
 // Default to a non-caching page.
 // Also ensures that a Cache-control header exists.
 $this->noCache();

 // We need CSP object even if not enabled to avoid calls to non existing methods
 $this->CSP = service('csp');

 $this->cookieStore = new CookieStore([]);

 $cookie = config(CookieConfig::class);

 Cookie::setDefaults($cookie);
 Cookie::setDefaults(config('Cookie'));

 // Default to an HTML Content-Type. Devs can override if needed.
 $this->setContentType('text/html');
 $this->noCache()->setContentType('text/html');
Comment thread
michalsn marked this conversation as resolved.

 }

 /**
Expand All@@ -168,7 +157,6 @@ public function __construct()
 * @return $this
 *
 * @internal For testing purposes only.
 * @testTag only available to test code
 */
 public function pretend(bool $pretend = true)
 {
Expand Down

98 changes: 82 additions & 16 deletions
system/HTTP/ResponseTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Config\Services;
use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\Cookie\Exceptions\CookieException;
Expand All@@ -21,6 +22,8 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\App;
use Config\ContentSecurityPolicy as ContentSecurityPolicyConfig;
use Config\Cookie as CookieConfig;
use DateTime;
use DateTimeZone;
Expand All@@ -31,21 +34,30 @@
 * Additional methods to make a PSR-7 Response class
 * compliant with the framework's own ResponseInterface.
 *
 * @property array<int, string> $statusCodes
 * @property string|null $body
 *
 * @see https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php
 */
trait ResponseTrait
{
 /**
 * Content security policy handler
 * Content security policy handler.
 *
 * Lazily instantiated on first use via `self::getCSP()` so that the
 * ContentSecurityPolicy class is not loaded on requests that do not use CSP.
 *
 * @var ContentSecurityPolicy
 * @var ContentSecurityPolicy|null
 */
 protected $CSP;

 /**
 * CookieStore instance.
 *
 * @var CookieStore
 * Lazily instantiated on first cookie-related call so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @var CookieStore|null
 */
 protected $cookieStore;

Expand DownExpand Up@@ -77,19 +89,17 @@ trait ResponseTrait
 */
 public function setStatusCode(int $code, string $reason = '')
 {
 // Valid range?
 if ($code < 100 || $code > 599) {
 throw HTTPException::forInvalidStatusCode($code);
 }

 // Unknown and no message?
 if (! array_key_exists($code, static::$statusCodes) && ($reason === '')) {
 if (! array_key_exists($code, static::$statusCodes) && $reason === '') {
 throw HTTPException::forUnkownStatusCode($code);
 }

 $this->statusCode = $code;

 $this->reason = ($reason !== '') ? $reason : static::$statusCodes[$code];
 $this->reason = $reason !== '' ? $reason : static::$statusCodes[$code];

 return $this;
 }
Expand DownExpand Up@@ -366,8 +376,10 @@ public function setLastModified($date)
 public function send()
 {
 // If we're enforcing a Content Security Policy,
 // we need to give it a chance to build out it's headers.
 $this->CSP->finalize($this);
 // we need to give it a chance to build out its headers.
 if ($this->shouldFinalizeCsp()) {
 $this->getCSP()->finalize($this);
 }

 $this->sendHeaders();
 $this->sendCookies();
Expand All@@ -376,6 +388,44 @@ public function send()
 return $this;
 }

 /**
 * Decides whether {@see ContentSecurityPolicy::finalize()} should run for
 * this response. Keeping the CSP class unloaded on requests that do not
 * need it avoids the cost of constructing a 1000+ line service on every
 * request.
 */
 private function shouldFinalizeCsp(): bool
 {
 // Developer already touched CSP through getCSP(); respect it.
 if ($this->CSP !== null) {
 return true;
 }

 // A CSP instance has been registered (e.g., via Services::injectMock()
 // or any earlier service('csp') call) — reuse it instead of skipping.
 if (Services::has('csp')) {
 return true;
 }

 if (config(App::class)->CSPEnabled) {
 return true;
 }

 // Placeholders in the body still need to be stripped even when CSP
 // is disabled, so the body is scanned for the configured nonce tags
 // before committing to loading the full CSP class.
 $body = (string) $this->body;

 if ($body === '') {
 return false;
 }

 $cspConfig = config(ContentSecurityPolicyConfig::class);

 return str_contains($body, $cspConfig->scriptNonceTag)
 || str_contains($body, $cspConfig->styleNonceTag);
 }

 /**
 * Sends the headers of this HTTP response to the browser.
 *
Expand DownExpand Up@@ -518,8 +568,10 @@ public function setCookie(
 $httponly = null,
 $samesite = null,
 ) {
 $store = $this->getCookieStore();

 if ($name instanceof Cookie) {
 $this->cookieStore = $this->cookieStore->put($name);
 $this->cookieStore = $store->put($name);

 return $this;
 }
Expand DownExpand Up@@ -553,18 +605,23 @@ public function setCookie(
 'samesite' => $samesite ?? '',
 ]);

 $this->cookieStore = $this->cookieStore->put($cookie);
 $this->cookieStore = $store->put($cookie);

 return $this;
 }

 /**
 * Returns the `CookieStore` instance.
 *
 * Lazily instantiates the `CookieStore` on first call, so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @return CookieStore
 */
 public function getCookieStore()
 {
 $this->cookieStore ??= new CookieStore([]);

 return $this->cookieStore;
 }

Expand All@@ -573,9 +630,10 @@ public function getCookieStore()
 */
 public function hasCookie(string $name, ?string $value = null, string $prefix = ''): bool
 {
 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->has($name, $prefix, $value);
 return $store->has($name, $prefix, $value);
 }

 /**
Expand All@@ -588,14 +646,16 @@ public function hasCookie(string $name, ?string $value = null, string $prefix =
 */
 public function getCookie(?string $name = null, string $prefix = '')
 {
 $store = $this->getCookieStore();

 if ((string) $name === '') {
 return $this->cookieStore->display();
 return $store->display();
 }

 try {
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->get($name, $prefix);
 return $store->get($name, $prefix);
 } catch (CookieException $e) {
 log_message('error', (string) $e);

Expand All@@ -614,10 +674,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 return $this;
 }

 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 $prefixed = $prefix . $name;
 $store = $this->cookieStore;
 $found = false;

 /** @var Cookie $cookie */
Expand DownExpand Up@@ -653,6 +713,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 */
 public function getCookies()
 {
 if ($this->cookieStore === null) {
 return [];
 }

 return $this->cookieStore->display();
 }

Expand All@@ -663,7 +727,7 @@ public function getCookies()
 */
 protected function sendCookies()
 {
 if ($this->pretend) {
 if ($this->pretend || $this->cookieStore === null) {
 return;
 }

Expand DownExpand Up@@ -753,6 +817,8 @@ public function download(string $filename = '', $data = '', bool $setMime = fals

 public function getCSP(): ContentSecurityPolicy
 {
 $this->CSP ??= service('csp');

 return $this->CSP;
 }
}
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
refactor: lazily load CSP and Cookie only when needed by Response#10121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

paulbalandan
merged 2 commits into

from

Apr 22, 2026
 Merged


refactor: lazily load CSP and Cookie only when needed by Response
#10121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
faa2c5b

refactor: lazily load CSP and Cookie only when needed by Response


paulbalandan Apr 18, 2026
d0e8a07

address review


paulbalandan Apr 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 6 additions & 18 deletions
system/HTTP/Response.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,7 @@
namespace CodeIgniter\HTTP;

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use Config\Cookie as CookieConfig;

/**
 * Representation of an outgoing, server-side response.
Expand All@@ -38,7 +36,7 @@ class Response extends Message implements ResponseInterface
 /**
 * HTTP status codes
 *
 * @var array
 * @var array<int, string>
 */
 protected static $statusCodes = [
 // 1xx: Informational
Expand DownExpand Up@@ -140,23 +138,14 @@ class Response extends Message implements ResponseInterface
 */
 protected $pretend = false;

 /**
 * Construct a non-caching response with a default content type of `text/html`.
 */
 public function __construct()
 {
 // Default to a non-caching page.
 // Also ensures that a Cache-control header exists.
 $this->noCache();

 // We need CSP object even if not enabled to avoid calls to non existing methods
 $this->CSP = service('csp');

 $this->cookieStore = new CookieStore([]);

 $cookie = config(CookieConfig::class);

 Cookie::setDefaults($cookie);
 Cookie::setDefaults(config('Cookie'));

 // Default to an HTML Content-Type. Devs can override if needed.
 $this->setContentType('text/html');
 $this->noCache()->setContentType('text/html');
Comment thread
michalsn marked this conversation as resolved.

 }

 /**
Expand All@@ -168,7 +157,6 @@ public function __construct()
 * @return $this
 *
 * @internal For testing purposes only.
 * @testTag only available to test code
 */
 public function pretend(bool $pretend = true)
 {
Expand Down

98 changes: 82 additions & 16 deletions
system/HTTP/ResponseTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Config\Services;
use CodeIgniter\Cookie\Cookie;
use CodeIgniter\Cookie\CookieStore;
use CodeIgniter\Cookie\Exceptions\CookieException;
Expand All@@ -21,6 +22,8 @@
use CodeIgniter\I18n\Time;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\App;
use Config\ContentSecurityPolicy as ContentSecurityPolicyConfig;
use Config\Cookie as CookieConfig;
use DateTime;
use DateTimeZone;
Expand All@@ -31,21 +34,30 @@
 * Additional methods to make a PSR-7 Response class
 * compliant with the framework's own ResponseInterface.
 *
 * @property array<int, string> $statusCodes
 * @property string|null $body
 *
 * @see https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php
 */
trait ResponseTrait
{
 /**
 * Content security policy handler
 * Content security policy handler.
 *
 * Lazily instantiated on first use via `self::getCSP()` so that the
 * ContentSecurityPolicy class is not loaded on requests that do not use CSP.
 *
 * @var ContentSecurityPolicy
 * @var ContentSecurityPolicy|null
 */
 protected $CSP;

 /**
 * CookieStore instance.
 *
 * @var CookieStore
 * Lazily instantiated on first cookie-related call so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @var CookieStore|null
 */
 protected $cookieStore;

Expand DownExpand Up@@ -77,19 +89,17 @@ trait ResponseTrait
 */
 public function setStatusCode(int $code, string $reason = '')
 {
 // Valid range?
 if ($code < 100 || $code > 599) {
 throw HTTPException::forInvalidStatusCode($code);
 }

 // Unknown and no message?
 if (! array_key_exists($code, static::$statusCodes) && ($reason === '')) {
 if (! array_key_exists($code, static::$statusCodes) && $reason === '') {
 throw HTTPException::forUnkownStatusCode($code);
 }

 $this->statusCode = $code;

 $this->reason = ($reason !== '') ? $reason : static::$statusCodes[$code];
 $this->reason = $reason !== '' ? $reason : static::$statusCodes[$code];

 return $this;
 }
Expand DownExpand Up@@ -366,8 +376,10 @@ public function setLastModified($date)
 public function send()
 {
 // If we're enforcing a Content Security Policy,
 // we need to give it a chance to build out it's headers.
 $this->CSP->finalize($this);
 // we need to give it a chance to build out its headers.
 if ($this->shouldFinalizeCsp()) {
 $this->getCSP()->finalize($this);
 }

 $this->sendHeaders();
 $this->sendCookies();
Expand All@@ -376,6 +388,44 @@ public function send()
 return $this;
 }

 /**
 * Decides whether {@see ContentSecurityPolicy::finalize()} should run for
 * this response. Keeping the CSP class unloaded on requests that do not
 * need it avoids the cost of constructing a 1000+ line service on every
 * request.
 */
 private function shouldFinalizeCsp(): bool
 {
 // Developer already touched CSP through getCSP(); respect it.
 if ($this->CSP !== null) {
 return true;
 }

 // A CSP instance has been registered (e.g., via Services::injectMock()
 // or any earlier service('csp') call) — reuse it instead of skipping.
 if (Services::has('csp')) {
 return true;
 }

 if (config(App::class)->CSPEnabled) {
 return true;
 }

 // Placeholders in the body still need to be stripped even when CSP
 // is disabled, so the body is scanned for the configured nonce tags
 // before committing to loading the full CSP class.
 $body = (string) $this->body;

 if ($body === '') {
 return false;
 }

 $cspConfig = config(ContentSecurityPolicyConfig::class);

 return str_contains($body, $cspConfig->scriptNonceTag)
 || str_contains($body, $cspConfig->styleNonceTag);
 }

 /**
 * Sends the headers of this HTTP response to the browser.
 *
Expand DownExpand Up@@ -518,8 +568,10 @@ public function setCookie(
 $httponly = null,
 $samesite = null,
 ) {
 $store = $this->getCookieStore();

 if ($name instanceof Cookie) {
 $this->cookieStore = $this->cookieStore->put($name);
 $this->cookieStore = $store->put($name);

 return $this;
 }
Expand DownExpand Up@@ -553,18 +605,23 @@ public function setCookie(
 'samesite' => $samesite ?? '',
 ]);

 $this->cookieStore = $this->cookieStore->put($cookie);
 $this->cookieStore = $store->put($cookie);

 return $this;
 }

 /**
 * Returns the `CookieStore` instance.
 *
 * Lazily instantiates the `CookieStore` on first call, so that the Cookie and
 * CookieStore classes are not loaded on requests that do not use cookies.
 *
 * @return CookieStore
 */
 public function getCookieStore()
 {
 $this->cookieStore ??= new CookieStore([]);

 return $this->cookieStore;
 }

Expand All@@ -573,9 +630,10 @@ public function getCookieStore()
 */
 public function hasCookie(string $name, ?string $value = null, string $prefix = ''): bool
 {
 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->has($name, $prefix, $value);
 return $store->has($name, $prefix, $value);
 }

 /**
Expand All@@ -588,14 +646,16 @@ public function hasCookie(string $name, ?string $value = null, string $prefix =
 */
 public function getCookie(?string $name = null, string $prefix = '')
 {
 $store = $this->getCookieStore();

 if ((string) $name === '') {
 return $this->cookieStore->display();
 return $store->display();
 }

 try {
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 return $this->cookieStore->get($name, $prefix);
 return $store->get($name, $prefix);
 } catch (CookieException $e) {
 log_message('error', (string) $e);

Expand All@@ -614,10 +674,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 return $this;
 }

 $store = $this->getCookieStore();
 $prefix = $prefix !== '' ? $prefix : Cookie::setDefaults()['prefix']; // to retain BC

 $prefixed = $prefix . $name;
 $store = $this->cookieStore;
 $found = false;

 /** @var Cookie $cookie */
Expand DownExpand Up@@ -653,6 +713,10 @@ public function deleteCookie(string $name = '', string $domain = '', string $pat
 */
 public function getCookies()
 {
 if ($this->cookieStore === null) {
 return [];
 }

 return $this->cookieStore->display();
 }

Expand All@@ -663,7 +727,7 @@ public function getCookies()
 */
 protected function sendCookies()
 {
 if ($this->pretend) {
 if ($this->pretend || $this->cookieStore === null) {
 return;
 }

Expand DownExpand Up@@ -753,6 +817,8 @@ public function download(string $filename = '', $data = '', bool $setMime = fals

 public function getCSP(): ContentSecurityPolicy
 {
 $this->CSP ??= service('csp');

 return $this->CSP;
 }
}
Loading
Loading