1 <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
5 * An open source application development framework for PHP 4.3.2 or newer
8 * @author ExpressionEngine Dev Team
9 * @copyright Copyright (c) 2008 - 2009, EllisLab, Inc.
10 * @license http://codeigniter.com/user_guide/license.html
11 * @link http://codeigniter.com
16 // ------------------------------------------------------------------------
21 * Parses URIs and determines routing
23 * @package CodeIgniter
24 * @subpackage Libraries
26 * @author ExpressionEngine Dev Team
27 * @link http://codeigniter.com/user_guide/libraries/uri.html
31 var $keyval = array();
33 var $segments = array();
34 var $rsegments = array();
39 * Simply globalizes the $RTR object. The front
40 * loads the Router class early on so it's not available
41 * normally as other classes are.
47 $this->config =& load_class('Config');
48 log_message('debug', "URI Class Initialized");
52 // --------------------------------------------------------------------
60 function _fetch_uri_string()
62 if (strtoupper($this->config->item('uri_protocol')) == 'AUTO')
64 // If the URL has a question mark then it's simplest to just
65 // build the URI string from the zero index of the $_GET array.
66 // This avoids having to deal with $_SERVER variables, which
67 // can be unreliable in some environments
68 if (is_array($_GET) && count($_GET) == 1 && trim(key($_GET), '/') != '')
70 $this->uri_string = key($_GET);
74 // Is there a PATH_INFO variable?
75 // Note: some servers seem to have trouble with getenv() so we'll test it two ways
76 $path = (isset($_SERVER['PATH_INFO'])) ? $_SERVER['PATH_INFO'] : @getenv('PATH_INFO');
77 if (trim($path, '/') != '' && $path != "/".SELF)
79 $this->uri_string = $path;
83 // No PATH_INFO?... What about QUERY_STRING?
84 $path = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : @getenv('QUERY_STRING');
85 if (trim($path, '/') != '')
87 $this->uri_string = $path;
91 // No QUERY_STRING?... Maybe the ORIG_PATH_INFO variable exists?
92 $path = str_replace($_SERVER['SCRIPT_NAME'], '', (isset($_SERVER['ORIG_PATH_INFO'])) ? $_SERVER['ORIG_PATH_INFO'] : @getenv('ORIG_PATH_INFO'));
93 if (trim($path, '/') != '' && $path != "/".SELF)
95 // remove path and script information so we have good URI data
96 $this->uri_string = $path;
100 // We've exhausted all our options...
101 $this->uri_string = '';
105 $uri = strtoupper($this->config->item('uri_protocol'));
107 if ($uri == 'REQUEST_URI')
109 $this->uri_string = $this->_parse_request_uri();
113 $this->uri_string = (isset($_SERVER[$uri])) ? $_SERVER[$uri] : @getenv($uri);
116 // If the URI contains only a slash we'll kill it
117 if ($this->uri_string == '/')
119 $this->uri_string = '';
123 // --------------------------------------------------------------------
126 * Parse the REQUEST_URI
128 * Due to the way REQUEST_URI works it usually contains path info
129 * that makes it unusable as URI data. We'll trim off the unnecessary
130 * data, hopefully arriving at a valid URI that we can use.
135 function _parse_request_uri()
137 if ( ! isset($_SERVER['REQUEST_URI']) OR $_SERVER['REQUEST_URI'] == '')
142 $request_uri = preg_replace("|/(.*)|", "\\1", str_replace("\\", "/", $_SERVER['REQUEST_URI']));
144 if ($request_uri == '' OR $request_uri == SELF)
149 $fc_path = FCPATH.SELF;
150 if (strpos($request_uri, '?') !== FALSE)
155 $parsed_uri = explode("/", $request_uri);
158 foreach(explode("/", $fc_path) as $segment)
160 if (isset($parsed_uri[$i]) && $segment == $parsed_uri[$i])
166 $parsed_uri = implode("/", array_slice($parsed_uri, $i));
168 if ($parsed_uri != '')
170 $parsed_uri = '/'.$parsed_uri;
176 // --------------------------------------------------------------------
179 * Filter segments for malicious characters
185 function _filter_uri($str)
187 if ($str != '' && $this->config->item('permitted_uri_chars') != '' && $this->config->item('enable_query_strings') == FALSE)
189 // preg_quote() in PHP 5.3 escapes -, so the str_replace() and addition of - to preg_quote() is to maintain backwards
190 // compatibility as many are unaware of how characters in the permitted_uri_chars will be parsed as a regex pattern
191 if ( ! preg_match("|^[".str_replace(array('\\-', '\-'), '-', preg_quote($this->config->item('permitted_uri_chars'), '-'))."]+$|i", $str))
193 show_error('The URI you submitted has disallowed characters.', 400);
197 // Convert programatic characters to entities
198 $bad = array('$', '(', ')', '%28', '%29');
199 $good = array('$', '(', ')', '(', ')');
201 return str_replace($bad, $good, $str);
204 // --------------------------------------------------------------------
207 * Remove the suffix from the URL if needed
212 function _remove_url_suffix()
214 if ($this->config->item('url_suffix') != "")
216 $this->uri_string = preg_replace("|".preg_quote($this->config->item('url_suffix'))."$|", "", $this->uri_string);
220 // --------------------------------------------------------------------
223 * Explode the URI Segments. The individual segments will
224 * be stored in the $this->segments array.
229 function _explode_segments()
231 foreach(explode("/", preg_replace("|/*(.+?)/*$|", "\\1", $this->uri_string)) as $val)
233 // Filter segments for security
234 $val = trim($this->_filter_uri($val));
238 $this->segments[] = $val;
243 // --------------------------------------------------------------------
247 * This function re-indexes the $this->segment array so that it
248 * starts at 1 rather than 0. Doing so makes it simpler to
249 * use functions like $this->uri->segment(n) since there is
250 * a 1:1 relationship between the segment array and the actual segments.
255 function _reindex_segments()
257 array_unshift($this->segments, NULL);
258 array_unshift($this->rsegments, NULL);
259 unset($this->segments[0]);
260 unset($this->rsegments[0]);
263 // --------------------------------------------------------------------
266 * Fetch a URI Segment
268 * This function returns the URI segment based on the number provided.
275 function segment($n, $no_result = FALSE)
277 return ( ! isset($this->segments[$n])) ? $no_result : $this->segments[$n];
280 // --------------------------------------------------------------------
283 * Fetch a URI "routed" Segment
285 * This function returns the re-routed URI segment (assuming routing rules are used)
286 * based on the number provided. If there is no routing this function returns the
287 * same result as $this->segment()
294 function rsegment($n, $no_result = FALSE)
296 return ( ! isset($this->rsegments[$n])) ? $no_result : $this->rsegments[$n];
299 // --------------------------------------------------------------------
302 * Generate a key value pair from the URI string
304 * This function generates and associative array of URI data starting
305 * at the supplied segment. For example, if this is your URI:
307 * example.com/user/search/name/joe/location/UK/gender/male
309 * You can use this function to generate an array with this prototype:
318 * @param integer the starting segment number
319 * @param array an array of default values
322 function uri_to_assoc($n = 3, $default = array())
324 return $this->_uri_to_assoc($n, $default, 'segment');
327 * Identical to above only it uses the re-routed segment array
330 function ruri_to_assoc($n = 3, $default = array())
332 return $this->_uri_to_assoc($n, $default, 'rsegment');
335 // --------------------------------------------------------------------
338 * Generate a key value pair from the URI string or Re-routed URI string
341 * @param integer the starting segment number
342 * @param array an array of default values
343 * @param string which array we should use
346 function _uri_to_assoc($n = 3, $default = array(), $which = 'segment')
348 if ($which == 'segment')
350 $total_segments = 'total_segments';
351 $segment_array = 'segment_array';
355 $total_segments = 'total_rsegments';
356 $segment_array = 'rsegment_array';
359 if ( ! is_numeric($n))
364 if (isset($this->keyval[$n]))
366 return $this->keyval[$n];
369 if ($this->$total_segments() < $n)
371 if (count($default) == 0)
377 foreach ($default as $val)
379 $retval[$val] = FALSE;
384 $segments = array_slice($this->$segment_array(), ($n - 1));
389 foreach ($segments as $seg)
393 $retval[$lastval] = $seg;
397 $retval[$seg] = FALSE;
404 if (count($default) > 0)
406 foreach ($default as $val)
408 if ( ! array_key_exists($val, $retval))
410 $retval[$val] = FALSE;
415 // Cache the array for reuse
416 $this->keyval[$n] = $retval;
420 // --------------------------------------------------------------------
423 * Generate a URI string from an associative array
427 * @param array an associative array of key/values
430 function assoc_to_uri($array)
433 foreach ((array)$array as $key => $val)
439 return implode('/', $temp);
442 // --------------------------------------------------------------------
445 * Fetch a URI Segment and add a trailing slash
452 function slash_segment($n, $where = 'trailing')
454 return $this->_slash_segment($n, $where, 'segment');
457 // --------------------------------------------------------------------
460 * Fetch a URI Segment and add a trailing slash
467 function slash_rsegment($n, $where = 'trailing')
469 return $this->_slash_segment($n, $where, 'rsegment');
472 // --------------------------------------------------------------------
475 * Fetch a URI Segment and add a trailing slash - helper function
483 function _slash_segment($n, $where = 'trailing', $which = 'segment')
485 if ($where == 'trailing')
490 elseif ($where == 'leading')
500 return $leading.$this->$which($n).$trailing;
503 // --------------------------------------------------------------------
511 function segment_array()
513 return $this->segments;
516 // --------------------------------------------------------------------
519 * Routed Segment Array
524 function rsegment_array()
526 return $this->rsegments;
529 // --------------------------------------------------------------------
532 * Total number of segments
537 function total_segments()
539 return count($this->segments);
542 // --------------------------------------------------------------------
545 * Total number of routed segments
550 function total_rsegments()
552 return count($this->rsegments);
555 // --------------------------------------------------------------------
558 * Fetch the entire URI string
563 function uri_string()
565 return $this->uri_string;
569 // --------------------------------------------------------------------
572 * Fetch the entire Re-routed URI string
577 function ruri_string()
579 return '/'.implode('/', $this->rsegment_array()).'/';
585 /* End of file URI.php */
586 /* Location: ./system/libraries/URI.php */