[TASK] Re-work/simplify copyright header in PHP files - Part 3
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Utility / HttpUtility.php
1 <?php
2 namespace TYPO3\CMS\Core\Utility;
3
4 /**
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16 /**
17 * HTTP Utility class
18 *
19 * @author Ingo Renner <ingo@typo3.org>
20 */
21 class HttpUtility {
22
23 // HTTP Headers, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for Details
24 const HTTP_STATUS_100 = 'HTTP/1.1 100 Continue';
25 const HTTP_STATUS_101 = 'HTTP/1.1 101 Switching Protocols';
26 const HTTP_STATUS_200 = 'HTTP/1.1 200 OK';
27 const HTTP_STATUS_201 = 'HTTP/1.1 201 Created';
28 const HTTP_STATUS_202 = 'HTTP/1.1 202 Accepted';
29 const HTTP_STATUS_203 = 'HTTP/1.1 203 Non-Authoritative Information';
30 const HTTP_STATUS_204 = 'HTTP/1.1 204 No Content';
31 const HTTP_STATUS_205 = 'HTTP/1.1 205 Reset Content';
32 const HTTP_STATUS_206 = 'HTTP/1.1 206 Partial Content';
33 const HTTP_STATUS_300 = 'HTTP/1.1 300 Multiple Choices';
34 const HTTP_STATUS_301 = 'HTTP/1.1 301 Moved Permanently';
35 const HTTP_STATUS_302 = 'HTTP/1.1 302 Found';
36 const HTTP_STATUS_303 = 'HTTP/1.1 303 See Other';
37 const HTTP_STATUS_304 = 'HTTP/1.1 304 Not Modified';
38 const HTTP_STATUS_305 = 'HTTP/1.1 305 Use Proxy';
39 const HTTP_STATUS_307 = 'HTTP/1.1 307 Temporary Redirect';
40 const HTTP_STATUS_400 = 'HTTP/1.1 400 Bad Request';
41 const HTTP_STATUS_401 = 'HTTP/1.1 401 Unauthorized';
42 const HTTP_STATUS_402 = 'HTTP/1.1 402 Payment Required';
43 const HTTP_STATUS_403 = 'HTTP/1.1 403 Forbidden';
44 const HTTP_STATUS_404 = 'HTTP/1.1 404 Not Found';
45 const HTTP_STATUS_405 = 'HTTP/1.1 405 Method Not Allowed';
46 const HTTP_STATUS_406 = 'HTTP/1.1 406 Not Acceptable';
47 const HTTP_STATUS_407 = 'HTTP/1.1 407 Proxy Authentication Required';
48 const HTTP_STATUS_408 = 'HTTP/1.1 408 Request Timeout';
49 const HTTP_STATUS_409 = 'HTTP/1.1 409 Conflict';
50 const HTTP_STATUS_410 = 'HTTP/1.1 410 Gone';
51 const HTTP_STATUS_411 = 'HTTP/1.1 411 Length Required';
52 const HTTP_STATUS_412 = 'HTTP/1.1 412 Precondition Failed';
53 const HTTP_STATUS_413 = 'HTTP/1.1 413 Request Entity Too Large';
54 const HTTP_STATUS_414 = 'HTTP/1.1 414 Request-URI Too Long';
55 const HTTP_STATUS_415 = 'HTTP/1.1 415 Unsupported Media Type';
56 const HTTP_STATUS_416 = 'HTTP/1.1 416 Requested Range Not Satisfiable';
57 const HTTP_STATUS_417 = 'HTTP/1.1 417 Expectation Failed';
58 const HTTP_STATUS_500 = 'HTTP/1.1 500 Internal Server Error';
59 const HTTP_STATUS_501 = 'HTTP/1.1 501 Not Implemented';
60 const HTTP_STATUS_502 = 'HTTP/1.1 502 Bad Gateway';
61 const HTTP_STATUS_503 = 'HTTP/1.1 503 Service Unavailable';
62 const HTTP_STATUS_504 = 'HTTP/1.1 504 Gateway Timeout';
63 const HTTP_STATUS_505 = 'HTTP/1.1 505 Version Not Supported';
64 // URL Schemes
65 const SCHEME_HTTP = 1;
66 const SCHEME_HTTPS = 2;
67 /**
68 * Sends a redirect header response and exits. Additionally the URL is
69 * checked and if needed corrected to match the format required for a
70 * Location redirect header. By default the HTTP status code sent is
71 * a 'HTTP/1.1 303 See Other'.
72 *
73 * @param string $url The target URL to redirect to
74 * @param string $httpStatus An optional HTTP status header. Default is 'HTTP/1.1 303 See Other'
75 */
76 static public function redirect($url, $httpStatus = self::HTTP_STATUS_303) {
77 self::setResponseCode($httpStatus);
78 header('Location: ' . \TYPO3\CMS\Core\Utility\GeneralUtility::locationHeaderUrl($url));
79 die;
80 }
81
82 /**
83 * Set a specific response code like 404.
84 *
85 * @param string $httpStatus One of the HTTP_STATUS_* class class constants, default to self::HTTP_STATUS_303
86 * @return void
87 */
88 static public function setResponseCode($httpStatus = self::HTTP_STATUS_303) {
89 header($httpStatus);
90 }
91
92 /**
93 * Set a specific response code and exit script execution.
94 *
95 * @param string $httpStatus One of the HTTP_STATUS_* class class constants, default to self::HTTP_STATUS_303
96 * @return void
97 */
98 static public function setResponseCodeAndExit($httpStatus = self::HTTP_STATUS_303) {
99 self::setResponseCode($httpStatus);
100 die;
101 }
102
103 /**
104 * Builds a URL string from an array with the URL parts, as e.g. output by parse_url().
105 *
106 * @param array $urlParts
107 * @return string
108 * @see http://www.php.net/parse_url
109 */
110 static public function buildUrl(array $urlParts) {
111 return (isset($urlParts['scheme']) ? $urlParts['scheme'] . '://' : '') .
112 (isset($urlParts['user']) ? $urlParts['user'] .
113 (isset($urlParts['pass']) ? ':' . $urlParts['pass'] : '') . '@' : '') .
114 (isset($urlParts['host']) ? $urlParts['host'] : '') .
115 (isset($urlParts['port']) ? ':' . $urlParts['port'] : '') .
116 (isset($urlParts['path']) ? $urlParts['path'] : '') .
117 (isset($urlParts['query']) ? '?' . $urlParts['query'] : '') .
118 (isset($urlParts['fragment']) ? '#' . $urlParts['fragment'] : '');
119 }
120
121 }