[4.4] Rework redirect exception#7610

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
kenjis merged 8 commits into from
Jun 29, 2023
Merged

[4.4] Rework redirect exception #7610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2fb429d
rework: RedirectException implements ResponsableInterface
iRedds Jun 23, 2023
33b7963
rework: RedirectException constructor. force_https
iRedds Jun 23, 2023
7d5b9f8
rework: RedirectException. UG and new tests
iRedds Jun 25, 2023
8a770a5
rework: RedirectException. test group
iRedds Jun 25, 2023
3e1fa64
rework: RedirectException. tests, docs and changes
iRedds Jun 27, 2023
17583a1
rework: RedirectException. changelog
iRedds Jun 27, 2023
9de0717
Update user_guide_src/source/general/errors.rst
iRedds Jun 28, 2023
abb921a
rebase
iRedds Jun 29, 2023
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
16 changes: 8 additions & 8 deletions system/CodeIgniter.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Router\Exceptions\RedirectException as DeprecatedRedirectException;
Expand DownExpand Up@@ -337,20 +338,17 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
$this->getRequestObject();
$this->getResponseObject();

$this->forceSecureAccess();

$this->spoofRequestMethod();

try {
$this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
} catch (RedirectException|DeprecatedRedirectException $e) {
} catch (ResponsableInterface|DeprecatedRedirectException $e) {
$this->outputBufferingEnd();
$logger = Services::logger();
$logger->info('REDIRECTED ROUTE at ' . $e->getMessage());
if ($e instanceof DeprecatedRedirectException) {
$e = new RedirectException($e->getMessage(), $e->getCode(), $e);
}

// If the route is a 'redirect' route, it throws
// the exception with the $to as the message
$this->response->redirect(base_url($e->getMessage()), 'auto', $e->getCode());
$this->response = $e->getResponse();
} catch (PageNotFoundException $e) {
$this->response = $this->display404errors($e);
} catch (Throwable $e) {
Expand DownExpand Up@@ -419,6 +417,8 @@ public function disableFilters(): void
*/
protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
{
$this->forceSecureAccess();

if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
return $this->response->setStatusCode(405)->setBody('Method Not Allowed');
}
Expand Down
36 changes: 20 additions & 16 deletions system/Common.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
use CodeIgniter\Files\Exceptions\FileNotFoundException;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\RequestInterface;
Expand DownExpand Up@@ -476,22 +477,24 @@ function esc($data, string $context = 'html', ?string $encoding = null)
* @param ResponseInterface $response
*
* @throws HTTPException
* @throws RedirectException
*/
function force_https(int $duration = 31_536_000, ?RequestInterface $request = null, ?ResponseInterface $response = null)
{
if ($request === null) {
$request = Services::request(null, true);
}
function force_https(
int $duration = 31_536_000,
?RequestInterface $request = null,
?ResponseInterface $response = null
) {
$request ??= Services::request();

if (! $request instanceof IncomingRequest) {
return;
}

if ($response === null) {
$response = Services::response(null, true);
}
$response ??= Services::response();

if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure())) || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'test')) {
if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure()))
|| $request->getServer('HTTPS') === 'test'
) {
return; // @codeCoverageIgnore
}

Expand DownExpand Up@@ -520,13 +523,14 @@ function force_https(int $duration = 31_536_000, ?RequestInterface $request = nu
);

// Set an HSTS header
$response->setHeader('Strict-Transport-Security', 'max-age=' . $duration);
$response->redirect($uri);
$response->sendHeaders();

if (ENVIRONMENT !== 'testing') {
exit(); // @codeCoverageIgnore
}
$response->setHeader('Strict-Transport-Security', 'max-age=' . $duration)
->redirect($uri)
->setStatusCode(307)
->setBody('')
->getCookieStore()
->clear();

throw new RedirectException($response);
}
}

Expand Down
57 changes: 56 additions & 1 deletion system/HTTP/Exceptions/RedirectException.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,17 +12,72 @@
namespace CodeIgniter\HTTP\Exceptions;

use CodeIgniter\Exceptions\HTTPExceptionInterface;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;
use Exception;
use InvalidArgumentException;
use LogicException;
use Throwable;

/**
* RedirectException
*/
class RedirectException extends Exception implements HTTPExceptionInterface
class RedirectException extends Exception implements ResponsableInterface, HTTPExceptionInterface
{
/**
* HTTP status code for redirects
*
* @var int
*/
protected $code = 302;

protected ?ResponseInterface $response = null;

/**
* @param ResponseInterface|string $message Response object or a string containing a relative URI.
* @param int $code HTTP status code to redirect if $message is a string.
*/
public function __construct($message = '', int $code = 0, ?Throwable $previous = null)
{
if (! is_string($message) && ! $message instanceof ResponseInterface) {
throw new InvalidArgumentException(
'RedirectException::__construct() first argument must be a string or ResponseInterface',
0,
$this
);
}

if ($message instanceof ResponseInterface) {
$this->response = $message;
$message = '';

if ($this->response->getHeaderLine('Location') === '' && $this->response->getHeaderLine('Refresh') === '') {
throw new LogicException(
'The Response object passed to RedirectException does not contain a redirect address.'
);
}

if ($this->response->getStatusCode() < 301 || $this->response->getStatusCode() > 308) {
$this->response->setStatusCode($this->code);
}
}

parent::__construct($message, $code, $previous);
}

public function getResponse(): ResponseInterface
{
if (null === $this->response) {
$this->response = Services::response()
->redirect(base_url($this->getMessage()), 'auto', $this->getCode());
}

Services::logger()->info(
'REDIRECTED ROUTE at '
. ($this->response->getHeaderLine('Location') ?: substr($this->response->getHeaderLine('Refresh'), 6))
);

return $this->response;
}
}
17 changes: 17 additions & 0 deletions system/HTTP/ResponsableInterface.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\HTTP;

interface ResponsableInterface
{
public function getResponse(): ResponseInterface;
}
4 changes: 1 addition & 3 deletions tests/system/CodeIgniterTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -441,9 +441,7 @@ public function testRunForceSecure()
$response = $this->getPrivateProperty($codeigniter, 'response');
$this->assertNull($response->header('Location'));

ob_start();
$codeigniter->run();
ob_get_clean();
$response = $codeigniter->run(null, true);

$this->assertSame('https://example.com/', $response->header('Location')->getValue());
}
Expand Down
19 changes: 17 additions & 2 deletions tests/system/CommonFunctionsTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use CodeIgniter\Config\BaseService;
use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Response;
Expand All@@ -35,6 +36,7 @@
use Config\Routing;
use Config\Services;
use Config\Session as SessionConfig;
use Exception;
use Kint;
use RuntimeException;
use stdClass;
Expand DownExpand Up@@ -599,10 +601,23 @@ public function testViewNotSaveData()
public function testForceHttpsNullRequestAndResponse()
{
$this->assertNull(Services::response()->header('Location'));
Services::response()->setCookie('force', 'cookie');
Services::response()->setHeader('Force', 'header');
Services::response()->setBody('default body');

try {
force_https();
} catch (Exception $e) {
$this->assertInstanceOf(RedirectException::class, $e);
$this->assertSame('https://example.com/', $e->getResponse()->header('Location')->getValue());
$this->assertFalse($e->getResponse()->hasCookie('force'));
$this->assertSame('header', $e->getResponse()->getHeaderLine('Force'));
$this->assertSame('', $e->getResponse()->getBody());
$this->assertSame(307, $e->getResponse()->getStatusCode());
}

$this->expectException(RedirectException::class);
force_https();

$this->assertSame('https://example.com/', Services::response()->header('Location')->getValue());
}

/**
Expand Down
12 changes: 8 additions & 4 deletions tests/system/ControllerTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter;

use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\Response;
Expand DownExpand Up@@ -75,10 +76,13 @@ public function testConstructorHTTPS()
$original = $_SERVER;
$_SERVER = ['HTTPS' => 'on'];
// make sure we can instantiate one
$this->controller = new class () extends Controller {
protected $forceHTTPS = 1;
};
$this->controller->initController($this->request, $this->response, $this->logger);
try {
$this->controller = new class () extends Controller {
protected $forceHTTPS = 1;
};
$this->controller->initController($this->request, $this->response, $this->logger);
} catch (RedirectException $e) {
}

$this->assertInstanceOf(Controller::class, $this->controller);
$_SERVER = $original; // restore so code coverage doesn't break
Expand Down
93 changes: 93 additions & 0 deletions tests/system/HTTP/RedirectExceptionTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\HTTP;

use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\Log\Logger;
use CodeIgniter\Test\Mock\MockLogger as LoggerConfig;
use Config\Services;
use LogicException;
use PHPUnit\Framework\TestCase;
use Tests\Support\Log\Handlers\TestHandler;

/**
* @internal
*
* @group Others
*/
final class RedirectExceptionTest extends TestCase
{
protected function setUp(): void
{
Services::reset();
Services::injectMock('logger', new Logger(new LoggerConfig()));
}

public function testResponse(): void
{
$response = (new RedirectException(
Services::response()
->redirect('redirect')
->setCookie('cookie', 'value')
->setHeader('Redirect-Header', 'value')
))->getResponse();

$this->assertSame('redirect', $response->getHeaderLine('location'));
$this->assertSame(302, $response->getStatusCode());
$this->assertSame('value', $response->getHeaderLine('Redirect-Header'));
$this->assertSame('value', $response->getCookie('cookie')->getValue());
}

public function testResponseWithoutLocation(): void
{
$this->expectException(LogicException::class);
$this->expectExceptionMessage(
'The Response object passed to RedirectException does not contain a redirect address.'
);

new RedirectException(Services::response());
}

public function testResponseWithoutStatusCode(): void
{
$response = (new RedirectException(Services::response()->setHeader('Location', 'location')))->getResponse();

$this->assertSame('location', $response->getHeaderLine('location'));
$this->assertSame(302, $response->getStatusCode());
}

public function testLoggingLocationHeader(): void
{
$uri = 'http://location';
$expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
$response = (new RedirectException(Services::response()->redirect($uri)))->getResponse();

$logs = TestHandler::getLogs();

$this->assertSame($uri, $response->getHeaderLine('Location'));
$this->assertSame('', $response->getHeaderLine('Refresh'));
$this->assertSame($expected, $logs[0]);
}

public function testLoggingRefreshHeader(): void
{
$uri = 'http://location';
$expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
$response = (new RedirectException(Services::response()->redirect($uri, 'refresh')))->getResponse();

$logs = TestHandler::getLogs();

$this->assertSame($uri, substr($response->getHeaderLine('Refresh'), 6));
$this->assertSame('', $response->getHeaderLine('Location'));
$this->assertSame($expected, $logs[0]);
}
}
7 changes: 7 additions & 0 deletions user_guide_src/source/changelogs/v4.4.0.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,7 @@ Helpers and Functions

- **Array:** Added :php:func:`array_group_by()` helper function to group data
values together. Supports dot-notation syntax.
- **Common:** :php:func:`force_https()` no longer terminates the application, but throws a ``RedirectException``.

Others
======
Expand All@@ -123,6 +124,8 @@ Others
- **Request:** Added ``IncomingRequest::setValidLocales()`` method to set valid locales.
- **Table:** Added ``Table::setSyncRowsWithHeading()`` method to synchronize row columns with headings. See :ref:`table-sync-rows-with-headings` for details.
- **Error Handling:** Now you can use :ref:`custom-exception-handlers`.
- **RedirectException:** can also take an object that implements ResponseInterface as its first argument.
- **RedirectException:** implements ResponsableInterface.

Message Changes
***************
Expand All@@ -146,6 +149,10 @@ Changes
this restriction has been removed.
- **RouteCollection:** The array structure of the protected property ``$routes``
has been modified for performance.
- **HSTS:** Now :php:func:`force_https()` or
``Config\App::$forceGlobalSecureRequests = true`` sets the HTTP status code 307,
which allows the HTTP request method to be preserved after the redirect.
In previous versions, it was 302.

Deprecations
************
Expand Down
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
[4.4] Rework redirect exception#7610

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

kenjis
merged 8 commits into

from

Jun 29, 2023
 Merged


[4.4] Rework redirect exception
#7610
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2fb429d

rework: RedirectException implements ResponsableInterface


iRedds Jun 23, 2023
33b7963

rework: RedirectException constructor. force_https


iRedds Jun 23, 2023
7d5b9f8

rework: RedirectException. UG and new tests


iRedds Jun 25, 2023
8a770a5

rework: RedirectException. test group


iRedds Jun 25, 2023
3e1fa64

rework: RedirectException. tests, docs and changes


iRedds Jun 27, 2023
17583a1

rework: RedirectException. changelog


iRedds Jun 27, 2023
9de0717

Update user_guide_src/source/general/errors.rst


iRedds Jun 28, 2023
abb921a

rebase


iRedds Jun 29, 2023

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


16 changes: 8 additions & 8 deletions
system/CodeIgniter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Router\Exceptions\RedirectException as DeprecatedRedirectException;
Expand DownExpand Up@@ -337,20 +338,17 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
 $this->getRequestObject();
 $this->getResponseObject();

 $this->forceSecureAccess();

 $this->spoofRequestMethod();

 try {
 $this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
 } catch (RedirectException|DeprecatedRedirectException $e) {
 } catch (ResponsableInterface|DeprecatedRedirectException $e) {
 $this->outputBufferingEnd();
 $logger = Services::logger();
 $logger->info('REDIRECTED ROUTE at ' . $e->getMessage());
 if ($e instanceof DeprecatedRedirectException) {
 $e = new RedirectException($e->getMessage(), $e->getCode(), $e);
 }

 // If the route is a 'redirect' route, it throws
 // the exception with the $to as the message
 $this->response->redirect(base_url($e->getMessage()), 'auto', $e->getCode());
 $this->response = $e->getResponse();
 } catch (PageNotFoundException $e) {
 $this->response = $this->display404errors($e);
 } catch (Throwable $e) {
Expand DownExpand Up@@ -419,6 +417,8 @@ public function disableFilters(): void
 */
 protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
 {
 $this->forceSecureAccess();

 if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
 return $this->response->setStatusCode(405)->setBody('Method Not Allowed');
 }
Expand Down

36 changes: 20 additions & 16 deletions
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
use CodeIgniter\Files\Exceptions\FileNotFoundException;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\RequestInterface;
Expand DownExpand Up@@ -476,22 +477,24 @@ function esc($data, string $context = 'html', ?string $encoding = null)
 * @param ResponseInterface $response
 *
 * @throws HTTPException
 * @throws RedirectException
 */
 function force_https(int $duration = 31_536_000, ?RequestInterface $request = null, ?ResponseInterface $response = null)
 {
 if ($request === null) {
 $request = Services::request(null, true);
 }
 function force_https(
 int $duration = 31_536_000,
 ?RequestInterface $request = null,
 ?ResponseInterface $response = null
 ) {
 $request ??= Services::request();

 if (! $request instanceof IncomingRequest) {
 return;
 }

 if ($response === null) {
 $response = Services::response(null, true);
 }
 $response ??= Services::response();

 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure())) || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'test')) {
 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure()))
 || $request->getServer('HTTPS') === 'test'
 ) {
 return; // @codeCoverageIgnore
 }

Expand DownExpand Up@@ -520,13 +523,14 @@ function force_https(int $duration = 31_536_000, ?RequestInterface $request = nu
 );

 // Set an HSTS header
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration);
 $response->redirect($uri);
 $response->sendHeaders();

 if (ENVIRONMENT !== 'testing') {
 exit(); // @codeCoverageIgnore
 }
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration)
 ->redirect($uri)
 ->setStatusCode(307)
 ->setBody('')
 ->getCookieStore()
 ->clear();

 throw new RedirectException($response);
 }
}

Expand Down

57 changes: 56 additions & 1 deletion
system/HTTP/Exceptions/RedirectException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,17 +12,72 @@
namespace CodeIgniter\HTTP\Exceptions;

use CodeIgniter\Exceptions\HTTPExceptionInterface;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;
use Exception;
use InvalidArgumentException;
use LogicException;
use Throwable;

/**
 * RedirectException
 */
class RedirectException extends Exception implements HTTPExceptionInterface
class RedirectException extends Exception implements ResponsableInterface, HTTPExceptionInterface
{
 /**
 * HTTP status code for redirects
 *
 * @var int
 */
 protected $code = 302;

 protected ?ResponseInterface $response = null;

 /**
 * @param ResponseInterface|string $message Response object or a string containing a relative URI.
 * @param int $code HTTP status code to redirect if $message is a string.
 */
 public function __construct($message = '', int $code = 0, ?Throwable $previous = null)
 {
 if (! is_string($message) && ! $message instanceof ResponseInterface) {
 throw new InvalidArgumentException(
 'RedirectException::__construct() first argument must be a string or ResponseInterface',
 0,
 $this
 );
 }

 if ($message instanceof ResponseInterface) {
 $this->response = $message;
 $message = '';

 if ($this->response->getHeaderLine('Location') === '' && $this->response->getHeaderLine('Refresh') === '') {
 throw new LogicException(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );
 }

 if ($this->response->getStatusCode() < 301 || $this->response->getStatusCode() > 308) {
 $this->response->setStatusCode($this->code);
 }
 }

 parent::__construct($message, $code, $previous);
 }

 public function getResponse(): ResponseInterface
 {
 if (null === $this->response) {
 $this->response = Services::response()
 ->redirect(base_url($this->getMessage()), 'auto', $this->getCode());
 }

 Services::logger()->info(
 'REDIRECTED ROUTE at '
 . ($this->response->getHeaderLine('Location') ?: substr($this->response->getHeaderLine('Refresh'), 6))
 );

 return $this->response;
 }
}

17 changes: 17 additions & 0 deletions
system/HTTP/ResponsableInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

interface ResponsableInterface
{
 public function getResponse(): ResponseInterface;
}

4 changes: 1 addition & 3 deletions
tests/system/CodeIgniterTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,9 +441,7 @@ public function testRunForceSecure()
 $response = $this->getPrivateProperty($codeigniter, 'response');
 $this->assertNull($response->header('Location'));

 ob_start();
 $codeigniter->run();
 ob_get_clean();
 $response = $codeigniter->run(null, true);

 $this->assertSame('https://example.com/', $response->header('Location')->getValue());
 }
Expand Down

19 changes: 17 additions & 2 deletions
tests/system/CommonFunctionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use CodeIgniter\Config\BaseService;
use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Response;
Expand All@@ -35,6 +36,7 @@
use Config\Routing;
use Config\Services;
use Config\Session as SessionConfig;
use Exception;
use Kint;
use RuntimeException;
use stdClass;
Expand DownExpand Up@@ -599,10 +601,23 @@ public function testViewNotSaveData()
 public function testForceHttpsNullRequestAndResponse()
 {
 $this->assertNull(Services::response()->header('Location'));
 Services::response()->setCookie('force', 'cookie');
 Services::response()->setHeader('Force', 'header');
 Services::response()->setBody('default body');

 try {
 force_https();
 } catch (Exception $e) {
 $this->assertInstanceOf(RedirectException::class, $e);
 $this->assertSame('https://example.com/', $e->getResponse()->header('Location')->getValue());
 $this->assertFalse($e->getResponse()->hasCookie('force'));
 $this->assertSame('header', $e->getResponse()->getHeaderLine('Force'));
 $this->assertSame('', $e->getResponse()->getBody());
 $this->assertSame(307, $e->getResponse()->getStatusCode());
 }

 $this->expectException(RedirectException::class);
 force_https();

 $this->assertSame('https://example.com/', Services::response()->header('Location')->getValue());
 }

 /**
Expand Down

12 changes: 8 additions & 4 deletions
tests/system/ControllerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter;

use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\Response;
Expand DownExpand Up@@ -75,10 +76,13 @@ public function testConstructorHTTPS()
 $original = $_SERVER;
 $_SERVER = ['HTTPS' => 'on'];
 // make sure we can instantiate one
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 try {
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 } catch (RedirectException $e) {
 }

 $this->assertInstanceOf(Controller::class, $this->controller);
 $_SERVER = $original; // restore so code coverage doesn't break
Expand Down

93 changes: 93 additions & 0 deletions
tests/system/HTTP/RedirectExceptionTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\Log\Logger;
use CodeIgniter\Test\Mock\MockLogger as LoggerConfig;
use Config\Services;
use LogicException;
use PHPUnit\Framework\TestCase;
use Tests\Support\Log\Handlers\TestHandler;

/**
 * @internal
 *
 * @group Others
 */
final class RedirectExceptionTest extends TestCase
{
 protected function setUp(): void
 {
 Services::reset();
 Services::injectMock('logger', new Logger(new LoggerConfig()));
 }

 public function testResponse(): void
 {
 $response = (new RedirectException(
 Services::response()
 ->redirect('redirect')
 ->setCookie('cookie', 'value')
 ->setHeader('Redirect-Header', 'value')
 ))->getResponse();

 $this->assertSame('redirect', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 $this->assertSame('value', $response->getHeaderLine('Redirect-Header'));
 $this->assertSame('value', $response->getCookie('cookie')->getValue());
 }

 public function testResponseWithoutLocation(): void
 {
 $this->expectException(LogicException::class);
 $this->expectExceptionMessage(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );

 new RedirectException(Services::response());
 }

 public function testResponseWithoutStatusCode(): void
 {
 $response = (new RedirectException(Services::response()->setHeader('Location', 'location')))->getResponse();

 $this->assertSame('location', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 }

 public function testLoggingLocationHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri)))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, $response->getHeaderLine('Location'));
 $this->assertSame('', $response->getHeaderLine('Refresh'));
 $this->assertSame($expected, $logs[0]);
 }

 public function testLoggingRefreshHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri, 'refresh')))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, substr($response->getHeaderLine('Refresh'), 6));
 $this->assertSame('', $response->getHeaderLine('Location'));
 $this->assertSame($expected, $logs[0]);
 }
}

7 changes: 7 additions & 0 deletions
user_guide_src/source/changelogs/v4.4.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,7 @@ Helpers and Functions

- **Array:** Added :php:func:`array_group_by()` helper function to group data
 values together. Supports dot-notation syntax.
- **Common:** :php:func:`force_https()` no longer terminates the application, but throws a ``RedirectException``.

Others
======
Expand All@@ -123,6 +124,8 @@ Others
- **Request:** Added ``IncomingRequest::setValidLocales()`` method to set valid locales.
- **Table:** Added ``Table::setSyncRowsWithHeading()`` method to synchronize row columns with headings. See :ref:`table-sync-rows-with-headings` for details.
- **Error Handling:** Now you can use :ref:`custom-exception-handlers`.
- **RedirectException:** can also take an object that implements ResponseInterface as its first argument.
- **RedirectException:** implements ResponsableInterface.

Message Changes
***************
Expand All@@ -146,6 +149,10 @@ Changes
 this restriction has been removed.
- **RouteCollection:** The array structure of the protected property ``$routes``
 has been modified for performance.
- **HSTS:** Now :php:func:`force_https()` or
 ``Config\App::$forceGlobalSecureRequests = true`` sets the HTTP status code 307,
 which allows the HTTP request method to be preserved after the redirect.
 In previous versions, it was 302.

Deprecations
************
Expand Down
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
[4.4] Rework redirect exception#7610

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

kenjis
merged 8 commits into

from

Jun 29, 2023
 Merged


[4.4] Rework redirect exception
#7610
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2fb429d

rework: RedirectException implements ResponsableInterface


iRedds Jun 23, 2023
33b7963

rework: RedirectException constructor. force_https


iRedds Jun 23, 2023
7d5b9f8

rework: RedirectException. UG and new tests


iRedds Jun 25, 2023
8a770a5

rework: RedirectException. test group


iRedds Jun 25, 2023
3e1fa64

rework: RedirectException. tests, docs and changes


iRedds Jun 27, 2023
17583a1

rework: RedirectException. changelog


iRedds Jun 27, 2023
9de0717

Update user_guide_src/source/general/errors.rst


iRedds Jun 28, 2023
abb921a

rebase


iRedds Jun 29, 2023

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


16 changes: 8 additions & 8 deletions
system/CodeIgniter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Router\Exceptions\RedirectException as DeprecatedRedirectException;
Expand DownExpand Up@@ -337,20 +338,17 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
 $this->getRequestObject();
 $this->getResponseObject();

 $this->forceSecureAccess();

 $this->spoofRequestMethod();

 try {
 $this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
 } catch (RedirectException|DeprecatedRedirectException $e) {
 } catch (ResponsableInterface|DeprecatedRedirectException $e) {
 $this->outputBufferingEnd();
 $logger = Services::logger();
 $logger->info('REDIRECTED ROUTE at ' . $e->getMessage());
 if ($e instanceof DeprecatedRedirectException) {
 $e = new RedirectException($e->getMessage(), $e->getCode(), $e);
 }

 // If the route is a 'redirect' route, it throws
 // the exception with the $to as the message
 $this->response->redirect(base_url($e->getMessage()), 'auto', $e->getCode());
 $this->response = $e->getResponse();
 } catch (PageNotFoundException $e) {
 $this->response = $this->display404errors($e);
 } catch (Throwable $e) {
Expand DownExpand Up@@ -419,6 +417,8 @@ public function disableFilters(): void
 */
 protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
 {
 $this->forceSecureAccess();

 if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
 return $this->response->setStatusCode(405)->setBody('Method Not Allowed');
 }
Expand Down

36 changes: 20 additions & 16 deletions
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
use CodeIgniter\Files\Exceptions\FileNotFoundException;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\RequestInterface;
Expand DownExpand Up@@ -476,22 +477,24 @@ function esc($data, string $context = 'html', ?string $encoding = null)
 * @param ResponseInterface $response
 *
 * @throws HTTPException
 * @throws RedirectException
 */
 function force_https(int $duration = 31_536_000, ?RequestInterface $request = null, ?ResponseInterface $response = null)
 {
 if ($request === null) {
 $request = Services::request(null, true);
 }
 function force_https(
 int $duration = 31_536_000,
 ?RequestInterface $request = null,
 ?ResponseInterface $response = null
 ) {
 $request ??= Services::request();

 if (! $request instanceof IncomingRequest) {
 return;
 }

 if ($response === null) {
 $response = Services::response(null, true);
 }
 $response ??= Services::response();

 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure())) || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'test')) {
 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure()))
 || $request->getServer('HTTPS') === 'test'
 ) {
 return; // @codeCoverageIgnore
 }

Expand DownExpand Up@@ -520,13 +523,14 @@ function force_https(int $duration = 31_536_000, ?RequestInterface $request = nu
 );

 // Set an HSTS header
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration);
 $response->redirect($uri);
 $response->sendHeaders();

 if (ENVIRONMENT !== 'testing') {
 exit(); // @codeCoverageIgnore
 }
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration)
 ->redirect($uri)
 ->setStatusCode(307)
 ->setBody('')
 ->getCookieStore()
 ->clear();

 throw new RedirectException($response);
 }
}

Expand Down

57 changes: 56 additions & 1 deletion
system/HTTP/Exceptions/RedirectException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,17 +12,72 @@
namespace CodeIgniter\HTTP\Exceptions;

use CodeIgniter\Exceptions\HTTPExceptionInterface;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;
use Exception;
use InvalidArgumentException;
use LogicException;
use Throwable;

/**
 * RedirectException
 */
class RedirectException extends Exception implements HTTPExceptionInterface
class RedirectException extends Exception implements ResponsableInterface, HTTPExceptionInterface
{
 /**
 * HTTP status code for redirects
 *
 * @var int
 */
 protected $code = 302;

 protected ?ResponseInterface $response = null;

 /**
 * @param ResponseInterface|string $message Response object or a string containing a relative URI.
 * @param int $code HTTP status code to redirect if $message is a string.
 */
 public function __construct($message = '', int $code = 0, ?Throwable $previous = null)
 {
 if (! is_string($message) && ! $message instanceof ResponseInterface) {
 throw new InvalidArgumentException(
 'RedirectException::__construct() first argument must be a string or ResponseInterface',
 0,
 $this
 );
 }

 if ($message instanceof ResponseInterface) {
 $this->response = $message;
 $message = '';

 if ($this->response->getHeaderLine('Location') === '' && $this->response->getHeaderLine('Refresh') === '') {
 throw new LogicException(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );
 }

 if ($this->response->getStatusCode() < 301 || $this->response->getStatusCode() > 308) {
 $this->response->setStatusCode($this->code);
 }
 }

 parent::__construct($message, $code, $previous);
 }

 public function getResponse(): ResponseInterface
 {
 if (null === $this->response) {
 $this->response = Services::response()
 ->redirect(base_url($this->getMessage()), 'auto', $this->getCode());
 }

 Services::logger()->info(
 'REDIRECTED ROUTE at '
 . ($this->response->getHeaderLine('Location') ?: substr($this->response->getHeaderLine('Refresh'), 6))
 );

 return $this->response;
 }
}

17 changes: 17 additions & 0 deletions
system/HTTP/ResponsableInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

interface ResponsableInterface
{
 public function getResponse(): ResponseInterface;
}

4 changes: 1 addition & 3 deletions
tests/system/CodeIgniterTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,9 +441,7 @@ public function testRunForceSecure()
 $response = $this->getPrivateProperty($codeigniter, 'response');
 $this->assertNull($response->header('Location'));

 ob_start();
 $codeigniter->run();
 ob_get_clean();
 $response = $codeigniter->run(null, true);

 $this->assertSame('https://example.com/', $response->header('Location')->getValue());
 }
Expand Down

19 changes: 17 additions & 2 deletions
tests/system/CommonFunctionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use CodeIgniter\Config\BaseService;
use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Response;
Expand All@@ -35,6 +36,7 @@
use Config\Routing;
use Config\Services;
use Config\Session as SessionConfig;
use Exception;
use Kint;
use RuntimeException;
use stdClass;
Expand DownExpand Up@@ -599,10 +601,23 @@ public function testViewNotSaveData()
 public function testForceHttpsNullRequestAndResponse()
 {
 $this->assertNull(Services::response()->header('Location'));
 Services::response()->setCookie('force', 'cookie');
 Services::response()->setHeader('Force', 'header');
 Services::response()->setBody('default body');

 try {
 force_https();
 } catch (Exception $e) {
 $this->assertInstanceOf(RedirectException::class, $e);
 $this->assertSame('https://example.com/', $e->getResponse()->header('Location')->getValue());
 $this->assertFalse($e->getResponse()->hasCookie('force'));
 $this->assertSame('header', $e->getResponse()->getHeaderLine('Force'));
 $this->assertSame('', $e->getResponse()->getBody());
 $this->assertSame(307, $e->getResponse()->getStatusCode());
 }

 $this->expectException(RedirectException::class);
 force_https();

 $this->assertSame('https://example.com/', Services::response()->header('Location')->getValue());
 }

 /**
Expand Down

12 changes: 8 additions & 4 deletions
tests/system/ControllerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter;

use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\Response;
Expand DownExpand Up@@ -75,10 +76,13 @@ public function testConstructorHTTPS()
 $original = $_SERVER;
 $_SERVER = ['HTTPS' => 'on'];
 // make sure we can instantiate one
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 try {
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 } catch (RedirectException $e) {
 }

 $this->assertInstanceOf(Controller::class, $this->controller);
 $_SERVER = $original; // restore so code coverage doesn't break
Expand Down

93 changes: 93 additions & 0 deletions
tests/system/HTTP/RedirectExceptionTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\Log\Logger;
use CodeIgniter\Test\Mock\MockLogger as LoggerConfig;
use Config\Services;
use LogicException;
use PHPUnit\Framework\TestCase;
use Tests\Support\Log\Handlers\TestHandler;

/**
 * @internal
 *
 * @group Others
 */
final class RedirectExceptionTest extends TestCase
{
 protected function setUp(): void
 {
 Services::reset();
 Services::injectMock('logger', new Logger(new LoggerConfig()));
 }

 public function testResponse(): void
 {
 $response = (new RedirectException(
 Services::response()
 ->redirect('redirect')
 ->setCookie('cookie', 'value')
 ->setHeader('Redirect-Header', 'value')
 ))->getResponse();

 $this->assertSame('redirect', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 $this->assertSame('value', $response->getHeaderLine('Redirect-Header'));
 $this->assertSame('value', $response->getCookie('cookie')->getValue());
 }

 public function testResponseWithoutLocation(): void
 {
 $this->expectException(LogicException::class);
 $this->expectExceptionMessage(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );

 new RedirectException(Services::response());
 }

 public function testResponseWithoutStatusCode(): void
 {
 $response = (new RedirectException(Services::response()->setHeader('Location', 'location')))->getResponse();

 $this->assertSame('location', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 }

 public function testLoggingLocationHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri)))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, $response->getHeaderLine('Location'));
 $this->assertSame('', $response->getHeaderLine('Refresh'));
 $this->assertSame($expected, $logs[0]);
 }

 public function testLoggingRefreshHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri, 'refresh')))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, substr($response->getHeaderLine('Refresh'), 6));
 $this->assertSame('', $response->getHeaderLine('Location'));
 $this->assertSame($expected, $logs[0]);
 }
}

7 changes: 7 additions & 0 deletions
user_guide_src/source/changelogs/v4.4.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,7 @@ Helpers and Functions

- **Array:** Added :php:func:`array_group_by()` helper function to group data
 values together. Supports dot-notation syntax.
- **Common:** :php:func:`force_https()` no longer terminates the application, but throws a ``RedirectException``.

Others
======
Expand All@@ -123,6 +124,8 @@ Others
- **Request:** Added ``IncomingRequest::setValidLocales()`` method to set valid locales.
- **Table:** Added ``Table::setSyncRowsWithHeading()`` method to synchronize row columns with headings. See :ref:`table-sync-rows-with-headings` for details.
- **Error Handling:** Now you can use :ref:`custom-exception-handlers`.
- **RedirectException:** can also take an object that implements ResponseInterface as its first argument.
- **RedirectException:** implements ResponsableInterface.

Message Changes
***************
Expand All@@ -146,6 +149,10 @@ Changes
 this restriction has been removed.
- **RouteCollection:** The array structure of the protected property ``$routes``
 has been modified for performance.
- **HSTS:** Now :php:func:`force_https()` or
 ``Config\App::$forceGlobalSecureRequests = true`` sets the HTTP status code 307,
 which allows the HTTP request method to be preserved after the redirect.
 In previous versions, it was 302.

Deprecations
************
Expand Down
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
[4.4] Rework redirect exception#7610

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

kenjis
merged 8 commits into

from

Jun 29, 2023
 Merged


[4.4] Rework redirect exception
#7610
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2fb429d

rework: RedirectException implements ResponsableInterface


iRedds Jun 23, 2023
33b7963

rework: RedirectException constructor. force_https


iRedds Jun 23, 2023
7d5b9f8

rework: RedirectException. UG and new tests


iRedds Jun 25, 2023
8a770a5

rework: RedirectException. test group


iRedds Jun 25, 2023
3e1fa64

rework: RedirectException. tests, docs and changes


iRedds Jun 27, 2023
17583a1

rework: RedirectException. changelog


iRedds Jun 27, 2023
9de0717

Update user_guide_src/source/general/errors.rst


iRedds Jun 28, 2023
abb921a

rebase


iRedds Jun 29, 2023

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


16 changes: 8 additions & 8 deletions
system/CodeIgniter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Router\Exceptions\RedirectException as DeprecatedRedirectException;
Expand DownExpand Up@@ -337,20 +338,17 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
 $this->getRequestObject();
 $this->getResponseObject();

 $this->forceSecureAccess();

 $this->spoofRequestMethod();

 try {
 $this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
 } catch (RedirectException|DeprecatedRedirectException $e) {
 } catch (ResponsableInterface|DeprecatedRedirectException $e) {
 $this->outputBufferingEnd();
 $logger = Services::logger();
 $logger->info('REDIRECTED ROUTE at ' . $e->getMessage());
 if ($e instanceof DeprecatedRedirectException) {
 $e = new RedirectException($e->getMessage(), $e->getCode(), $e);
 }

 // If the route is a 'redirect' route, it throws
 // the exception with the $to as the message
 $this->response->redirect(base_url($e->getMessage()), 'auto', $e->getCode());
 $this->response = $e->getResponse();
 } catch (PageNotFoundException $e) {
 $this->response = $this->display404errors($e);
 } catch (Throwable $e) {
Expand DownExpand Up@@ -419,6 +417,8 @@ public function disableFilters(): void
 */
 protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
 {
 $this->forceSecureAccess();

 if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
 return $this->response->setStatusCode(405)->setBody('Method Not Allowed');
 }
Expand Down

36 changes: 20 additions & 16 deletions
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
use CodeIgniter\Files\Exceptions\FileNotFoundException;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\RequestInterface;
Expand DownExpand Up@@ -476,22 +477,24 @@ function esc($data, string $context = 'html', ?string $encoding = null)
 * @param ResponseInterface $response
 *
 * @throws HTTPException
 * @throws RedirectException
 */
 function force_https(int $duration = 31_536_000, ?RequestInterface $request = null, ?ResponseInterface $response = null)
 {
 if ($request === null) {
 $request = Services::request(null, true);
 }
 function force_https(
 int $duration = 31_536_000,
 ?RequestInterface $request = null,
 ?ResponseInterface $response = null
 ) {
 $request ??= Services::request();

 if (! $request instanceof IncomingRequest) {
 return;
 }

 if ($response === null) {
 $response = Services::response(null, true);
 }
 $response ??= Services::response();

 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure())) || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'test')) {
 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure()))
 || $request->getServer('HTTPS') === 'test'
 ) {
 return; // @codeCoverageIgnore
 }

Expand DownExpand Up@@ -520,13 +523,14 @@ function force_https(int $duration = 31_536_000, ?RequestInterface $request = nu
 );

 // Set an HSTS header
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration);
 $response->redirect($uri);
 $response->sendHeaders();

 if (ENVIRONMENT !== 'testing') {
 exit(); // @codeCoverageIgnore
 }
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration)
 ->redirect($uri)
 ->setStatusCode(307)
 ->setBody('')
 ->getCookieStore()
 ->clear();

 throw new RedirectException($response);
 }
}

Expand Down

57 changes: 56 additions & 1 deletion
system/HTTP/Exceptions/RedirectException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,17 +12,72 @@
namespace CodeIgniter\HTTP\Exceptions;

use CodeIgniter\Exceptions\HTTPExceptionInterface;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;
use Exception;
use InvalidArgumentException;
use LogicException;
use Throwable;

/**
 * RedirectException
 */
class RedirectException extends Exception implements HTTPExceptionInterface
class RedirectException extends Exception implements ResponsableInterface, HTTPExceptionInterface
{
 /**
 * HTTP status code for redirects
 *
 * @var int
 */
 protected $code = 302;

 protected ?ResponseInterface $response = null;

 /**
 * @param ResponseInterface|string $message Response object or a string containing a relative URI.
 * @param int $code HTTP status code to redirect if $message is a string.
 */
 public function __construct($message = '', int $code = 0, ?Throwable $previous = null)
 {
 if (! is_string($message) && ! $message instanceof ResponseInterface) {
 throw new InvalidArgumentException(
 'RedirectException::__construct() first argument must be a string or ResponseInterface',
 0,
 $this
 );
 }

 if ($message instanceof ResponseInterface) {
 $this->response = $message;
 $message = '';

 if ($this->response->getHeaderLine('Location') === '' && $this->response->getHeaderLine('Refresh') === '') {
 throw new LogicException(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );
 }

 if ($this->response->getStatusCode() < 301 || $this->response->getStatusCode() > 308) {
 $this->response->setStatusCode($this->code);
 }
 }

 parent::__construct($message, $code, $previous);
 }

 public function getResponse(): ResponseInterface
 {
 if (null === $this->response) {
 $this->response = Services::response()
 ->redirect(base_url($this->getMessage()), 'auto', $this->getCode());
 }

 Services::logger()->info(
 'REDIRECTED ROUTE at '
 . ($this->response->getHeaderLine('Location') ?: substr($this->response->getHeaderLine('Refresh'), 6))
 );

 return $this->response;
 }
}

17 changes: 17 additions & 0 deletions
system/HTTP/ResponsableInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

interface ResponsableInterface
{
 public function getResponse(): ResponseInterface;
}

4 changes: 1 addition & 3 deletions
tests/system/CodeIgniterTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,9 +441,7 @@ public function testRunForceSecure()
 $response = $this->getPrivateProperty($codeigniter, 'response');
 $this->assertNull($response->header('Location'));

 ob_start();
 $codeigniter->run();
 ob_get_clean();
 $response = $codeigniter->run(null, true);

 $this->assertSame('https://example.com/', $response->header('Location')->getValue());
 }
Expand Down

19 changes: 17 additions & 2 deletions
tests/system/CommonFunctionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use CodeIgniter\Config\BaseService;
use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Response;
Expand All@@ -35,6 +36,7 @@
use Config\Routing;
use Config\Services;
use Config\Session as SessionConfig;
use Exception;
use Kint;
use RuntimeException;
use stdClass;
Expand DownExpand Up@@ -599,10 +601,23 @@ public function testViewNotSaveData()
 public function testForceHttpsNullRequestAndResponse()
 {
 $this->assertNull(Services::response()->header('Location'));
 Services::response()->setCookie('force', 'cookie');
 Services::response()->setHeader('Force', 'header');
 Services::response()->setBody('default body');

 try {
 force_https();
 } catch (Exception $e) {
 $this->assertInstanceOf(RedirectException::class, $e);
 $this->assertSame('https://example.com/', $e->getResponse()->header('Location')->getValue());
 $this->assertFalse($e->getResponse()->hasCookie('force'));
 $this->assertSame('header', $e->getResponse()->getHeaderLine('Force'));
 $this->assertSame('', $e->getResponse()->getBody());
 $this->assertSame(307, $e->getResponse()->getStatusCode());
 }

 $this->expectException(RedirectException::class);
 force_https();

 $this->assertSame('https://example.com/', Services::response()->header('Location')->getValue());
 }

 /**
Expand Down

12 changes: 8 additions & 4 deletions
tests/system/ControllerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter;

use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\Response;
Expand DownExpand Up@@ -75,10 +76,13 @@ public function testConstructorHTTPS()
 $original = $_SERVER;
 $_SERVER = ['HTTPS' => 'on'];
 // make sure we can instantiate one
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 try {
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 } catch (RedirectException $e) {
 }

 $this->assertInstanceOf(Controller::class, $this->controller);
 $_SERVER = $original; // restore so code coverage doesn't break
Expand Down

93 changes: 93 additions & 0 deletions
tests/system/HTTP/RedirectExceptionTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\Log\Logger;
use CodeIgniter\Test\Mock\MockLogger as LoggerConfig;
use Config\Services;
use LogicException;
use PHPUnit\Framework\TestCase;
use Tests\Support\Log\Handlers\TestHandler;

/**
 * @internal
 *
 * @group Others
 */
final class RedirectExceptionTest extends TestCase
{
 protected function setUp(): void
 {
 Services::reset();
 Services::injectMock('logger', new Logger(new LoggerConfig()));
 }

 public function testResponse(): void
 {
 $response = (new RedirectException(
 Services::response()
 ->redirect('redirect')
 ->setCookie('cookie', 'value')
 ->setHeader('Redirect-Header', 'value')
 ))->getResponse();

 $this->assertSame('redirect', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 $this->assertSame('value', $response->getHeaderLine('Redirect-Header'));
 $this->assertSame('value', $response->getCookie('cookie')->getValue());
 }

 public function testResponseWithoutLocation(): void
 {
 $this->expectException(LogicException::class);
 $this->expectExceptionMessage(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );

 new RedirectException(Services::response());
 }

 public function testResponseWithoutStatusCode(): void
 {
 $response = (new RedirectException(Services::response()->setHeader('Location', 'location')))->getResponse();

 $this->assertSame('location', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 }

 public function testLoggingLocationHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri)))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, $response->getHeaderLine('Location'));
 $this->assertSame('', $response->getHeaderLine('Refresh'));
 $this->assertSame($expected, $logs[0]);
 }

 public function testLoggingRefreshHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri, 'refresh')))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, substr($response->getHeaderLine('Refresh'), 6));
 $this->assertSame('', $response->getHeaderLine('Location'));
 $this->assertSame($expected, $logs[0]);
 }
}

7 changes: 7 additions & 0 deletions
user_guide_src/source/changelogs/v4.4.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,7 @@ Helpers and Functions

- **Array:** Added :php:func:`array_group_by()` helper function to group data
 values together. Supports dot-notation syntax.
- **Common:** :php:func:`force_https()` no longer terminates the application, but throws a ``RedirectException``.

Others
======
Expand All@@ -123,6 +124,8 @@ Others
- **Request:** Added ``IncomingRequest::setValidLocales()`` method to set valid locales.
- **Table:** Added ``Table::setSyncRowsWithHeading()`` method to synchronize row columns with headings. See :ref:`table-sync-rows-with-headings` for details.
- **Error Handling:** Now you can use :ref:`custom-exception-handlers`.
- **RedirectException:** can also take an object that implements ResponseInterface as its first argument.
- **RedirectException:** implements ResponsableInterface.

Message Changes
***************
Expand All@@ -146,6 +149,10 @@ Changes
 this restriction has been removed.
- **RouteCollection:** The array structure of the protected property ``$routes``
 has been modified for performance.
- **HSTS:** Now :php:func:`force_https()` or
 ``Config\App::$forceGlobalSecureRequests = true`` sets the HTTP status code 307,
 which allows the HTTP request method to be preserved after the redirect.
 In previous versions, it was 302.

Deprecations
************
Expand Down
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
[4.4] Rework redirect exception#7610

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

kenjis
merged 8 commits into

from

Jun 29, 2023
 Merged


[4.4] Rework redirect exception
#7610
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2fb429d

rework: RedirectException implements ResponsableInterface


iRedds Jun 23, 2023
33b7963

rework: RedirectException constructor. force_https


iRedds Jun 23, 2023
7d5b9f8

rework: RedirectException. UG and new tests


iRedds Jun 25, 2023
8a770a5

rework: RedirectException. test group


iRedds Jun 25, 2023
3e1fa64

rework: RedirectException. tests, docs and changes


iRedds Jun 27, 2023
17583a1

rework: RedirectException. changelog


iRedds Jun 27, 2023
9de0717

Update user_guide_src/source/general/errors.rst


iRedds Jun 28, 2023
abb921a

rebase


iRedds Jun 29, 2023

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


16 changes: 8 additions & 8 deletions
system/CodeIgniter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Router\Exceptions\RedirectException as DeprecatedRedirectException;
Expand DownExpand Up@@ -337,20 +338,17 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
 $this->getRequestObject();
 $this->getResponseObject();

 $this->forceSecureAccess();

 $this->spoofRequestMethod();

 try {
 $this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
 } catch (RedirectException|DeprecatedRedirectException $e) {
 } catch (ResponsableInterface|DeprecatedRedirectException $e) {
 $this->outputBufferingEnd();
 $logger = Services::logger();
 $logger->info('REDIRECTED ROUTE at ' . $e->getMessage());
 if ($e instanceof DeprecatedRedirectException) {
 $e = new RedirectException($e->getMessage(), $e->getCode(), $e);
 }

 // If the route is a 'redirect' route, it throws
 // the exception with the $to as the message
 $this->response->redirect(base_url($e->getMessage()), 'auto', $e->getCode());
 $this->response = $e->getResponse();
 } catch (PageNotFoundException $e) {
 $this->response = $this->display404errors($e);
 } catch (Throwable $e) {
Expand DownExpand Up@@ -419,6 +417,8 @@ public function disableFilters(): void
 */
 protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
 {
 $this->forceSecureAccess();

 if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
 return $this->response->setStatusCode(405)->setBody('Method Not Allowed');
 }
Expand Down

36 changes: 20 additions & 16 deletions
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
use CodeIgniter\Files\Exceptions\FileNotFoundException;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\RequestInterface;
Expand DownExpand Up@@ -476,22 +477,24 @@ function esc($data, string $context = 'html', ?string $encoding = null)
 * @param ResponseInterface $response
 *
 * @throws HTTPException
 * @throws RedirectException
 */
 function force_https(int $duration = 31_536_000, ?RequestInterface $request = null, ?ResponseInterface $response = null)
 {
 if ($request === null) {
 $request = Services::request(null, true);
 }
 function force_https(
 int $duration = 31_536_000,
 ?RequestInterface $request = null,
 ?ResponseInterface $response = null
 ) {
 $request ??= Services::request();

 if (! $request instanceof IncomingRequest) {
 return;
 }

 if ($response === null) {
 $response = Services::response(null, true);
 }
 $response ??= Services::response();

 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure())) || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'test')) {
 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure()))
 || $request->getServer('HTTPS') === 'test'
 ) {
 return; // @codeCoverageIgnore
 }

Expand DownExpand Up@@ -520,13 +523,14 @@ function force_https(int $duration = 31_536_000, ?RequestInterface $request = nu
 );

 // Set an HSTS header
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration);
 $response->redirect($uri);
 $response->sendHeaders();

 if (ENVIRONMENT !== 'testing') {
 exit(); // @codeCoverageIgnore
 }
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration)
 ->redirect($uri)
 ->setStatusCode(307)
 ->setBody('')
 ->getCookieStore()
 ->clear();

 throw new RedirectException($response);
 }
}

Expand Down

57 changes: 56 additions & 1 deletion
system/HTTP/Exceptions/RedirectException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,17 +12,72 @@
namespace CodeIgniter\HTTP\Exceptions;

use CodeIgniter\Exceptions\HTTPExceptionInterface;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;
use Exception;
use InvalidArgumentException;
use LogicException;
use Throwable;

/**
 * RedirectException
 */
class RedirectException extends Exception implements HTTPExceptionInterface
class RedirectException extends Exception implements ResponsableInterface, HTTPExceptionInterface
{
 /**
 * HTTP status code for redirects
 *
 * @var int
 */
 protected $code = 302;

 protected ?ResponseInterface $response = null;

 /**
 * @param ResponseInterface|string $message Response object or a string containing a relative URI.
 * @param int $code HTTP status code to redirect if $message is a string.
 */
 public function __construct($message = '', int $code = 0, ?Throwable $previous = null)
 {
 if (! is_string($message) && ! $message instanceof ResponseInterface) {
 throw new InvalidArgumentException(
 'RedirectException::__construct() first argument must be a string or ResponseInterface',
 0,
 $this
 );
 }

 if ($message instanceof ResponseInterface) {
 $this->response = $message;
 $message = '';

 if ($this->response->getHeaderLine('Location') === '' && $this->response->getHeaderLine('Refresh') === '') {
 throw new LogicException(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );
 }

 if ($this->response->getStatusCode() < 301 || $this->response->getStatusCode() > 308) {
 $this->response->setStatusCode($this->code);
 }
 }

 parent::__construct($message, $code, $previous);
 }

 public function getResponse(): ResponseInterface
 {
 if (null === $this->response) {
 $this->response = Services::response()
 ->redirect(base_url($this->getMessage()), 'auto', $this->getCode());
 }

 Services::logger()->info(
 'REDIRECTED ROUTE at '
 . ($this->response->getHeaderLine('Location') ?: substr($this->response->getHeaderLine('Refresh'), 6))
 );

 return $this->response;
 }
}

17 changes: 17 additions & 0 deletions
system/HTTP/ResponsableInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

interface ResponsableInterface
{
 public function getResponse(): ResponseInterface;
}

4 changes: 1 addition & 3 deletions
tests/system/CodeIgniterTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,9 +441,7 @@ public function testRunForceSecure()
 $response = $this->getPrivateProperty($codeigniter, 'response');
 $this->assertNull($response->header('Location'));

 ob_start();
 $codeigniter->run();
 ob_get_clean();
 $response = $codeigniter->run(null, true);

 $this->assertSame('https://example.com/', $response->header('Location')->getValue());
 }
Expand Down

19 changes: 17 additions & 2 deletions
tests/system/CommonFunctionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use CodeIgniter\Config\BaseService;
use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Response;
Expand All@@ -35,6 +36,7 @@
use Config\Routing;
use Config\Services;
use Config\Session as SessionConfig;
use Exception;
use Kint;
use RuntimeException;
use stdClass;
Expand DownExpand Up@@ -599,10 +601,23 @@ public function testViewNotSaveData()
 public function testForceHttpsNullRequestAndResponse()
 {
 $this->assertNull(Services::response()->header('Location'));
 Services::response()->setCookie('force', 'cookie');
 Services::response()->setHeader('Force', 'header');
 Services::response()->setBody('default body');

 try {
 force_https();
 } catch (Exception $e) {
 $this->assertInstanceOf(RedirectException::class, $e);
 $this->assertSame('https://example.com/', $e->getResponse()->header('Location')->getValue());
 $this->assertFalse($e->getResponse()->hasCookie('force'));
 $this->assertSame('header', $e->getResponse()->getHeaderLine('Force'));
 $this->assertSame('', $e->getResponse()->getBody());
 $this->assertSame(307, $e->getResponse()->getStatusCode());
 }

 $this->expectException(RedirectException::class);
 force_https();

 $this->assertSame('https://example.com/', Services::response()->header('Location')->getValue());
 }

 /**
Expand Down

12 changes: 8 additions & 4 deletions
tests/system/ControllerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter;

use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\Response;
Expand DownExpand Up@@ -75,10 +76,13 @@ public function testConstructorHTTPS()
 $original = $_SERVER;
 $_SERVER = ['HTTPS' => 'on'];
 // make sure we can instantiate one
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 try {
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 } catch (RedirectException $e) {
 }

 $this->assertInstanceOf(Controller::class, $this->controller);
 $_SERVER = $original; // restore so code coverage doesn't break
Expand Down

93 changes: 93 additions & 0 deletions
tests/system/HTTP/RedirectExceptionTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\Log\Logger;
use CodeIgniter\Test\Mock\MockLogger as LoggerConfig;
use Config\Services;
use LogicException;
use PHPUnit\Framework\TestCase;
use Tests\Support\Log\Handlers\TestHandler;

/**
 * @internal
 *
 * @group Others
 */
final class RedirectExceptionTest extends TestCase
{
 protected function setUp(): void
 {
 Services::reset();
 Services::injectMock('logger', new Logger(new LoggerConfig()));
 }

 public function testResponse(): void
 {
 $response = (new RedirectException(
 Services::response()
 ->redirect('redirect')
 ->setCookie('cookie', 'value')
 ->setHeader('Redirect-Header', 'value')
 ))->getResponse();

 $this->assertSame('redirect', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 $this->assertSame('value', $response->getHeaderLine('Redirect-Header'));
 $this->assertSame('value', $response->getCookie('cookie')->getValue());
 }

 public function testResponseWithoutLocation(): void
 {
 $this->expectException(LogicException::class);
 $this->expectExceptionMessage(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );

 new RedirectException(Services::response());
 }

 public function testResponseWithoutStatusCode(): void
 {
 $response = (new RedirectException(Services::response()->setHeader('Location', 'location')))->getResponse();

 $this->assertSame('location', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 }

 public function testLoggingLocationHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri)))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, $response->getHeaderLine('Location'));
 $this->assertSame('', $response->getHeaderLine('Refresh'));
 $this->assertSame($expected, $logs[0]);
 }

 public function testLoggingRefreshHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri, 'refresh')))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, substr($response->getHeaderLine('Refresh'), 6));
 $this->assertSame('', $response->getHeaderLine('Location'));
 $this->assertSame($expected, $logs[0]);
 }
}

7 changes: 7 additions & 0 deletions
user_guide_src/source/changelogs/v4.4.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,7 @@ Helpers and Functions

- **Array:** Added :php:func:`array_group_by()` helper function to group data
 values together. Supports dot-notation syntax.
- **Common:** :php:func:`force_https()` no longer terminates the application, but throws a ``RedirectException``.

Others
======
Expand All@@ -123,6 +124,8 @@ Others
- **Request:** Added ``IncomingRequest::setValidLocales()`` method to set valid locales.
- **Table:** Added ``Table::setSyncRowsWithHeading()`` method to synchronize row columns with headings. See :ref:`table-sync-rows-with-headings` for details.
- **Error Handling:** Now you can use :ref:`custom-exception-handlers`.
- **RedirectException:** can also take an object that implements ResponseInterface as its first argument.
- **RedirectException:** implements ResponsableInterface.

Message Changes
***************
Expand All@@ -146,6 +149,10 @@ Changes
 this restriction has been removed.
- **RouteCollection:** The array structure of the protected property ``$routes``
 has been modified for performance.
- **HSTS:** Now :php:func:`force_https()` or
 ``Config\App::$forceGlobalSecureRequests = true`` sets the HTTP status code 307,
 which allows the HTTP request method to be preserved after the redirect.
 In previous versions, it was 302.

Deprecations
************
Expand Down
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
[4.4] Rework redirect exception#7610

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

kenjis
merged 8 commits into

from

Jun 29, 2023
 Merged


[4.4] Rework redirect exception
#7610
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2fb429d

rework: RedirectException implements ResponsableInterface


iRedds Jun 23, 2023
33b7963

rework: RedirectException constructor. force_https


iRedds Jun 23, 2023
7d5b9f8

rework: RedirectException. UG and new tests


iRedds Jun 25, 2023
8a770a5

rework: RedirectException. test group


iRedds Jun 25, 2023
3e1fa64

rework: RedirectException. tests, docs and changes


iRedds Jun 27, 2023
17583a1

rework: RedirectException. changelog


iRedds Jun 27, 2023
9de0717

Update user_guide_src/source/general/errors.rst


iRedds Jun 28, 2023
abb921a

rebase


iRedds Jun 29, 2023

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


16 changes: 8 additions & 8 deletions
system/CodeIgniter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Router\Exceptions\RedirectException as DeprecatedRedirectException;
Expand DownExpand Up@@ -337,20 +338,17 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
 $this->getRequestObject();
 $this->getResponseObject();

 $this->forceSecureAccess();

 $this->spoofRequestMethod();

 try {
 $this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
 } catch (RedirectException|DeprecatedRedirectException $e) {
 } catch (ResponsableInterface|DeprecatedRedirectException $e) {
 $this->outputBufferingEnd();
 $logger = Services::logger();
 $logger->info('REDIRECTED ROUTE at ' . $e->getMessage());
 if ($e instanceof DeprecatedRedirectException) {
 $e = new RedirectException($e->getMessage(), $e->getCode(), $e);
 }

 // If the route is a 'redirect' route, it throws
 // the exception with the $to as the message
 $this->response->redirect(base_url($e->getMessage()), 'auto', $e->getCode());
 $this->response = $e->getResponse();
 } catch (PageNotFoundException $e) {
 $this->response = $this->display404errors($e);
 } catch (Throwable $e) {
Expand DownExpand Up@@ -419,6 +417,8 @@ public function disableFilters(): void
 */
 protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
 {
 $this->forceSecureAccess();

 if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
 return $this->response->setStatusCode(405)->setBody('Method Not Allowed');
 }
Expand Down

36 changes: 20 additions & 16 deletions
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
use CodeIgniter\Files\Exceptions\FileNotFoundException;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\RequestInterface;
Expand DownExpand Up@@ -476,22 +477,24 @@ function esc($data, string $context = 'html', ?string $encoding = null)
 * @param ResponseInterface $response
 *
 * @throws HTTPException
 * @throws RedirectException
 */
 function force_https(int $duration = 31_536_000, ?RequestInterface $request = null, ?ResponseInterface $response = null)
 {
 if ($request === null) {
 $request = Services::request(null, true);
 }
 function force_https(
 int $duration = 31_536_000,
 ?RequestInterface $request = null,
 ?ResponseInterface $response = null
 ) {
 $request ??= Services::request();

 if (! $request instanceof IncomingRequest) {
 return;
 }

 if ($response === null) {
 $response = Services::response(null, true);
 }
 $response ??= Services::response();

 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure())) || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'test')) {
 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure()))
 || $request->getServer('HTTPS') === 'test'
 ) {
 return; // @codeCoverageIgnore
 }

Expand DownExpand Up@@ -520,13 +523,14 @@ function force_https(int $duration = 31_536_000, ?RequestInterface $request = nu
 );

 // Set an HSTS header
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration);
 $response->redirect($uri);
 $response->sendHeaders();

 if (ENVIRONMENT !== 'testing') {
 exit(); // @codeCoverageIgnore
 }
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration)
 ->redirect($uri)
 ->setStatusCode(307)
 ->setBody('')
 ->getCookieStore()
 ->clear();

 throw new RedirectException($response);
 }
}

Expand Down

57 changes: 56 additions & 1 deletion
system/HTTP/Exceptions/RedirectException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,17 +12,72 @@
namespace CodeIgniter\HTTP\Exceptions;

use CodeIgniter\Exceptions\HTTPExceptionInterface;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;
use Exception;
use InvalidArgumentException;
use LogicException;
use Throwable;

/**
 * RedirectException
 */
class RedirectException extends Exception implements HTTPExceptionInterface
class RedirectException extends Exception implements ResponsableInterface, HTTPExceptionInterface
{
 /**
 * HTTP status code for redirects
 *
 * @var int
 */
 protected $code = 302;

 protected ?ResponseInterface $response = null;

 /**
 * @param ResponseInterface|string $message Response object or a string containing a relative URI.
 * @param int $code HTTP status code to redirect if $message is a string.
 */
 public function __construct($message = '', int $code = 0, ?Throwable $previous = null)
 {
 if (! is_string($message) && ! $message instanceof ResponseInterface) {
 throw new InvalidArgumentException(
 'RedirectException::__construct() first argument must be a string or ResponseInterface',
 0,
 $this
 );
 }

 if ($message instanceof ResponseInterface) {
 $this->response = $message;
 $message = '';

 if ($this->response->getHeaderLine('Location') === '' && $this->response->getHeaderLine('Refresh') === '') {
 throw new LogicException(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );
 }

 if ($this->response->getStatusCode() < 301 || $this->response->getStatusCode() > 308) {
 $this->response->setStatusCode($this->code);
 }
 }

 parent::__construct($message, $code, $previous);
 }

 public function getResponse(): ResponseInterface
 {
 if (null === $this->response) {
 $this->response = Services::response()
 ->redirect(base_url($this->getMessage()), 'auto', $this->getCode());
 }

 Services::logger()->info(
 'REDIRECTED ROUTE at '
 . ($this->response->getHeaderLine('Location') ?: substr($this->response->getHeaderLine('Refresh'), 6))
 );

 return $this->response;
 }
}

17 changes: 17 additions & 0 deletions
system/HTTP/ResponsableInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

interface ResponsableInterface
{
 public function getResponse(): ResponseInterface;
}

4 changes: 1 addition & 3 deletions
tests/system/CodeIgniterTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,9 +441,7 @@ public function testRunForceSecure()
 $response = $this->getPrivateProperty($codeigniter, 'response');
 $this->assertNull($response->header('Location'));

 ob_start();
 $codeigniter->run();
 ob_get_clean();
 $response = $codeigniter->run(null, true);

 $this->assertSame('https://example.com/', $response->header('Location')->getValue());
 }
Expand Down

19 changes: 17 additions & 2 deletions
tests/system/CommonFunctionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use CodeIgniter\Config\BaseService;
use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Response;
Expand All@@ -35,6 +36,7 @@
use Config\Routing;
use Config\Services;
use Config\Session as SessionConfig;
use Exception;
use Kint;
use RuntimeException;
use stdClass;
Expand DownExpand Up@@ -599,10 +601,23 @@ public function testViewNotSaveData()
 public function testForceHttpsNullRequestAndResponse()
 {
 $this->assertNull(Services::response()->header('Location'));
 Services::response()->setCookie('force', 'cookie');
 Services::response()->setHeader('Force', 'header');
 Services::response()->setBody('default body');

 try {
 force_https();
 } catch (Exception $e) {
 $this->assertInstanceOf(RedirectException::class, $e);
 $this->assertSame('https://example.com/', $e->getResponse()->header('Location')->getValue());
 $this->assertFalse($e->getResponse()->hasCookie('force'));
 $this->assertSame('header', $e->getResponse()->getHeaderLine('Force'));
 $this->assertSame('', $e->getResponse()->getBody());
 $this->assertSame(307, $e->getResponse()->getStatusCode());
 }

 $this->expectException(RedirectException::class);
 force_https();

 $this->assertSame('https://example.com/', Services::response()->header('Location')->getValue());
 }

 /**
Expand Down

12 changes: 8 additions & 4 deletions
tests/system/ControllerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter;

use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\Response;
Expand DownExpand Up@@ -75,10 +76,13 @@ public function testConstructorHTTPS()
 $original = $_SERVER;
 $_SERVER = ['HTTPS' => 'on'];
 // make sure we can instantiate one
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 try {
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 } catch (RedirectException $e) {
 }

 $this->assertInstanceOf(Controller::class, $this->controller);
 $_SERVER = $original; // restore so code coverage doesn't break
Expand Down

93 changes: 93 additions & 0 deletions
tests/system/HTTP/RedirectExceptionTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\Log\Logger;
use CodeIgniter\Test\Mock\MockLogger as LoggerConfig;
use Config\Services;
use LogicException;
use PHPUnit\Framework\TestCase;
use Tests\Support\Log\Handlers\TestHandler;

/**
 * @internal
 *
 * @group Others
 */
final class RedirectExceptionTest extends TestCase
{
 protected function setUp(): void
 {
 Services::reset();
 Services::injectMock('logger', new Logger(new LoggerConfig()));
 }

 public function testResponse(): void
 {
 $response = (new RedirectException(
 Services::response()
 ->redirect('redirect')
 ->setCookie('cookie', 'value')
 ->setHeader('Redirect-Header', 'value')
 ))->getResponse();

 $this->assertSame('redirect', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 $this->assertSame('value', $response->getHeaderLine('Redirect-Header'));
 $this->assertSame('value', $response->getCookie('cookie')->getValue());
 }

 public function testResponseWithoutLocation(): void
 {
 $this->expectException(LogicException::class);
 $this->expectExceptionMessage(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );

 new RedirectException(Services::response());
 }

 public function testResponseWithoutStatusCode(): void
 {
 $response = (new RedirectException(Services::response()->setHeader('Location', 'location')))->getResponse();

 $this->assertSame('location', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 }

 public function testLoggingLocationHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri)))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, $response->getHeaderLine('Location'));
 $this->assertSame('', $response->getHeaderLine('Refresh'));
 $this->assertSame($expected, $logs[0]);
 }

 public function testLoggingRefreshHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri, 'refresh')))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, substr($response->getHeaderLine('Refresh'), 6));
 $this->assertSame('', $response->getHeaderLine('Location'));
 $this->assertSame($expected, $logs[0]);
 }
}

7 changes: 7 additions & 0 deletions
user_guide_src/source/changelogs/v4.4.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,7 @@ Helpers and Functions

- **Array:** Added :php:func:`array_group_by()` helper function to group data
 values together. Supports dot-notation syntax.
- **Common:** :php:func:`force_https()` no longer terminates the application, but throws a ``RedirectException``.

Others
======
Expand All@@ -123,6 +124,8 @@ Others
- **Request:** Added ``IncomingRequest::setValidLocales()`` method to set valid locales.
- **Table:** Added ``Table::setSyncRowsWithHeading()`` method to synchronize row columns with headings. See :ref:`table-sync-rows-with-headings` for details.
- **Error Handling:** Now you can use :ref:`custom-exception-handlers`.
- **RedirectException:** can also take an object that implements ResponseInterface as its first argument.
- **RedirectException:** implements ResponsableInterface.

Message Changes
***************
Expand All@@ -146,6 +149,10 @@ Changes
 this restriction has been removed.
- **RouteCollection:** The array structure of the protected property ``$routes``
 has been modified for performance.
- **HSTS:** Now :php:func:`force_https()` or
 ``Config\App::$forceGlobalSecureRequests = true`` sets the HTTP status code 307,
 which allows the HTTP request method to be preserved after the redirect.
 In previous versions, it was 302.

Deprecations
************
Expand Down
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
[4.4] Rework redirect exception#7610

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

kenjis
merged 8 commits into

from

Jun 29, 2023
 Merged


[4.4] Rework redirect exception
#7610
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2fb429d

rework: RedirectException implements ResponsableInterface


iRedds Jun 23, 2023
33b7963

rework: RedirectException constructor. force_https


iRedds Jun 23, 2023
7d5b9f8

rework: RedirectException. UG and new tests


iRedds Jun 25, 2023
8a770a5

rework: RedirectException. test group


iRedds Jun 25, 2023
3e1fa64

rework: RedirectException. tests, docs and changes


iRedds Jun 27, 2023
17583a1

rework: RedirectException. changelog


iRedds Jun 27, 2023
9de0717

Update user_guide_src/source/general/errors.rst


iRedds Jun 28, 2023
abb921a

rebase


iRedds Jun 29, 2023

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


16 changes: 8 additions & 8 deletions
system/CodeIgniter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Router\Exceptions\RedirectException as DeprecatedRedirectException;
Expand DownExpand Up@@ -337,20 +338,17 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
 $this->getRequestObject();
 $this->getResponseObject();

 $this->forceSecureAccess();

 $this->spoofRequestMethod();

 try {
 $this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
 } catch (RedirectException|DeprecatedRedirectException $e) {
 } catch (ResponsableInterface|DeprecatedRedirectException $e) {
 $this->outputBufferingEnd();
 $logger = Services::logger();
 $logger->info('REDIRECTED ROUTE at ' . $e->getMessage());
 if ($e instanceof DeprecatedRedirectException) {
 $e = new RedirectException($e->getMessage(), $e->getCode(), $e);
 }

 // If the route is a 'redirect' route, it throws
 // the exception with the $to as the message
 $this->response->redirect(base_url($e->getMessage()), 'auto', $e->getCode());
 $this->response = $e->getResponse();
 } catch (PageNotFoundException $e) {
 $this->response = $this->display404errors($e);
 } catch (Throwable $e) {
Expand DownExpand Up@@ -419,6 +417,8 @@ public function disableFilters(): void
 */
 protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
 {
 $this->forceSecureAccess();

 if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
 return $this->response->setStatusCode(405)->setBody('Method Not Allowed');
 }
Expand Down

36 changes: 20 additions & 16 deletions
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
use CodeIgniter\Files\Exceptions\FileNotFoundException;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\RequestInterface;
Expand DownExpand Up@@ -476,22 +477,24 @@ function esc($data, string $context = 'html', ?string $encoding = null)
 * @param ResponseInterface $response
 *
 * @throws HTTPException
 * @throws RedirectException
 */
 function force_https(int $duration = 31_536_000, ?RequestInterface $request = null, ?ResponseInterface $response = null)
 {
 if ($request === null) {
 $request = Services::request(null, true);
 }
 function force_https(
 int $duration = 31_536_000,
 ?RequestInterface $request = null,
 ?ResponseInterface $response = null
 ) {
 $request ??= Services::request();

 if (! $request instanceof IncomingRequest) {
 return;
 }

 if ($response === null) {
 $response = Services::response(null, true);
 }
 $response ??= Services::response();

 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure())) || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'test')) {
 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure()))
 || $request->getServer('HTTPS') === 'test'
 ) {
 return; // @codeCoverageIgnore
 }

Expand DownExpand Up@@ -520,13 +523,14 @@ function force_https(int $duration = 31_536_000, ?RequestInterface $request = nu
 );

 // Set an HSTS header
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration);
 $response->redirect($uri);
 $response->sendHeaders();

 if (ENVIRONMENT !== 'testing') {
 exit(); // @codeCoverageIgnore
 }
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration)
 ->redirect($uri)
 ->setStatusCode(307)
 ->setBody('')
 ->getCookieStore()
 ->clear();

 throw new RedirectException($response);
 }
}

Expand Down

57 changes: 56 additions & 1 deletion
system/HTTP/Exceptions/RedirectException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,17 +12,72 @@
namespace CodeIgniter\HTTP\Exceptions;

use CodeIgniter\Exceptions\HTTPExceptionInterface;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;
use Exception;
use InvalidArgumentException;
use LogicException;
use Throwable;

/**
 * RedirectException
 */
class RedirectException extends Exception implements HTTPExceptionInterface
class RedirectException extends Exception implements ResponsableInterface, HTTPExceptionInterface
{
 /**
 * HTTP status code for redirects
 *
 * @var int
 */
 protected $code = 302;

 protected ?ResponseInterface $response = null;

 /**
 * @param ResponseInterface|string $message Response object or a string containing a relative URI.
 * @param int $code HTTP status code to redirect if $message is a string.
 */
 public function __construct($message = '', int $code = 0, ?Throwable $previous = null)
 {
 if (! is_string($message) && ! $message instanceof ResponseInterface) {
 throw new InvalidArgumentException(
 'RedirectException::__construct() first argument must be a string or ResponseInterface',
 0,
 $this
 );
 }

 if ($message instanceof ResponseInterface) {
 $this->response = $message;
 $message = '';

 if ($this->response->getHeaderLine('Location') === '' && $this->response->getHeaderLine('Refresh') === '') {
 throw new LogicException(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );
 }

 if ($this->response->getStatusCode() < 301 || $this->response->getStatusCode() > 308) {
 $this->response->setStatusCode($this->code);
 }
 }

 parent::__construct($message, $code, $previous);
 }

 public function getResponse(): ResponseInterface
 {
 if (null === $this->response) {
 $this->response = Services::response()
 ->redirect(base_url($this->getMessage()), 'auto', $this->getCode());
 }

 Services::logger()->info(
 'REDIRECTED ROUTE at '
 . ($this->response->getHeaderLine('Location') ?: substr($this->response->getHeaderLine('Refresh'), 6))
 );

 return $this->response;
 }
}

17 changes: 17 additions & 0 deletions
system/HTTP/ResponsableInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

interface ResponsableInterface
{
 public function getResponse(): ResponseInterface;
}

4 changes: 1 addition & 3 deletions
tests/system/CodeIgniterTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,9 +441,7 @@ public function testRunForceSecure()
 $response = $this->getPrivateProperty($codeigniter, 'response');
 $this->assertNull($response->header('Location'));

 ob_start();
 $codeigniter->run();
 ob_get_clean();
 $response = $codeigniter->run(null, true);

 $this->assertSame('https://example.com/', $response->header('Location')->getValue());
 }
Expand Down

19 changes: 17 additions & 2 deletions
tests/system/CommonFunctionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use CodeIgniter\Config\BaseService;
use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Response;
Expand All@@ -35,6 +36,7 @@
use Config\Routing;
use Config\Services;
use Config\Session as SessionConfig;
use Exception;
use Kint;
use RuntimeException;
use stdClass;
Expand DownExpand Up@@ -599,10 +601,23 @@ public function testViewNotSaveData()
 public function testForceHttpsNullRequestAndResponse()
 {
 $this->assertNull(Services::response()->header('Location'));
 Services::response()->setCookie('force', 'cookie');
 Services::response()->setHeader('Force', 'header');
 Services::response()->setBody('default body');

 try {
 force_https();
 } catch (Exception $e) {
 $this->assertInstanceOf(RedirectException::class, $e);
 $this->assertSame('https://example.com/', $e->getResponse()->header('Location')->getValue());
 $this->assertFalse($e->getResponse()->hasCookie('force'));
 $this->assertSame('header', $e->getResponse()->getHeaderLine('Force'));
 $this->assertSame('', $e->getResponse()->getBody());
 $this->assertSame(307, $e->getResponse()->getStatusCode());
 }

 $this->expectException(RedirectException::class);
 force_https();

 $this->assertSame('https://example.com/', Services::response()->header('Location')->getValue());
 }

 /**
Expand Down

12 changes: 8 additions & 4 deletions
tests/system/ControllerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter;

use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\Response;
Expand DownExpand Up@@ -75,10 +76,13 @@ public function testConstructorHTTPS()
 $original = $_SERVER;
 $_SERVER = ['HTTPS' => 'on'];
 // make sure we can instantiate one
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 try {
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 } catch (RedirectException $e) {
 }

 $this->assertInstanceOf(Controller::class, $this->controller);
 $_SERVER = $original; // restore so code coverage doesn't break
Expand Down

93 changes: 93 additions & 0 deletions
tests/system/HTTP/RedirectExceptionTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\Log\Logger;
use CodeIgniter\Test\Mock\MockLogger as LoggerConfig;
use Config\Services;
use LogicException;
use PHPUnit\Framework\TestCase;
use Tests\Support\Log\Handlers\TestHandler;

/**
 * @internal
 *
 * @group Others
 */
final class RedirectExceptionTest extends TestCase
{
 protected function setUp(): void
 {
 Services::reset();
 Services::injectMock('logger', new Logger(new LoggerConfig()));
 }

 public function testResponse(): void
 {
 $response = (new RedirectException(
 Services::response()
 ->redirect('redirect')
 ->setCookie('cookie', 'value')
 ->setHeader('Redirect-Header', 'value')
 ))->getResponse();

 $this->assertSame('redirect', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 $this->assertSame('value', $response->getHeaderLine('Redirect-Header'));
 $this->assertSame('value', $response->getCookie('cookie')->getValue());
 }

 public function testResponseWithoutLocation(): void
 {
 $this->expectException(LogicException::class);
 $this->expectExceptionMessage(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );

 new RedirectException(Services::response());
 }

 public function testResponseWithoutStatusCode(): void
 {
 $response = (new RedirectException(Services::response()->setHeader('Location', 'location')))->getResponse();

 $this->assertSame('location', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 }

 public function testLoggingLocationHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri)))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, $response->getHeaderLine('Location'));
 $this->assertSame('', $response->getHeaderLine('Refresh'));
 $this->assertSame($expected, $logs[0]);
 }

 public function testLoggingRefreshHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri, 'refresh')))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, substr($response->getHeaderLine('Refresh'), 6));
 $this->assertSame('', $response->getHeaderLine('Location'));
 $this->assertSame($expected, $logs[0]);
 }
}

7 changes: 7 additions & 0 deletions
user_guide_src/source/changelogs/v4.4.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,7 @@ Helpers and Functions

- **Array:** Added :php:func:`array_group_by()` helper function to group data
 values together. Supports dot-notation syntax.
- **Common:** :php:func:`force_https()` no longer terminates the application, but throws a ``RedirectException``.

Others
======
Expand All@@ -123,6 +124,8 @@ Others
- **Request:** Added ``IncomingRequest::setValidLocales()`` method to set valid locales.
- **Table:** Added ``Table::setSyncRowsWithHeading()`` method to synchronize row columns with headings. See :ref:`table-sync-rows-with-headings` for details.
- **Error Handling:** Now you can use :ref:`custom-exception-handlers`.
- **RedirectException:** can also take an object that implements ResponseInterface as its first argument.
- **RedirectException:** implements ResponsableInterface.

Message Changes
***************
Expand All@@ -146,6 +149,10 @@ Changes
 this restriction has been removed.
- **RouteCollection:** The array structure of the protected property ``$routes``
 has been modified for performance.
- **HSTS:** Now :php:func:`force_https()` or
 ``Config\App::$forceGlobalSecureRequests = true`` sets the HTTP status code 307,
 which allows the HTTP request method to be preserved after the redirect.
 In previous versions, it was 302.

Deprecations
************
Expand Down
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
[4.4] Rework redirect exception#7610

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

kenjis
merged 8 commits into

from

Jun 29, 2023
 Merged


[4.4] Rework redirect exception
#7610
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2fb429d

rework: RedirectException implements ResponsableInterface


iRedds Jun 23, 2023
33b7963

rework: RedirectException constructor. force_https


iRedds Jun 23, 2023
7d5b9f8

rework: RedirectException. UG and new tests


iRedds Jun 25, 2023
8a770a5

rework: RedirectException. test group


iRedds Jun 25, 2023
3e1fa64

rework: RedirectException. tests, docs and changes


iRedds Jun 27, 2023
17583a1

rework: RedirectException. changelog


iRedds Jun 27, 2023
9de0717

Update user_guide_src/source/general/errors.rst


iRedds Jun 28, 2023
abb921a

rebase


iRedds Jun 29, 2023

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


16 changes: 8 additions & 8 deletions
system/CodeIgniter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Router\Exceptions\RedirectException as DeprecatedRedirectException;
Expand DownExpand Up@@ -337,20 +338,17 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
 $this->getRequestObject();
 $this->getResponseObject();

 $this->forceSecureAccess();

 $this->spoofRequestMethod();

 try {
 $this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
 } catch (RedirectException|DeprecatedRedirectException $e) {
 } catch (ResponsableInterface|DeprecatedRedirectException $e) {
 $this->outputBufferingEnd();
 $logger = Services::logger();
 $logger->info('REDIRECTED ROUTE at ' . $e->getMessage());
 if ($e instanceof DeprecatedRedirectException) {
 $e = new RedirectException($e->getMessage(), $e->getCode(), $e);
 }

 // If the route is a 'redirect' route, it throws
 // the exception with the $to as the message
 $this->response->redirect(base_url($e->getMessage()), 'auto', $e->getCode());
 $this->response = $e->getResponse();
 } catch (PageNotFoundException $e) {
 $this->response = $this->display404errors($e);
 } catch (Throwable $e) {
Expand DownExpand Up@@ -419,6 +417,8 @@ public function disableFilters(): void
 */
 protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
 {
 $this->forceSecureAccess();

 if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
 return $this->response->setStatusCode(405)->setBody('Method Not Allowed');
 }
Expand Down

36 changes: 20 additions & 16 deletions
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
use CodeIgniter\Files\Exceptions\FileNotFoundException;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\RequestInterface;
Expand DownExpand Up@@ -476,22 +477,24 @@ function esc($data, string $context = 'html', ?string $encoding = null)
 * @param ResponseInterface $response
 *
 * @throws HTTPException
 * @throws RedirectException
 */
 function force_https(int $duration = 31_536_000, ?RequestInterface $request = null, ?ResponseInterface $response = null)
 {
 if ($request === null) {
 $request = Services::request(null, true);
 }
 function force_https(
 int $duration = 31_536_000,
 ?RequestInterface $request = null,
 ?ResponseInterface $response = null
 ) {
 $request ??= Services::request();

 if (! $request instanceof IncomingRequest) {
 return;
 }

 if ($response === null) {
 $response = Services::response(null, true);
 }
 $response ??= Services::response();

 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure())) || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'test')) {
 if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure()))
 || $request->getServer('HTTPS') === 'test'
 ) {
 return; // @codeCoverageIgnore
 }

Expand DownExpand Up@@ -520,13 +523,14 @@ function force_https(int $duration = 31_536_000, ?RequestInterface $request = nu
 );

 // Set an HSTS header
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration);
 $response->redirect($uri);
 $response->sendHeaders();

 if (ENVIRONMENT !== 'testing') {
 exit(); // @codeCoverageIgnore
 }
 $response->setHeader('Strict-Transport-Security', 'max-age=' . $duration)
 ->redirect($uri)
 ->setStatusCode(307)
 ->setBody('')
 ->getCookieStore()
 ->clear();

 throw new RedirectException($response);
 }
}

Expand Down

57 changes: 56 additions & 1 deletion
system/HTTP/Exceptions/RedirectException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,17 +12,72 @@
namespace CodeIgniter\HTTP\Exceptions;

use CodeIgniter\Exceptions\HTTPExceptionInterface;
use CodeIgniter\HTTP\ResponsableInterface;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;
use Exception;
use InvalidArgumentException;
use LogicException;
use Throwable;

/**
 * RedirectException
 */
class RedirectException extends Exception implements HTTPExceptionInterface
class RedirectException extends Exception implements ResponsableInterface, HTTPExceptionInterface
{
 /**
 * HTTP status code for redirects
 *
 * @var int
 */
 protected $code = 302;

 protected ?ResponseInterface $response = null;

 /**
 * @param ResponseInterface|string $message Response object or a string containing a relative URI.
 * @param int $code HTTP status code to redirect if $message is a string.
 */
 public function __construct($message = '', int $code = 0, ?Throwable $previous = null)
 {
 if (! is_string($message) && ! $message instanceof ResponseInterface) {
 throw new InvalidArgumentException(
 'RedirectException::__construct() first argument must be a string or ResponseInterface',
 0,
 $this
 );
 }

 if ($message instanceof ResponseInterface) {
 $this->response = $message;
 $message = '';

 if ($this->response->getHeaderLine('Location') === '' && $this->response->getHeaderLine('Refresh') === '') {
 throw new LogicException(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );
 }

 if ($this->response->getStatusCode() < 301 || $this->response->getStatusCode() > 308) {
 $this->response->setStatusCode($this->code);
 }
 }

 parent::__construct($message, $code, $previous);
 }

 public function getResponse(): ResponseInterface
 {
 if (null === $this->response) {
 $this->response = Services::response()
 ->redirect(base_url($this->getMessage()), 'auto', $this->getCode());
 }

 Services::logger()->info(
 'REDIRECTED ROUTE at '
 . ($this->response->getHeaderLine('Location') ?: substr($this->response->getHeaderLine('Refresh'), 6))
 );

 return $this->response;
 }
}

17 changes: 17 additions & 0 deletions
system/HTTP/ResponsableInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

interface ResponsableInterface
{
 public function getResponse(): ResponseInterface;
}

4 changes: 1 addition & 3 deletions
tests/system/CodeIgniterTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -441,9 +441,7 @@ public function testRunForceSecure()
 $response = $this->getPrivateProperty($codeigniter, 'response');
 $this->assertNull($response->header('Location'));

 ob_start();
 $codeigniter->run();
 ob_get_clean();
 $response = $codeigniter->run(null, true);

 $this->assertSame('https://example.com/', $response->header('Location')->getValue());
 }
Expand Down

19 changes: 17 additions & 2 deletions
tests/system/CommonFunctionsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use CodeIgniter\Config\BaseService;
use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Response;
Expand All@@ -35,6 +36,7 @@
use Config\Routing;
use Config\Services;
use Config\Session as SessionConfig;
use Exception;
use Kint;
use RuntimeException;
use stdClass;
Expand DownExpand Up@@ -599,10 +601,23 @@ public function testViewNotSaveData()
 public function testForceHttpsNullRequestAndResponse()
 {
 $this->assertNull(Services::response()->header('Location'));
 Services::response()->setCookie('force', 'cookie');
 Services::response()->setHeader('Force', 'header');
 Services::response()->setBody('default body');

 try {
 force_https();
 } catch (Exception $e) {
 $this->assertInstanceOf(RedirectException::class, $e);
 $this->assertSame('https://example.com/', $e->getResponse()->header('Location')->getValue());
 $this->assertFalse($e->getResponse()->hasCookie('force'));
 $this->assertSame('header', $e->getResponse()->getHeaderLine('Force'));
 $this->assertSame('', $e->getResponse()->getBody());
 $this->assertSame(307, $e->getResponse()->getStatusCode());
 }

 $this->expectException(RedirectException::class);
 force_https();

 $this->assertSame('https://example.com/', Services::response()->header('Location')->getValue());
 }

 /**
Expand Down

12 changes: 8 additions & 4 deletions
tests/system/ControllerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter;

use CodeIgniter\Config\Factories;
use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\Response;
Expand DownExpand Up@@ -75,10 +76,13 @@ public function testConstructorHTTPS()
 $original = $_SERVER;
 $_SERVER = ['HTTPS' => 'on'];
 // make sure we can instantiate one
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 try {
 $this->controller = new class () extends Controller {
 protected $forceHTTPS = 1;
 };
 $this->controller->initController($this->request, $this->response, $this->logger);
 } catch (RedirectException $e) {
 }

 $this->assertInstanceOf(Controller::class, $this->controller);
 $_SERVER = $original; // restore so code coverage doesn't break
Expand Down

93 changes: 93 additions & 0 deletions
tests/system/HTTP/RedirectExceptionTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

use CodeIgniter\HTTP\Exceptions\RedirectException;
use CodeIgniter\Log\Logger;
use CodeIgniter\Test\Mock\MockLogger as LoggerConfig;
use Config\Services;
use LogicException;
use PHPUnit\Framework\TestCase;
use Tests\Support\Log\Handlers\TestHandler;

/**
 * @internal
 *
 * @group Others
 */
final class RedirectExceptionTest extends TestCase
{
 protected function setUp(): void
 {
 Services::reset();
 Services::injectMock('logger', new Logger(new LoggerConfig()));
 }

 public function testResponse(): void
 {
 $response = (new RedirectException(
 Services::response()
 ->redirect('redirect')
 ->setCookie('cookie', 'value')
 ->setHeader('Redirect-Header', 'value')
 ))->getResponse();

 $this->assertSame('redirect', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 $this->assertSame('value', $response->getHeaderLine('Redirect-Header'));
 $this->assertSame('value', $response->getCookie('cookie')->getValue());
 }

 public function testResponseWithoutLocation(): void
 {
 $this->expectException(LogicException::class);
 $this->expectExceptionMessage(
 'The Response object passed to RedirectException does not contain a redirect address.'
 );

 new RedirectException(Services::response());
 }

 public function testResponseWithoutStatusCode(): void
 {
 $response = (new RedirectException(Services::response()->setHeader('Location', 'location')))->getResponse();

 $this->assertSame('location', $response->getHeaderLine('location'));
 $this->assertSame(302, $response->getStatusCode());
 }

 public function testLoggingLocationHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri)))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, $response->getHeaderLine('Location'));
 $this->assertSame('', $response->getHeaderLine('Refresh'));
 $this->assertSame($expected, $logs[0]);
 }

 public function testLoggingRefreshHeader(): void
 {
 $uri = 'http://location';
 $expected = 'INFO - ' . date('Y-m-d') . ' --> REDIRECTED ROUTE at ' . $uri;
 $response = (new RedirectException(Services::response()->redirect($uri, 'refresh')))->getResponse();

 $logs = TestHandler::getLogs();

 $this->assertSame($uri, substr($response->getHeaderLine('Refresh'), 6));
 $this->assertSame('', $response->getHeaderLine('Location'));
 $this->assertSame($expected, $logs[0]);
 }
}

7 changes: 7 additions & 0 deletions
user_guide_src/source/changelogs/v4.4.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,7 @@ Helpers and Functions

- **Array:** Added :php:func:`array_group_by()` helper function to group data
 values together. Supports dot-notation syntax.
- **Common:** :php:func:`force_https()` no longer terminates the application, but throws a ``RedirectException``.

Others
======
Expand All@@ -123,6 +124,8 @@ Others
- **Request:** Added ``IncomingRequest::setValidLocales()`` method to set valid locales.
- **Table:** Added ``Table::setSyncRowsWithHeading()`` method to synchronize row columns with headings. See :ref:`table-sync-rows-with-headings` for details.
- **Error Handling:** Now you can use :ref:`custom-exception-handlers`.
- **RedirectException:** can also take an object that implements ResponseInterface as its first argument.
- **RedirectException:** implements ResponsableInterface.

Message Changes
***************
Expand All@@ -146,6 +149,10 @@ Changes
 this restriction has been removed.
- **RouteCollection:** The array structure of the protected property ``$routes``
 has been modified for performance.
- **HSTS:** Now :php:func:`force_https()` or
 ``Config\App::$forceGlobalSecureRequests = true`` sets the HTTP status code 307,
 which allows the HTTP request method to be preserved after the redirect.
 In previous versions, it was 302.

Deprecations
************
Expand Down
Loading