Source for file HttpResponse.php

Documentation is available at HttpResponse.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Web
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Object.php';
24:
25: require_once dirname(__FILE__) . '/../Web/IHttpResponse.php';
26:
27:
28:
29: /**
30: * HttpResponse class.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette\Web
35: */
36: final class HttpResponse extends Object implements IHttpResponse
37: {
38: /** @var bool Send invisible garbage for IE 6? */
39: private static $fixIE = TRUE;
40:
41: /** @var string The domain in which the cookie will be available */
42: public $cookieDomain = '';
43:
44: /** @var string The path in which the cookie will be available */
45: public $cookiePath = '';
46:
47: /** @var string The path in which the cookie will be available */
48: public $cookieSecure = FALSE;
49:
50: /** @var int HTTP response code */
51: private $code = self::S200_OK;
52:
53:
54:
55: /**
56: * Sets HTTP response code.
57: * @param int
58: * @return bool
59: * @throws InvalidArgumentException if code is invalid
60: * @throws InvalidStateException if HTTP headers have been sent
61: */
62: public function setCode($code)
63: {
64: $code = (int) $code;
65:
66: static $allowed = array(
67: 200=>1, 201=>1, 202=>1, 203=>1, 204=>1, 205=>1, 206=>1,
68: 300=>1, 301=>1, 302=>1, 303=>1, 304=>1, 307=>1,
69: 400=>1, 401=>1, 403=>1, 404=>1, 406=>1, 408=>1, 410=>1, 412=>1, 415=>1, 416=>1,
70: 500=>1, 501=>1, 503=>1, 505=>1
71: );
72:
73: if (!isset($allowed[$code])) {
74: throw new InvalidArgumentException("Bad HTTP response '$code'.");
75:
76: } elseif (headers_sent($file, $line)) {
77: throw new InvalidStateException("Cannot set HTTP code after HTTP headers have been sent" . ($file ? " (output started at $file:$line)." : "."));
78:
79: } else {
80: $this->code = $code;
81: $protocol = isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.1';
82: header($protocol . ' ' . $code, TRUE, $code);
83: return TRUE;
84: }
85: }
86:
87:
88:
89: /**
90: * Returns HTTP response code.
91: * @return int
92: */
93: public function getCode()
94: {
95: return $this->code;
96: }
97:
98:
99:
100: /**
101: * Sends a HTTP header and replaces a previous one.
102: * @param string header name
103: * @param string header value
104: * @return void
105: * @throws InvalidStateException if HTTP headers have been sent
106: */
107: public function setHeader($name, $value, $replace = TRUE)
108: {
109: if (headers_sent($file, $line)) {
110: throw new InvalidStateException("Cannot send header after HTTP headers have been sent" . ($file ? " (output started at $file:$line)." : "."));
111: }
112:
113: header($name . ': ' . $value, $replace, $this->code);
114: }
115:
116:
117:
118: /**
119: * Adds HTTP header.
120: * @param string header name
121: * @param string header value
122: * @return void
123: * @throws InvalidStateException if HTTP headers have been sent
124: */
125: public function addHeader($name, $value)
126: {
127: if (headers_sent($file, $line)) {
128: throw new InvalidStateException("Cannot send header after HTTP headers have been sent" . ($file ? " (output started at $file:$line)." : "."));
129: }
130:
131: header($name . ': ' . $value, FALSE, $this->code);
132: }
133:
134:
135:
136: /**
137: * Sends a Content-type HTTP header.
138: * @param string mime-type
139: * @param string charset
140: * @return void
141: * @throws InvalidStateException if HTTP headers have been sent
142: */
143: public function setContentType($type, $charset = NULL)
144: {
145: $this->setHeader('Content-Type', $type . ($charset ? '; charset=' . $charset : ''));
146: }
147:
148:
149:
150: /**
151: * Redirects to a new URL. Note: call exit() after it.
152: * @param string URL
153: * @param int HTTP code
154: * @return void
155: * @throws InvalidStateException if HTTP headers have been sent
156: */
157: public function redirect($url, $code = self::S302_FOUND)
158: {
159: $this->setCode($code);
160: $this->setHeader('Location', $url);
161: $url = htmlSpecialChars($url);
162: echo "<h1>Redirect</h1>\n\n<p><a href=\"$url\">Please click here to continue</a>.</p>";
163: }
164:
165:
166:
167: /**
168: * Sets the number of seconds before a page cached on a browser expires.
169: * @param int timestamp or number of seconds
170: * @return void
171: * @throws InvalidStateException if HTTP headers have been sent
172: */
173: public function expire($time)
174: {
175: if ($time > 0) {
176: if ($time <= Tools::YEAR) {
177: $time += time();
178: }
179: $this->setHeader('Cache-Control', 'max-age=' . ($time - time()). ',must-revalidate');
180: $this->setHeader('Expires', self::date($time));
181:
182: } else { // no cache
183: $this->setHeader('Expires', 'Mon, 23 Jan 1978 10:00:00 GMT');
184: $this->setHeader('Cache-Control', 's-maxage=0, max-age=0, must-revalidate');
185: }
186: }
187:
188:
189:
190: /**
191: * Checks if headers have been sent.
192: * @return bool
193: */
194: public function isSent()
195: {
196: return headers_sent();
197: }
198:
199:
200:
201: /**
202: * Returns a list of headers to sent.
203: * @return array
204: */
205: public function getHeaders()
206: {
207: $headers = array();
208: foreach (headers_list() as $header) {
209: $a = strpos($header, ':');
210: $headers[substr($header, 0, $a)] = substr($header, $a + 2);
211: }
212: return $headers;
213: }
214:
215:
216:
217: /**
218: * Returns HTTP valid date format.
219: * @param int timestamp
220: * @return string
221: */
222: public static function date($time = NULL)
223: {
224: return gmdate('D, d M Y H:i:s \G\M\T', $time === NULL ? time() : $time);
225: }
226:
227:
228:
229: /**
230: * Enables compression. (warning: may not work)
231: * @return bool
232: */
233: public function enableCompression()
234: {
235: if (headers_sent()) return FALSE;
236:
237: $headers = $this->getHeaders();
238: if (isset($headers['Content-Encoding'])) {
239: return FALSE; // called twice
240: }
241:
242: $ok = ob_gzhandler('', PHP_OUTPUT_HANDLER_START);
243: if ($ok === FALSE) {
244: return FALSE; // not allowed
245: }
246:
247: if (function_exists('ini_set')) {
248: ini_set('zlib.output_compression', 'Off');
249: ini_set('zlib.output_compression_level', '6');
250: }
251: ob_start('ob_gzhandler');
252: return TRUE;
253: }
254:
255:
256:
257: /**
258: * @return void
259: */
260: public function __destruct()
261: {
262: if (self::$fixIE) {
263: // Sends invisible garbage for IE.
264: if (!isset($_SERVER['HTTP_USER_AGENT']) || strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE ') === FALSE) return;
265: if (!in_array($this->code, array(400, 403, 404, 405, 406, 408, 409, 410, 500, 501, 505), TRUE)) return;
266: $headers = $this->getHeaders();
267: if (isset($headers['Content-Type']) && $headers['Content-Type'] !== 'text/html') return;
268: $s = " \t\r\n";
269: for ($i = 2e3; $i; $i--) echo $s{rand(0, 3)};
270: self::$fixIE = FALSE;
271: }
272: }
273:
274:
275:
276: /**
277: * Sends a cookie.
278: * @param string name of the cookie
279: * @param string value
280: * @param int expiration as unix timestamp or number of seconds; Value 0 means "until the browser is closed"
281: * @param string
282: * @param string
283: * @param bool
284: * @return void
285: * @throws InvalidStateException if HTTP headers have been sent
286: */
287: public function setCookie($name, $value, $expire, $path = NULL, $domain = NULL, $secure = NULL)
288: {
289: if (headers_sent($file, $line)) {
290: throw new InvalidStateException("Cannot set cookie after HTTP headers have been sent" . ($file ? " (output started at $file:$line)." : "."));
291: }
292:
293: setcookie(
294: $name,
295: $value,
296: $expire > 0 && $expire <= Tools::YEAR ? $expire + time() : $expire,
297: $path === NULL ? $this->cookiePath : (string) $path,
298: $domain === NULL ? $this->cookieDomain : (string) $domain, // . '; httponly'
299: $secure === NULL ? $this->cookieSecure : (bool) $secure,
300: TRUE // added in PHP 5.2.0.
301: );
302: }
303:
304:
305:
306: /**
307: * Deletes a cookie.
308: * @param string name of the cookie.
309: * @param string
310: * @param string
311: * @param bool
312: * @return void
313: * @throws InvalidStateException if HTTP headers have been sent
314: */
315: public function deleteCookie($name, $path = NULL, $domain = NULL, $secure = NULL)
316: {
317: if (headers_sent($file, $line)) {
318: throw new InvalidStateException("Cannot delete cookie after HTTP headers have been sent" . ($file ? " (output started at $file:$line)." : "."));
319: }
320:
321: setcookie(
322: $name,
323: FALSE,
324: 254400000,
325: $path === NULL ? $this->cookiePath : (string) $path,
326: $domain === NULL ? $this->cookieDomain : (string) $domain, // . '; httponly'
327: $secure === NULL ? $this->cookieSecure : (bool) $secure,
328: TRUE // added in PHP 5.2.0.
329: );
330: }
331:
332: }

Source for file HttpResponse.php

Namespaces