Presenter::storeRequest() & restoreRequest() are separated into RequestStorage service; restoreRequest() redirects to original URL

Author: MartinMajor

src/Application/Application.php

@@ -67,13 +67,17 @@ class Application extends Nette\Object
 	/** @var IRouter */
 	private $router;
 
+	/** @var IRequestStorage */
+	private $requestStorage;
 
-	public function __construct(IPresenterFactory $presenterFactory, IRouter $router, Nette\Http\IRequest $httpRequest, Nette\Http\IResponse $httpResponse)
+
+	public function __construct(IPresenterFactory $presenterFactory, IRouter $router, Nette\Http\IRequest $httpRequest, Nette\Http\IResponse $httpResponse, IRequestStorage $requestStorage)
 	{
 		$this->httpRequest = $httpRequest;
 		$this->httpResponse = $httpResponse;
 		$this->presenterFactory = $presenterFactory;
 		$this->router = $router;
+		$this->requestStorage = $requestStorage;
 	}
 
 
@@ -111,7 +115,7 @@ public function run()
 	 */
 	public function createInitialRequest()
 	{
-		$request = $this->router->match($this->httpRequest);
+		$request = $this->requestStorage->restore() ?: $this->router->match($this->httpRequest);
 
 		if (!$request instanceof Request) {
 			throw new BadRequestException('No route for HTTP request.');

src/Application/IRequestStorage.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * This file is part of the Nette Framework (http://nette.org)
+ * Copyright (c) 2004 David Grudl (http://davidgrudl.com)
+ */
+
+namespace Nette\Application;
+
+use Nette;
+
+
+/**
+ * Interface for storing and restoring requests.
+ *
+ * @author     Martin Major
+ */
+interface IRequestStorage
+{
+
+	/**
+	 * Stores request and returns key.
+	 * @return string key
+	 */
+	function store(Request $request, Nette\Http\Url $url);
+
+	/**
+	 * Restores original URL.
+	 * @param  string key
+	 * @return string|NULL
+	 */
+	function getUrl($key);
+
+	/**
+	 * Returns stored request.
+	 * @return Request|NULL
+	 */
+	function restore();
+
+}

src/Application/RequestStorage.php

@@ -0,0 +1,83 @@
+<?php
+
+/**
+ * This file is part of the Nette Framework (http://nette.org)
+ * Copyright (c) 2004 David Grudl (http://davidgrudl.com)
+ */
+
+namespace Nette\Application;
+
+use Nette,
+	Nette\Http;
+
+
+/**
+ * Service for storing and restoring requests from session.
+ *
+ * @author     Martin Major
+ */
+class RequestStorage extends Nette\Object implements IRequestStorage
+{
+	/** @var Http\Session */
+	private $session;
+
+	/** @var Nette\Security\User */
+	private $user;
+
+
+	public function __construct(Http\Session $session, Nette\Security\User $user)
+	{
+		$this->session = $session;
+		$this->user = $user;
+	}
+
+
+	/**
+	 * Stores request and returns key.
+	 * @return string key
+	 */
+	public function store(Request $request, Http\Url $url, $expiration = '10 minutes')
+	{
+		$session = $this->session->getSection(__CLASS__);
+		do {
+			$key = Nette\Utils\Random::generate(5);
+		} while (isset($session[$key]));
+
+		$session[$key] = array(clone $request, clone $url, $this->user->getId());
+		$session->setExpiration($expiration, $key);
+		return $key;
+	}
+
+
+	/**
+	 * Restores original URL.
+	 * @param  string key
+	 * @return string|NULL
+	 */
+	public function getUrl($key)
+	{
+		list($request, $url, $user) = $this->session->getSection(__CLASS__)->$key;
+		if (!$request || !$url || ($user !== NULL && $user !== $this->user->getId())) {
+			return;
+		}
+
+		$request->setFlag($request::RESTORED, TRUE);
+		$this->session->getFlashSection(__CLASS__)->request = $request;
+
+		$url->setQueryParameter(Http\Session::FLASH_KEY, $this->session->getFlashId());
+		return (string) $url;
+	}
+
+
+	/**
+	 * Returns stored request.
+	 * @return Request|NULL
+	 */
+	public function restore()
+	{
+		return $this->session->getFlashId()
+			? $this->session->getFlashSection(__CLASS__)->request
+			: NULL;
+	}
+
+}

src/Application/UI/Presenter.php

@@ -126,6 +126,9 @@ abstract class Presenter extends Control implements Application\IPresenter
 	/** @var ITemplateFactory */
 	private $templateFactory;
 
+	/** @var Application\IRequestStorage */
+	private $requestStorage;
+
 
 	public function __construct()
 	{
@@ -1073,14 +1076,10 @@ protected function handleInvalidLink(InvalidLinkException $e)
 	 */
 	public function storeRequest($expiration = '+ 10 minutes')
 	{
-		$session = $this->getSession('Nette.Application/requests');
-		do {
-			$key = Nette\Utils\Random::generate(5);
-		} while (isset($session[$key]));
-
-		$session[$key] = array($this->getUser()->getId(), $this->request);
-		$session->setExpiration($expiration, $key);
-		return $key;
+		if (!$this->requestStorage) {
+			throw new Nette\InvalidStateException('Service IRequestStorage has not been set.');
+		}
+		return $this->requestStorage->store($this->request, $this->httpRequest->getUrl(), $expiration);
 	}
 
 
@@ -1091,17 +1090,11 @@ public function storeRequest($expiration = '+ 10 minutes')
 	 */
 	public function restoreRequest($key)
 	{
-		$session = $this->getSession('Nette.Application/requests');
-		if (!isset($session[$key]) || ($session[$key][0] !== NULL && $session[$key][0] !== $this->getUser()->getId())) {
-			return;
+		if (!$this->requestStorage) {
+			throw new Nette\InvalidStateException('Service IRequestStorage has not been set.');
+		} elseif ($url = $this->requestStorage->getUrl($key)) {
+			$this->redirectUrl($url);
 		}
-		$request = clone $session[$key][1];
-		unset($session[$key]);
-		$request->setFlag(Application\Request::RESTORED, TRUE);
-		$params = $request->getParameters();
-		$params[Http\Session::FLASH_KEY] = $this->getSession()->getFlashId();
-		$request->setParameters($params);
-		$this->sendResponse(new Responses\ForwardResponse($request));
 	}
 
 
@@ -1298,7 +1291,8 @@ public function getFlashSession()
 
 
 	public function injectPrimary(Nette\DI\Container $context = NULL, Nette\Application\IPresenterFactory $presenterFactory = NULL, Nette\Application\IRouter $router = NULL,
-		Http\IRequest $httpRequest, Http\IResponse $httpResponse, Http\Session $session = NULL, Nette\Security\User $user = NULL, ITemplateFactory $templateFactory = NULL)
+		Http\IRequest $httpRequest, Http\IResponse $httpResponse, Http\Session $session = NULL, Nette\Security\User $user = NULL, ITemplateFactory $templateFactory = NULL,
+		Application\IRequestStorage $requestStorage = NULL)
 	{
 		if ($this->presenterFactory !== NULL) {
 			throw new Nette\InvalidStateException("Method " . __METHOD__ . " is intended for initialization and should not be called more than once.");
@@ -1312,6 +1306,7 @@ public function injectPrimary(Nette\DI\Container $context = NULL, Nette\Applicat
 		$this->session = $session;
 		$this->user = $user;
 		$this->templateFactory = $templateFactory;
+		$this->requestStorage = $requestStorage;
 	}
 
 

tests/Application/Presenter.storeRequest().phpt

@@ -81,21 +81,18 @@ class MockUser extends Security\User
 	}
 }
 
-class MockHttpRequest extends Http\Request
-{
-	public function __construct() {}
-}
-
 
 $presenter = new TestPresenter();
 $presenter->injectPrimary(
 	NULL,
 	NULL,
 	NULL,
-	new MockHttpRequest,
+	new Http\Request($url = new Http\UrlScript),
 	new Http\Response,
 	$session = new MockSession,
-	$user = new MockUser
+	$user = new MockUser,
+	NULL,
+	new Application\RequestStorage($session, $user)
 );
 
 $section = $session->testSection = new MockSessionSection($session);
@@ -110,4 +107,6 @@ Assert::same($expiration, $section->testExpiration);
 Assert::same($key, $section->testExpirationVariables);
 Assert::same($key, $section->testedKeyExistence);
 Assert::same($key, $section->storedKey);
-Assert::same(array($user->getId(), $applicationRequest), $section->storedValue);
+Assert::equal($applicationRequest, $section->storedValue[0]);
+Assert::equal($url, $section->storedValue[1]);
+Assert::same($user->getId(), $section->storedValue[2]);

tests/Application/RequestStorage.phpt

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * Test: Nette\Application\RequestStorage
+ *
+ * @author     Martin Major
+ */
+
+use Nette\Http,
+	Nette\Application,
+	Nette\Security\Identity,
+	Tester\Assert;
+
+
+require __DIR__ . '/../bootstrap.php';
+require __DIR__ . '/mocks.php';
+
+
+$url = 'https://www.example.com/my/address?with=parameter';
+
+$httpRequest = new Http\Request(new Http\UrlScript($url));
+
+$session = new MockSession($httpRequest, new Http\Response);
+$session->mockSection = new MockSessionSection;
+$session->mockFlashSection = new MockSessionSection;
+
+$user = new MockUser;
+$user->mockIdentity = new Identity(42);
+
+$requestStorage = new Application\RequestStorage($session, $user);
+
+$applicationRequest = new Application\Request('Presenter', 'action', array('param' => 'value'));
+
+$key = $requestStorage->store($applicationRequest, $httpRequest->getUrl());
+
+
+// restore key
+Assert::null($requestStorage->getUrl('bad_key'));
+
+$redirect = $requestStorage->getUrl($key);
+Assert::same($url . '&_fid=x', $redirect);
+
+
+// redirect to original URL
+$httpRequest = new Http\Request(new Http\UrlScript($redirect));
+
+$application = new Application\Application(new MockPresenterFactory, new MockRouter, $httpRequest, new MockResponse, $requestStorage);
+
+$applicationRequest->setFlag(Application\Request::RESTORED);
+Assert::equal($applicationRequest, $application->createInitialRequest());