joomla 1.56的uri.php解释

希望和大家分享，如果写错了，一定要留言呀

1. <?php
2. defined('JPATH_BASE') or die();
3. //uri >= url
4. class JURI extends JObject  //继承jobject,jobject不难理解
5. {
6.     var $_uri = null; /*没有分析过的uri*/
7.     var $_scheme = null; /*协议*/
8.     var $_host = null; /*主机*/
9.     var $_port = null; /*端口*/
10.     var $_user = null; /*用户名*/
11.     var $_pass = null; /*密码*/
12.     var $_path = null; /*路径*/
13.     var $_query = null; /*请求*/
14.     var $_fragment = null; /*anchor锚*/
15.     var $_vars = array (); /*query中的变量设置*/
16. 
    
17.     function __construct($uri = null){//如果设置了uri,分析uri并设置到属性
18.         if ($uri !== null) {
19.             $this->parse($uri);//分析uri
20.         }
21.     }
22. 
    
23.     function &getInstance($uri = 'SERVER') {//取得一个实例，默认是现在的uri
24.         static $instances = array();//避免重复运行
25. 
    
26.         if (!isset ($instances[$uri])) {//避免重复
27.             if ($uri == 'SERVER'){//如果默认
28.                 //判断是否为SSL,(https)
29.                 if (isset($_SERVER['HTTPS']) && !emptyempty($_SERVER['HTTPS']) && (strtolower($_SERVER['HTTPS']) != 'off')) {
30.                     $https = 's://';
31.                 } else {
32.                     $https = '://';
33.                 }
34.                 //判断IIS和apache,同时有php_self和request_uri->apache否则iis
35.                 if (!emptyempty ($_SERVER['PHP_SELF']) && !emptyempty ($_SERVER['REQUEST_URI'])) {
36.                     //设置完整的uri
37.                     $theURI = 'http' . $https . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
38.                 //没有request_uri我们就假设是IIS拉
39.                 } else{
40.                     $theURI = 'http' . $https . $_SERVER['HTTP_HOST'] . $_SERVER['SCRIPT_NAME'];
41.                     if (isset($_SERVER['QUERY_STRING']) && !emptyempty($_SERVER['QUERY_STRING'])) {
42.                         $theURI .= '?' . $_SERVER['QUERY_STRING'];
43.                     }
44.                 }
45.                 //做细致的检查
46.                 $theURI = urldecode($theURI);
47.                 $theURI = str_replace('"', '"',$theURI);
48.                 $theURI = str_replace('<', '<',$theURI);
49.                 $theURI = str_replace('>', '>',$theURI);
50.                 //取消执行语句
51.                 $theURI = preg_replace('/eval/((.*)/)/', '', $theURI);
52.                 $theURI = preg_replace('/[///"///'][//s]*javascript:(.*)[///"///']/', '""', $theURI);
53.             }else{
54.                 //已经设置了$uri
55.                 $theURI = $uri;
56.             }
57.             //创建一个新对象
58.             $instances[$uri] = new JURI($theURI);
59.         }
60.         return $instances[$uri];//返回对象
61.     }
62. 
    
63.     function base($pathonly = false){
64.         static $base;
65. 
    
66.         if (!isset($base)){//如果头一回
67.             $config =& JFactory::getConfig(); //返回配置对象
68.             $live_site = $config->getValue('config.live_site');//取得live_site
69.             if(trim($live_site) != '') {//判断是否为空
70.                 $uri =& JURI::getInstance($live_site);//创建实例
71.                 //前缀设置
72.                 $base['prefix'] = $uri->toString( array('scheme', 'host', 'port'));
73.                 //路径设置
74.                 $base['path'] = rtrim($uri->toString( array('path')), '///');
75.                 if(JPATH_BASE == JPATH_ADMINISTRATOR) {//这路径在defines.php定义
76.                     $base['path'] .= '/administrator';
77.                 }
78.             } else {
79.                 //创建默认实例
80.                 $uri             =& JURI::getInstance();
81.                 //前缀设置
82.                 $base['prefix'] = $uri->toString( array('scheme', 'host', 'port'));
83.                 //查看接口类型interface between web server and PHP
84.                 //如果不是CGI同时又有request_uri，那就断定就是apache cgi
85.                 if (strpos(php_sapi_name(), 'cgi') !== false && !emptyempty($_SERVER['REQUEST_URI'])) {
86.                     //路径设置
87.                     $base['path'] =  rtrim(dirname($_SERVER['PHP_SELF']), '///');
88.                 } else {
89.                     //其他的
90.                     $base['path'] =  rtrim(dirname($_SERVER['SCRIPT_NAME']), '///');
91.                 }
92.             }
93.         }
94.         //返回一个路径或有前缀的路径，默认有前缀
95.         return $pathonly === false ? $base['prefix'].$base['path'].'/' : $base['path'];
96.     }
97. 
    
98.     function root($pathonly = false, $path = null){
99.         static $root;
100. 
     
101.         if(!isset($root)) {//头一回
102.             //使用base产生的URI来产生一个对象
103.             $uri            =& JURI::getInstance(JURI::base());
104.             $root['prefix'] = $uri->toString( array('scheme', 'host', 'port') );
105.             $root['path']   = rtrim($uri->toString( array('path') ), '///');
106.         }
107.         if(isset($path)) {//如果设置了path
108.             $root['path']    = $path;
109.         }
110.         return $pathonly === false ? $root['prefix'].$root['path'].'/' : $root['path'];
111.     }
112.     
113.     function current(){
114.         static $current;
115.         //和上面很类似，返回现在的uri,但不是'/'结尾
116.         if (!isset($current)){
117.             $uri     = & JURI::getInstance();
118.             $current = $uri->toString( array('scheme', 'host', 'port', 'path'));
119.         }
120.         return $current;
121.     }
122. 
     
123.     function parse($uri){
124.         $retval = false;//返回值
125.         
126.         $this->_uri = $uri; //保存原来的uri到_uri中
127.         if ($_parts = $this->_parseURL($uri)) { //兼容的分析函数
128.             $retval = true; //返回成功则把返回值设置为TRUE
129.         }
130.         //把&替换成&
131.         if(isset ($_parts['query']) && strpos($_parts['query'], '&')) {
132.             $_parts['query'] = str_replace('&', '&', $_parts['query']);
133.         }
134.         //设置所有属性
135.         $this->_scheme = isset ($_parts['scheme']) ? $_parts['scheme'] : null;
136.         $this->_user = isset ($_parts['user']) ? $_parts['user'] : null;
137.         $this->_pass = isset ($_parts['pass']) ? $_parts['pass'] : null;
138.         $this->_host = isset ($_parts['host']) ? $_parts['host'] : null;
139.         $this->_port = isset ($_parts['port']) ? $_parts['port'] : null;
140.         $this->_path = isset ($_parts['path']) ? $_parts['path'] : null;
141.         $this->_query = isset ($_parts['query'])? $_parts['query'] : null;
142.         $this->_fragment = isset ($_parts['fragment']) ? $_parts['fragment'] : null;
143.         if(isset ($_parts['query'])) parse_str($_parts['query'], $this->_vars);
144.         return $retval;
145.     }
146. 
     
147.     //设置一下参数，返回一个串
148.     function toString($parts = array('scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment'))
149.     {
150.         $query = $this->getQuery(); //make sure the query is created
151. 
     
152.         $uri = '';
153.         $uri .= in_array('scheme', $parts)  ? (!emptyempty($this->_scheme) ? $this->_scheme.'://' : '') : '';
154.         $uri .= in_array('user', $parts)    ? $this->_user : '';
155.         $uri .= in_array('pass', $parts)    ? (!emptyempty ($this->_pass) ? ':' : '') .$this->_pass. (!emptyempty ($this->_user) ? '@' : '') : '';
156.         $uri .= in_array('host', $parts)    ? $this->_host : '';
157.         $uri .= in_array('port', $parts)    ? (!emptyempty ($this->_port) ? ':' : '').$this->_port : '';
158.         $uri .= in_array('path', $parts)    ? $this->_path : '';
159.         $uri .= in_array('query', $parts)   ? (!emptyempty ($query) ? '?'.$query : '') : '';
160.         $uri .= in_array('fragment', $parts)? (!emptyempty ($this->_fragment) ? '#'.$this->_fragment : '') : '';
161. 
     
162.         return $uri;
163.     }
164. 
     
165.     //设置一个query变量，如果本来就有返回本来那个，并设置成新的
166.     function setVar($name, $value)
167.     {
168.         $tmp = @$this->_vars[$name];
169.         $this->_vars[$name] = $value;
170. 
     
171.         //empty the query
172.         $this->_query = null;
173. 
     
174.         return $tmp;
175.     }
176.     
177.     //返回query变量
178.     function getVar($name = null, $default=null)
179.     {
180.         if(isset($this->_vars[$name])) {
181.             return $this->_vars[$name];
182.         }
183.         return $default;
184.     }
185.     
186.     //删除一个query变量
187.     function delVar($name)
188.     {
189.         if (in_array($name, array_keys($this->_vars)))
190.         {
191.             unset ($this->_vars[$name]);
192. 
     
193.             //empty the query
194.             $this->_query = null;
195.         }
196.     }
197.     
198.     //设置_vars,可接受数组和串
199.     function setQuery($query)
200.     {
201.         if(!is_array($query)) {
202.             if(strpos($query, '&') !== false)
203.             {
204.                $query = str_replace('&','&',$query);
205.             }
206.             parse_str($query, $this->_vars);
207.         }
208. 
     
209.         if(is_array($query)) {
210.             $this->_vars = $query;
211.         }
212. 
     
213.         //empty the query
214.         $this->_query = null;
215.     }
216. 
     
217.     //返回query,可以是数组也可以是串，是串的话通过buildquery建立
218.     function getQuery($toArray = false)
219.     {
220.         if($toArray) {
221.             return $this->_vars;
222.         }
223. 
     
224.         //If the query is empty build it first
225.         if(is_null($this->_query)) {
226.             $this->_query = $this->buildQuery($this->_vars);
227.         }
228. 
     
229.         return $this->_query;
230.     }
231. 
     
232.     //建立串，递归
233.     function buildQuery ($params, $akey = null)
234.     {
235.         if ( !is_array($params) || count($params) == 0 ) {
236.             return false;
237.         }
238. 
     
239.         $out = array();
240. 
     
241.         //reset in case we are looping
242.         if( !isset($akey) && !count($out) )  {
243.             unset($out);
244.             $out = array();
245.         }
246. 
     
247.         foreach ( $params as $key => $val )
248.         {
249.             if ( is_array($val) ) {
250.                 $out[] = JURI::buildQuery($val,$key);
251.                 continue;
252.             }
253. 
     
254.             $thekey = ( !$akey ) ? $key : $akey.'['.$key.']';
255.             $out[] = $thekey."=".urlencode($val);
256.         }
257. 
     
258.         return implode("&",$out);
259.     }
260. 
     
261. //下面比较简单不解释了
262.     function getScheme() {
263.         return $this->_scheme;
264.     }
265. 
     
266.     function setScheme($scheme) {
267.         $this->_scheme = $scheme;
268.     }
269. 
     
270.     function getUser() {
271.         return $this->_user;
272.     }
273. 
     
274.     function setUser($user) {
275.         $this->_user = $user;
276.     }
277. 
     
278.     function getPass() {
279.         return $this->_pass;
280.     }
281. 
     
282.     function setPass($pass) {
283.         $this->_pass = $pass;
284.     }
285. 
     
286.     function getHost() {
287.         return $this->_host;
288.     }
289. 
     
290.     function setHost($host) {
291.         $this->_host = $host;
292.     }
293. 
     
294.     function getPort() {
295.         return (isset ($this->_port)) ? $this->_port : null;
296.     }
297. 
     
298.     function setPort($port) {
299.         $this->_port = $port;
300.     }
301. 
     
302.     function getPath() {
303.         return $this->_path;
304.     }
305. 
     
306.     function setPath($path) {
307.         $this->_path = $this->_cleanPath($path);
308.     }
309. 
     
310.     function getFragment() {
311.         return $this->_fragment;
312.     }
313. 
     
314.     function setFragment($anchor) {
315.         $this->_fragment = $anchor;
316.     }
317. 
     
318.     function isSSL() {
319.         return $this->getScheme() == 'https' ? true : false;
320.     }
321. 
     
322.     /**
323.      * Resolves //, ../ and ./ from a path and returns
324.      * the result. Eg:
325.      *
326.      * /foo/bar/../boo.php  => /foo/boo.php
327.      * /foo/bar/../../boo.php => /boo.php
328.      * /foo/bar/.././/boo.php => /foo/boo.php
329.      *
330.      * @access  private
331.      * @param   string $uri The URI path to clean
332.      * @return  string Cleaned and resolved URI path
333.      * @since   1.5
334.      */
335.     function _cleanPath($path)
336.     {
337.         $path = explode('/', preg_replace('#(/+)#', '/', $path));
338. 
     
339.         for ($i = 0; $i < count($path); $i ++) {
340.             if ($path[$i] == '.') {
341.                 unset ($path[$i]);
342.                 $path = array_values($path);
343.                 $i --;
344. 
     
345.             }
346.             elseif ($path[$i] == '..' AND ($i > 1 OR ($i == 1 AND $path[0] != ''))) {
347.                 unset ($path[$i]);
348.                 unset ($path[$i -1]);
349.                 $path = array_values($path);
350.                 $i -= 2;
351. 
     
352.             }
353.             elseif ($path[$i] == '..' AND $i == 1 AND $path[0] == '') {
354.                 unset ($path[$i]);
355.                 $path = array_values($path);
356.                 $i --;
357. 
     
358.             } else {
359.                 continue;
360.             }
361.         }
362. 
     
363.         return implode('/', $path);
364.     }
365. 
     
366.     /**
367.      * Backwards compatibility function for parse_url function
368.      *
369.      * This function solves different bugs in PHP versions lower then
370.      * 4.4, will be deprecated in future versions.
371.      *
372.      * @access  private
373.      * @return  array Associative array containing the URL parts
374.      * @since   1.5
375.      * @see parse_url()
376.      */
377.     function _parseURL($uri)
378.     {
379.         $parts = array();
380.         if (version_compare( phpversion(), '4.4' ) < 0)
381.         {
382.             $regex = "<^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(//?([^#]*))?(#(.*))?>";
383.             $matches = array();
384.             preg_match($regex, $uri, $matches, PREG_OFFSET_CAPTURE);
385. 
     
386.             $authority = @$matches[4][0];
387.             if (strpos($authority, '@') !== false) {
388.                 $authority = explode('@', $authority);
389.                 @list($parts['user'], $parts['pass']) = explode(':', $authority[0]);
390.                 $authority = $authority[1];
391.             }
392. 
     
393.             if (strpos($authority, ':') !== false) {
394.                 $authority = explode(':', $authority);
395.                 $parts['host'] = $authority[0];
396.                 $parts['port'] = $authority[1];
397.             } else {
398.                 $parts['host'] = $authority;
399.             }
400. 
     
401.             $parts['scheme'] = @$matches[2][0];
402.             $parts['path'] = @$matches[5][0];
403.             $parts['query'] = @$matches[7][0];
404.             $parts['fragment'] = @$matches[9][0];
405.         }
406.         else
407.         {
408.             $parts = @parse_url($uri);
409.         }
410.         return $parts;
411.     }
412. 
     
413. 
     
414. }
415.