Source for file Uri.php

Documentation is available at Uri.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:
26:
27: /**
28: * URI Syntax (RFC 3986).
29: *
30: * <pre>
31: * http://user:pass@nette.org:8042/en/manual.html?name=param#fragment
32: * \__/^^^\_________________________/\_____________/^\________/^\______/
33: * | | | | |
34: * scheme authority path query fragment
35: * </pre>
36: *
37: * - authority: [user[:pass]@]host[:port]
38: * - hostUri: http://user:pass@nette.org:8042
39: *
40: * @author David Grudl
41: * @copyright Copyright (c) 2004, 2009 David Grudl
42: * @package Nette\Web
43: */
44: class Uri extends Object
45: {
46: /** @var array */
47: static public $defaultPorts = array(
48: 'http' => 80,
49: 'https' => 443,
50: 'ftp' => 21,
51: 'news' => 119,
52: 'nntp' => 119,
53: );
54:
55: /** @var string */
56: public $scheme = '';
57:
58: /** @var string */
59: public $user = '';
60:
61: /** @var string */
62: public $pass = '';
63:
64: /** @var string */
65: public $host = '';
66:
67: /** @var int */
68: public $port = NULL;
69:
70: /** @var string */
71: public $path = '';
72:
73: /** @var string */
74: public $query = '';
75:
76: /** @var string */
77: public $fragment = '';
78:
79:
80:
81: /**
82: * @param string URL
83: * @throws InvalidArgumentException
84: */
85: public function __construct($uri = NULL)
86: {
87: if ($uri !== NULL) {
88: $parts = @parse_url($uri); // intentionally @
89: if ($parts === FALSE) {
90: throw new InvalidArgumentException("Malformed or unsupported URI '$uri'.");
91: }
92:
93: foreach ($parts as $key => $val) {
94: $this->$key = $val;
95: }
96:
97: if (!$this->port && isset(self::$defaultPorts[$this->scheme])) {
98: $this->port = self::$defaultPorts[$this->scheme];
99: }
100: }
101: }
102:
103:
104:
105: /**
106: * Returns the entire URI including query string and fragment.
107: * @return string
108: */
109: public function getAbsoluteUri()
110: {
111: return $this->scheme . '://' . $this->getAuthority() . $this->path
112: . ($this->query == '' ? '' : '?' . $this->query)
113: . ($this->fragment == '' ? '' : '#' . $this->fragment);
114: }
115:
116:
117:
118: /**
119: * Returns the [user[:pass]@]host[:port] part of URI.
120: * @return string
121: */
122: public function getAuthority()
123: {
124: $authority = $this->host;
125: if ($this->port && isset(self::$defaultPorts[$this->scheme]) && $this->port !== self::$defaultPorts[$this->scheme]) {
126: $authority .= ':' . $this->port;
127: }
128:
129: if ($this->user != '' && $this->scheme !== 'http' && $this->scheme !== 'https') {
130: $authority = $this->user . ($this->pass == '' ? '' : ':' . $this->pass) . '@' . $authority;
131: }
132:
133: return $authority;
134: }
135:
136:
137:
138: /**
139: * Returns the scheme and authority part of URI.
140: * @return string
141: */
142: public function getHostUri()
143: {
144: return $this->scheme . '://' . $this->getAuthority();
145: }
146:
147:
148:
149: /**
150: * URI comparsion (this object must be in canonical form).
151: * @param string
152: * @return bool
153: */
154: public function isEqual($uri)
155: {
156: // compare host + path
157: $part = self::unescape(strtok($uri, '?#'), '%/');
158: if (strncmp($part, '//', 2) === 0) { // absolute URI without scheme
159: if ($part !== '//' . $this->getAuthority() . $this->path) return FALSE;
160:
161: } elseif (strncmp($part, '/', 1) === 0) { // absolute path
162: if ($part !== $this->path) return FALSE;
163:
164: } else {
165: if ($part !== $this->scheme . '://' . $this->getAuthority() . $this->path) return FALSE;
166: }
167:
168: // compare query strings
169: $part = (string) strtok('?#');
170: if ($part !== '') {
171: $tmp = explode('&', self::unescape(strtr($part, '+', ' '), '%&'));
172: sort($tmp);
173: $part = implode('&', $tmp);
174: }
175: return $part === $this->query;
176: }
177:
178:
179:
180: /**
181: * Transform to canonical form.
182: * @return void
183: */
184: public function canonicalize()
185: {
186: $this->path = $this->path == '' ? '/' : self::unescape($this->path, '%/');
187:
188: $this->host = strtolower(rawurldecode($this->host));
189:
190: if ($this->query !== '') {
191: $tmp = explode('&', self::unescape(strtr($this->query, '+', ' '), '%&'));
192: sort($tmp);
193: $this->query = implode('&', $tmp);
194: }
195: }
196:
197:
198:
199: /**
200: * @return string
201: */
202: public function __toString()
203: {
204: return $this->getAbsoluteUri();
205: }
206:
207:
208:
209: /**
210: * Similar to rawurldecode, but preserve reserved chars encoded.
211: * @param string to decode
212: * @param string reserved characters
213: * @return string
214: */
215: public static function unescape($s, $reserved = '%;/?:@&=+$,')
216: {
217: // reserved (@see RFC 2396) = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" | "$" | ","
218: // within a path segment, the characters "/", ";", "=", "?" are reserved
219: // within a query component, the characters ";", "/", "?", ":", "@", "&", "=", "+", ",", "$" are reserved.
220: $offset = 0;
221: $max = strlen($s) - 3;
222: $res = '';
223: do {
224: $pos = strpos($s, '%', $offset);
225: if ($pos === FALSE || $pos > $max) {
226: return $res . substr($s, $offset);
227: }
228: $ch = chr(hexdec($s[$pos + 1] . $s[$pos + 2]));
229: if (strpos($reserved, $ch) === FALSE) {
230: $res .= substr($s, $offset, $pos - $offset) . $ch;
231: } else {
232: $res .= substr($s, $offset, $pos - $offset + 3);
233: }
234: $offset = $pos + 3;
235: } while (TRUE);
236: }
237:
238: }

Source for file Uri.php

Namespaces