Response divided into storage which doesn't emit data to the browser and ResponseEmitter (BC break!)

Author: dg

src/Http/IResponse.php

@@ -181,11 +181,6 @@ function redirect(string $url, int $code = self::S302_FOUND): void;
 	 */
 	function setExpiration(?string $expire);
 
-	/**
-	 * Checks if headers have been sent.
-	 */
-	function isSent(): bool;
-
 	/**
 	 * Returns value of an HTTP header.
 	 */

src/Http/Response.php

@@ -34,40 +34,54 @@ final class Response implements IResponse
 	/** @var bool Whether the cookie is hidden from client-side */
 	public $cookieHttpOnly = true;
 
-	/** @var bool Whether warn on possible problem with data in output buffer */
-	public $warnOnBuffer = true;
-
-	/** @var bool  Send invisible garbage for IE 6? */
-	private static $fixIE = true;
-
 	/** @var int HTTP response code */
 	private $code = self::S200_OK;
 
+	/** @var string */
+	private $reason = self::REASON_PHRASES[self::S200_OK];
+
+	/** @var string */
+	private $version = '1.1';
+
+	/** @var array of [name, values] */
+	private $headers = [];
+
+	/** @var string|\Closure */
+	private $body = '';
 
-	public function __construct()
+
+	/**
+	 * Sets HTTP protocol version.
+	 * @return static
+	 */
+	public function setProtocolVersion(string $version)
 	{
-		if (is_int($code = http_response_code())) {
-			$this->code = $code;
-		}
+		$this->version = $version;
+		return $this;
+	}
+
+
+	/**
+	 * Returns HTTP protocol version.
+	 */
+	public function getProtocolVersion(): string
+	{
+		return $this->version;
 	}
 
 
 	/**
 	 * Sets HTTP response code.
 	 * @return static
 	 * @throws Nette\InvalidArgumentException  if code is invalid
-	 * @throws Nette\InvalidStateException  if HTTP headers have been sent
 	 */
 	public function setCode(int $code, string $reason = null)
 	{
 		if ($code < 100 || $code > 599) {
 			throw new Nette\InvalidArgumentException("Bad HTTP response '$code'.");
 		}
-		self::checkHeaders();
 		$this->code = $code;
-		$protocol = $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.1';
-		$reason = $reason ?? self::REASON_PHRASES[$code] ?? 'Unknown status';
-		header("$protocol $code $reason");
+		$this->reason = $reason ?? self::REASON_PHRASES[$code] ?? 'Unknown status';
 		return $this;
 	}
 
@@ -81,20 +95,24 @@ public function getCode(): int
 	}
 
 
+	/**
+	 * Returns HTTP reason phrase.
+	 */
+	public function getReasonPhrase(): string
+	{
+		return $this->reason;
+	}
+
+
 	/**
 	 * Sends a HTTP header and replaces a previous one.
 	 * @return static
-	 * @throws Nette\InvalidStateException  if HTTP headers have been sent
 	 */
 	public function setHeader(string $name, ?string $value)
 	{
-		self::checkHeaders();
-		if ($value === null) {
-			header_remove($name);
-		} elseif (strcasecmp($name, 'Content-Length') === 0 && ini_get('zlib.output_compression')) {
-			// ignore, PHP bug #44164
-		} else {
-			header($name . ': ' . $value, true, $this->code);
+		unset($this->headers[strtolower($name)]);
+		if ($value !== null) { // supports null for back compatibility
+			$this->addHeader($name, $value);
 		}
 		return $this;
 	}
@@ -103,32 +121,52 @@ public function setHeader(string $name, ?string $value)
 	/**
 	 * Adds HTTP header.
 	 * @return static
-	 * @throws Nette\InvalidStateException  if HTTP headers have been sent
 	 */
 	public function addHeader(string $name, string $value)
 	{
-		self::checkHeaders();
-		header($name . ': ' . $value, false, $this->code);
+		$lname = strtolower($name);
+		$this->headers[$lname][0] = $name;
+		$this->headers[$lname][1][] = trim(preg_replace('#[^\x20-\x7E\x80-\xFE]#', '', $value));
 		return $this;
 	}
 
 
 	/**
 	 * @return static
-	 * @throws Nette\InvalidStateException  if HTTP headers have been sent
 	 */
 	public function deleteHeader(string $name)
 	{
-		self::checkHeaders();
-		header_remove($name);
+		unset($this->headers[strtolower($name)]);
 		return $this;
 	}
 
 
+	/**
+	 * Returns value of an HTTP header.
+	 */
+	public function getHeader(string $name): ?string
+	{
+		return $this->headers[strtolower($name)][1][0] ?? null;
+	}
+
+
+	/**
+	 * Returns a associative array of headers to sent.
+	 * @return string[][]
+	 */
+	public function getHeaders(): array
+	{
+		$res = [];
+		foreach ($this->headers as $info) {
+			$res[$info[0]] = $info[1];
+		}
+		return $res;
+	}
+
+
 	/**
 	 * Sends a Content-type HTTP header.
 	 * @return static
-	 * @throws Nette\InvalidStateException  if HTTP headers have been sent
 	 */
 	public function setContentType(string $type, string $charset = null)
 	{
@@ -139,23 +177,23 @@ public function setContentType(string $type, string $charset = null)
 
 	/**
 	 * Redirects to a new URL. Note: call exit() after it.
-	 * @throws Nette\InvalidStateException  if HTTP headers have been sent
 	 */
 	public function redirect(string $url, int $code = self::S302_FOUND): void
 	{
 		$this->setCode($code);
 		$this->setHeader('Location', $url);
 		if (preg_match('#^https?:|^\s*+[a-z0-9+.-]*+[^:]#i', $url)) {
 			$escapedUrl = htmlspecialchars($url, ENT_IGNORE | ENT_QUOTES, 'UTF-8');
-			echo "<h1>Redirect</h1>\n\n<p><a href=\"$escapedUrl\">Please click here to continue</a>.</p>";
+			$this->setBody("<h1>Redirect</h1>\n\n<p><a href=\"$escapedUrl\">Please click here to continue</a>.</p>");
+		} else {
+			$this->setBody('');
 		}
 	}
 
 
 	/**
 	 * Sets the time (like '20 minutes') before a page cached on a browser expires, null means "must-revalidate".
 	 * @return static
-	 * @throws Nette\InvalidStateException  if HTTP headers have been sent
 	 */
 	public function setExpiration(?string $time)
 	{
@@ -174,115 +212,63 @@ public function setExpiration(?string $time)
 
 
 	/**
-	 * Checks if headers have been sent.
+	 * Sends a cookie.
+	 * @param  string|int|\DateTimeInterface $time  expiration time, value 0 means "until the browser is closed"
+	 * @return static
 	 */
-	public function isSent(): bool
+	public function setCookie(string $name, string $value, $expire, string $path = null, string $domain = null, bool $secure = null, bool $httpOnly = null, string $sameSite = null)
 	{
-		return headers_sent();
-	}
-
+		$path = $path === null ? $this->cookiePath : $path;
+		$domain = $domain === null ? $this->cookieDomain : $domain;
+		$secure = $secure === null ? $this->cookieSecure : $secure;
+		$httpOnly = $httpOnly === null ? $this->cookieHttpOnly : $httpOnly;
 
-	/**
-	 * Returns value of an HTTP header.
-	 */
-	public function getHeader(string $header): ?string
-	{
-		$header .= ':';
-		$len = strlen($header);
-		foreach (headers_list() as $item) {
-			if (strncasecmp($item, $header, $len) === 0) {
-				return ltrim(substr($item, $len));
-			}
+		if (strpbrk($name . $path . $domain . $sameSite, "=,; \t\r\n\013\014") !== false) {
+			throw new Nette\InvalidArgumentException('Cookie cannot contain any of the following \'=,; \t\r\n\013\014\'');
 		}
-		return null;
-	}
 
+		$value = $name . '=' . rawurlencode($value)
+			. ($expire ? '; expires=' . Helpers::formatDate($expire) : '')
+			. ($expire ? '; Max-Age=' . (DateTime::from($expire)->format('U') - time()) : '')
+			. ($domain ? '; domain=' . $domain : '')
+			. ($path ? '; path=' . $path : '')
+			. ($secure ? '; secure' : '')
+			. ($httpOnly ? '; HttpOnly' : '')
+			. ($sameSite ? '; SameSite=' . $sameSite : '');
 
-	/**
-	 * Returns a associative array of headers to sent.
-	 * @return string[][]
-	 */
-	public function getHeaders(): array
-	{
-		$headers = [];
-		foreach (headers_list() as $header) {
-			$pair = explode(': ', $header);
-			$headers[$pair[0]][] = $pair[1];
-		}
-		return $headers;
+		$this->addHeader('Set-Cookie', $value);
+		return $this;
 	}
 
 
-	public function __destruct()
+	/**
+	 * Deletes a cookie.
+	 */
+	public function deleteCookie(string $name, string $path = null, string $domain = null, bool $secure = null): void
 	{
-		if (
-			self::$fixIE
-			&& strpos($_SERVER['HTTP_USER_AGENT'] ?? '', 'MSIE ') !== false
-			&& in_array($this->code, [400, 403, 404, 405, 406, 408, 409, 410, 500, 501, 505], true)
-			&& preg_match('#^text/html(?:;|$)#', (string) $this->getHeader('Content-Type'))
-		) {
-			echo Nette\Utils\Random::generate(2000, " \t\r\n"); // sends invisible garbage for IE
-			self::$fixIE = false;
-		}
+		$this->setCookie($name, '', 0, $path, $domain, $secure);
 	}
 
 
 	/**
-	 * Sends a cookie.
-	 * @param  string|int|\DateTimeInterface $time  expiration time, value 0 means "until the browser is closed"
+	 * @param  string|\Closure  $body
 	 * @return static
-	 * @throws Nette\InvalidStateException  if HTTP headers have been sent
 	 */
-	public function setCookie(string $name, string $value, $time, string $path = null, string $domain = null, bool $secure = null, bool $httpOnly = null, string $sameSite = null)
+	public function setBody($body)
 	{
-		self::checkHeaders();
-		$options = [
-			'expires' => $time ? (int) DateTime::from($time)->format('U') : 0,
-			'path' => $path === null ? $this->cookiePath : $path,
-			'domain' => $domain === null ? $this->cookieDomain : $domain,
-			'secure' => $secure === null ? $this->cookieSecure : $secure,
-			'httponly' => $httpOnly === null ? $this->cookieHttpOnly : $httpOnly,
-			'samesite' => $sameSite,
-		];
-		if (PHP_VERSION_ID >= 70300) {
-			setcookie($name, $value, $options);
-		} else {
-			setcookie(
-				$name,
-				$value,
-				$options['expires'],
-				$options['path'] . ($sameSite ? "; SameSite=$sameSite" : ''),
-				$options['domain'],
-				$options['secure'],
-				$options['httponly']
-			);
+		if (!is_string($body) && !$body instanceof \Closure) {
+			throw new Nette\InvalidArgumentException('Body must be string or Closure.');
 		}
+		$this->body = $body;
 		return $this;
 	}
 
 
 	/**
-	 * Deletes a cookie.
-	 * @throws Nette\InvalidStateException  if HTTP headers have been sent
+	 * @return string|\Closure
 	 */
-	public function deleteCookie(string $name, string $path = null, string $domain = null, bool $secure = null): void
+	public function getBody()
 	{
-		$this->setCookie($name, '', 0, $path, $domain, $secure);
-	}
-
-
-	private function checkHeaders(): void
-	{
-		if (PHP_SAPI === 'cli') {
-		} elseif (headers_sent($file, $line)) {
-			throw new Nette\InvalidStateException('Cannot send header after HTTP headers have been sent' . ($file ? " (output started at $file:$line)." : '.'));
-
-		} elseif (
-			$this->warnOnBuffer &&
-			ob_get_length() &&
-			!array_filter(ob_get_status(true), function (array $i): bool { return !$i['chunk_size']; })
-		) {
-			trigger_error('Possible problem: you are sending a HTTP header while already having some data in output buffer. Try Tracy\OutputDebugger or start session earlier.');
-		}
+		return $this->body;
 	}
 }