/libraries/joomla/uri/uri.php
PHP | 821 lines | 357 code | 79 blank | 385 comment | 54 complexity | 68591dd6d4bddfad0a047c116af66eba MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1, BSD-3-Clause
- <?php
- /**
- * @package Joomla.Platform
- * @subpackage Uri
- *
- * @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
- * @license GNU General Public License version 2 or later; see LICENSE
- */
- defined('JPATH_PLATFORM') or die;
- /**
- * JUri Class
- *
- * This class serves two purposes. First it parses a URI and provides a common interface
- * for the Joomla Platform to access and manipulate a URI. Second it obtains the URI of
- * the current executing script from the server regardless of server.
- *
- * @package Joomla.Platform
- * @subpackage Uri
- * @since 11.1
- */
- class JUri
- {
- /**
- * @var string Original URI
- * @since 12.1
- */
- protected $uri = null;
- /**
- * @var string Protocol
- * @since 12.1
- */
- protected $scheme = null;
- /**
- * @var string Host
- * @since 12.1
- */
- protected $host = null;
- /**
- * @var integer Port
- * @since 12.1
- */
- protected $port = null;
- /**
- * @var string Username
- * @since 12.1
- */
- protected $user = null;
- /**
- * @var string Password
- * @since 12.1
- */
- protected $pass = null;
- /**
- * @var string Path
- * @since 12.1
- */
- protected $path = null;
- /**
- * @var string Query
- * @since 12.1
- */
- protected $query = null;
- /**
- * @var string Anchor
- * @since 12.1
- */
- protected $fragment = null;
- /**
- * @var array Query variable hash
- * @since 12.1
- */
- protected $vars = array();
- /**
- * @var array An array of JUri instances.
- * @since 11.1
- */
- protected static $instances = array();
- /**
- * @var array The current calculated base url segments.
- * @since 11.1
- */
- protected static $base = array();
- /**
- * @var array The current calculated root url segments.
- * @since 11.1
- */
- protected static $root = array();
- /**
- * @var string The current url.
- * @since 11.1
- */
- protected static $current;
- /**
- * Constructor.
- * You can pass a URI string to the constructor to initialise a specific URI.
- *
- * @param string $uri The optional URI string
- *
- * @since 11.1
- */
- public function __construct($uri = null)
- {
- if (!is_null($uri))
- {
- $this->parse($uri);
- }
- }
- /**
- * Magic method to get the string representation of the URI object.
- *
- * @return string
- *
- * @since 11.1
- */
- public function __toString()
- {
- return $this->toString();
- }
- /**
- * Returns the global JUri object, only creating it
- * if it doesn't already exist.
- *
- * @param string $uri The URI to parse. [optional: if null uses script URI]
- *
- * @return JUri The URI object.
- *
- * @since 11.1
- */
- public static function getInstance($uri = 'SERVER')
- {
- if (empty(self::$instances[$uri]))
- {
- // Are we obtaining the URI from the server?
- if ($uri == 'SERVER')
- {
- // Determine if the request was over SSL (HTTPS).
- if (isset($_SERVER['HTTPS']) && !empty($_SERVER['HTTPS']) && (strtolower($_SERVER['HTTPS']) != 'off'))
- {
- $https = 's://';
- }
- else
- {
- $https = '://';
- }
- /*
- * Since we are assigning the URI from the server variables, we first need
- * to determine if we are running on apache or IIS. If PHP_SELF and REQUEST_URI
- * are present, we will assume we are running on apache.
- */
- if (!empty($_SERVER['PHP_SELF']) && !empty($_SERVER['REQUEST_URI']))
- {
- // To build the entire URI we need to prepend the protocol, and the http host
- // to the URI string.
- $theURI = 'http' . $https . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
- }
- else
- {
- /*
- * Since we do not have REQUEST_URI to work with, we will assume we are
- * running on IIS and will therefore need to work some magic with the SCRIPT_NAME and
- * QUERY_STRING environment variables.
- *
- * IIS uses the SCRIPT_NAME variable instead of a REQUEST_URI variable... thanks, MS
- */
- $theURI = 'http' . $https . $_SERVER['HTTP_HOST'] . $_SERVER['SCRIPT_NAME'];
- // If the query string exists append it to the URI string
- if (isset($_SERVER['QUERY_STRING']) && !empty($_SERVER['QUERY_STRING']))
- {
- $theURI .= '?' . $_SERVER['QUERY_STRING'];
- }
- }
- // Extra cleanup to remove invalid chars in the URL to prevent injections through the Host header
- $theURI = str_replace(array("'", '"', '<', '>'), array("%27", "%22", "%3C", "%3E"), $theURI);
- }
- else
- {
- // We were given a URI
- $theURI = $uri;
- }
- self::$instances[$uri] = new JUri($theURI);
- }
- return self::$instances[$uri];
- }
- /**
- * Returns the base URI for the request.
- *
- * @param boolean $pathonly If false, prepend the scheme, host and port information. Default is false.
- *
- * @return string The base URI string
- *
- * @since 11.1
- */
- public static function base($pathonly = false)
- {
- // Get the base request path.
- if (empty(self::$base))
- {
- $config = JFactory::getConfig();
- $live_site = $config->get('live_site');
- if (trim($live_site) != '')
- {
- $uri = self::getInstance($live_site);
- self::$base['prefix'] = $uri->toString(array('scheme', 'host', 'port'));
- self::$base['path'] = rtrim($uri->toString(array('path')), '/\\');
- if (defined('JPATH_BASE') && defined('JPATH_ADMINISTRATOR'))
- {
- if (JPATH_BASE == JPATH_ADMINISTRATOR)
- {
- self::$base['path'] .= '/administrator';
- }
- }
- }
- else
- {
- $uri = self::getInstance();
- self::$base['prefix'] = $uri->toString(array('scheme', 'host', 'port'));
- if (strpos(php_sapi_name(), 'cgi') !== false && !ini_get('cgi.fix_pathinfo') && !empty($_SERVER['REQUEST_URI']))
- {
- // PHP-CGI on Apache with "cgi.fix_pathinfo = 0"
- // We shouldn't have user-supplied PATH_INFO in PHP_SELF in this case
- // because PHP will not work with PATH_INFO at all.
- $script_name = $_SERVER['PHP_SELF'];
- }
- else
- {
- // Others
- $script_name = $_SERVER['SCRIPT_NAME'];
- }
- self::$base['path'] = rtrim(dirname($script_name), '/\\');
- }
- }
- return $pathonly === false ? self::$base['prefix'] . self::$base['path'] . '/' : self::$base['path'];
- }
- /**
- * Returns the root URI for the request.
- *
- * @param boolean $pathonly If false, prepend the scheme, host and port information. Default is false.
- * @param string $path The path
- *
- * @return string The root URI string.
- *
- * @since 11.1
- */
- public static function root($pathonly = false, $path = null)
- {
- // Get the scheme
- if (empty(self::$root))
- {
- $uri = self::getInstance(self::base());
- self::$root['prefix'] = $uri->toString(array('scheme', 'host', 'port'));
- self::$root['path'] = rtrim($uri->toString(array('path')), '/\\');
- }
- // Get the scheme
- if (isset($path))
- {
- self::$root['path'] = $path;
- }
- return $pathonly === false ? self::$root['prefix'] . self::$root['path'] . '/' : self::$root['path'];
- }
- /**
- * Returns the URL for the request, minus the query.
- *
- * @return string
- *
- * @since 11.1
- */
- public static function current()
- {
- // Get the current URL.
- if (empty(self::$current))
- {
- $uri = self::getInstance();
- self::$current = $uri->toString(array('scheme', 'host', 'port', 'path'));
- }
- return self::$current;
- }
- /**
- * Method to reset class static members for testing and other various issues.
- *
- * @return void
- *
- * @since 11.1
- */
- public static function reset()
- {
- self::$instances = array();
- self::$base = array();
- self::$root = array();
- self::$current = '';
- }
- /**
- * Parse a given URI and populate the class fields.
- *
- * @param string $uri The URI string to parse.
- *
- * @return boolean True on success.
- *
- * @since 11.1
- */
- public function parse($uri)
- {
- // Set the original URI to fall back on
- $this->uri = $uri;
- /*
- * Parse the URI and populate the object fields. If URI is parsed properly,
- * set method return value to true.
- */
- $parts = JString::parse_url($uri);
- $retval = ($parts) ? true : false;
- // We need to replace & with & for parse_str to work right...
- if (isset($parts['query']) && strpos($parts['query'], '&'))
- {
- $parts['query'] = str_replace('&', '&', $parts['query']);
- }
- $this->scheme = isset($parts['scheme']) ? $parts['scheme'] : null;
- $this->user = isset($parts['user']) ? $parts['user'] : null;
- $this->pass = isset($parts['pass']) ? $parts['pass'] : null;
- $this->host = isset($parts['host']) ? $parts['host'] : null;
- $this->port = isset($parts['port']) ? $parts['port'] : null;
- $this->path = isset($parts['path']) ? $parts['path'] : null;
- $this->query = isset($parts['query']) ? $parts['query'] : null;
- $this->fragment = isset($parts['fragment']) ? $parts['fragment'] : null;
- // Parse the query
- if (isset($parts['query']))
- {
- parse_str($parts['query'], $this->vars);
- }
- return $retval;
- }
- /**
- * Returns full uri string.
- *
- * @param array $parts An array specifying the parts to render.
- *
- * @return string The rendered URI string.
- *
- * @since 11.1
- */
- public function toString(array $parts = array('scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment'))
- {
- // Make sure the query is created
- $query = $this->getQuery();
- $uri = '';
- $uri .= in_array('scheme', $parts) ? (!empty($this->scheme) ? $this->scheme . '://' : '') : '';
- $uri .= in_array('user', $parts) ? $this->user : '';
- $uri .= in_array('pass', $parts) ? (!empty($this->pass) ? ':' : '') . $this->pass . (!empty($this->user) ? '@' : '') : '';
- $uri .= in_array('host', $parts) ? $this->host : '';
- $uri .= in_array('port', $parts) ? (!empty($this->port) ? ':' : '') . $this->port : '';
- $uri .= in_array('path', $parts) ? $this->path : '';
- $uri .= in_array('query', $parts) ? (!empty($query) ? '?' . $query : '') : '';
- $uri .= in_array('fragment', $parts) ? (!empty($this->fragment) ? '#' . $this->fragment : '') : '';
- return $uri;
- }
- /**
- * Adds a query variable and value, replacing the value if it
- * already exists and returning the old value.
- *
- * @param string $name Name of the query variable to set.
- * @param string $value Value of the query variable.
- *
- * @return string Previous value for the query variable.
- *
- * @since 11.1
- */
- public function setVar($name, $value)
- {
- $tmp = isset($this->vars[$name]) ? $this->vars[$name] : null;
- $this->vars[$name] = $value;
- // Empty the query
- $this->query = null;
- return $tmp;
- }
- /**
- * Checks if variable exists.
- *
- * @param string $name Name of the query variable to check.
- *
- * @return boolean True if the variable exists.
- *
- * @since 11.1
- */
- public function hasVar($name)
- {
- return array_key_exists($name, $this->vars);
- }
- /**
- * Returns a query variable by name.
- *
- * @param string $name Name of the query variable to get.
- * @param string $default Default value to return if the variable is not set.
- *
- * @return array Query variables.
- *
- * @since 11.1
- */
- public function getVar($name, $default = null)
- {
- if (array_key_exists($name, $this->vars))
- {
- return $this->vars[$name];
- }
- return $default;
- }
- /**
- * Removes an item from the query string variables if it exists.
- *
- * @param string $name Name of variable to remove.
- *
- * @return void
- *
- * @since 11.1
- */
- public function delVar($name)
- {
- if (array_key_exists($name, $this->vars))
- {
- unset($this->vars[$name]);
- // Empty the query
- $this->query = null;
- }
- }
- /**
- * Sets the query to a supplied string in format:
- * foo=bar&x=y
- *
- * @param mixed $query The query string or array.
- *
- * @return void
- *
- * @since 11.1
- */
- public function setQuery($query)
- {
- if (is_array($query))
- {
- $this->vars = $query;
- }
- else
- {
- if (strpos($query, '&') !== false)
- {
- $query = str_replace('&', '&', $query);
- }
- parse_str($query, $this->vars);
- }
- // Empty the query
- $this->query = null;
- }
- /**
- * Returns flat query string.
- *
- * @param boolean $toArray True to return the query as a key => value pair array.
- *
- * @return string Query string.
- *
- * @since 11.1
- */
- public function getQuery($toArray = false)
- {
- if ($toArray)
- {
- return $this->vars;
- }
- // If the query is empty build it first
- if (is_null($this->query))
- {
- $this->query = self::buildQuery($this->vars);
- }
- return $this->query;
- }
- /**
- * Build a query from a array (reverse of the PHP parse_str()).
- *
- * @param array $params The array of key => value pairs to return as a query string.
- *
- * @return string The resulting query string.
- *
- * @see parse_str()
- * @since 11.1
- */
- public static function buildQuery(array $params)
- {
- if (count($params) == 0)
- {
- return false;
- }
- return urldecode(http_build_query($params, '', '&'));
- }
- /**
- * Get URI scheme (protocol)
- * ie. http, https, ftp, etc...
- *
- * @return string The URI scheme.
- *
- * @since 11.1
- */
- public function getScheme()
- {
- return $this->scheme;
- }
- /**
- * Set URI scheme (protocol)
- * ie. http, https, ftp, etc...
- *
- * @param string $scheme The URI scheme.
- *
- * @return void
- *
- * @since 11.1
- */
- public function setScheme($scheme)
- {
- $this->scheme = $scheme;
- }
- /**
- * Get URI username
- * Returns the username, or null if no username was specified.
- *
- * @return string The URI username.
- *
- * @since 11.1
- */
- public function getUser()
- {
- return $this->user;
- }
- /**
- * Set URI username.
- *
- * @param string $user The URI username.
- *
- * @return void
- *
- * @since 11.1
- */
- public function setUser($user)
- {
- $this->user = $user;
- }
- /**
- * Get URI password
- * Returns the password, or null if no password was specified.
- *
- * @return string The URI password.
- *
- * @since 11.1
- */
- public function getPass()
- {
- return $this->pass;
- }
- /**
- * Set URI password.
- *
- * @param string $pass The URI password.
- *
- * @return void
- *
- * @since 11.1
- */
- public function setPass($pass)
- {
- $this->pass = $pass;
- }
- /**
- * Get URI host
- * Returns the hostname/ip or null if no hostname/ip was specified.
- *
- * @return string The URI host.
- *
- * @since 11.1
- */
- public function getHost()
- {
- return $this->host;
- }
- /**
- * Set URI host.
- *
- * @param string $host The URI host.
- *
- * @return void
- *
- * @since 11.1
- */
- public function setHost($host)
- {
- $this->host = $host;
- }
- /**
- * Get URI port
- * Returns the port number, or null if no port was specified.
- *
- * @return integer The URI port number.
- *
- * @since 11.1
- */
- public function getPort()
- {
- return (isset($this->port)) ? $this->port : null;
- }
- /**
- * Set URI port.
- *
- * @param integer $port The URI port number.
- *
- * @return void
- *
- * @since 11.1
- */
- public function setPort($port)
- {
- $this->port = $port;
- }
- /**
- * Gets the URI path string.
- *
- * @return string The URI path string.
- *
- * @since 11.1
- */
- public function getPath()
- {
- return $this->path;
- }
- /**
- * Set the URI path string.
- *
- * @param string $path The URI path string.
- *
- * @return void
- *
- * @since 11.1
- */
- public function setPath($path)
- {
- $this->path = $this->_cleanPath($path);
- }
- /**
- * Get the URI archor string
- * Everything after the "#".
- *
- * @return string The URI anchor string.
- *
- * @since 11.1
- */
- public function getFragment()
- {
- return $this->fragment;
- }
- /**
- * Set the URI anchor string
- * everything after the "#".
- *
- * @param string $anchor The URI anchor string.
- *
- * @return void
- *
- * @since 11.1
- */
- public function setFragment($anchor)
- {
- $this->fragment = $anchor;
- }
- /**
- * Checks whether the current URI is using HTTPS.
- *
- * @return boolean True if using SSL via HTTPS.
- *
- * @since 11.1
- */
- public function isSSL()
- {
- return $this->getScheme() == 'https' ? true : false;
- }
- /**
- * Checks if the supplied URL is internal
- *
- * @param string $url The URL to check.
- *
- * @return boolean True if Internal.
- *
- * @since 11.1
- */
- public static function isInternal($url)
- {
- $uri = self::getInstance($url);
- $base = $uri->toString(array('scheme', 'host', 'port', 'path'));
- $host = $uri->toString(array('scheme', 'host', 'port'));
- if (stripos($base, self::base()) !== 0 && !empty($host))
- {
- return false;
- }
- return true;
- }
- /**
- * Resolves //, ../ and ./ from a path and returns
- * the result. Eg:
- *
- * /foo/bar/../boo.php => /foo/boo.php
- * /foo/bar/../../boo.php => /boo.php
- * /foo/bar/.././/boo.php => /foo/boo.php
- *
- * @param string $path The URI path to clean.
- *
- * @return string Cleaned and resolved URI path.
- *
- * @since 11.1
- */
- protected function _cleanPath($path)
- {
- $path = explode('/', preg_replace('#(/+)#', '/', $path));
- for ($i = 0, $n = count($path); $i < $n; $i++)
- {
- if ($path[$i] == '.' || $path[$i] == '..')
- {
- if (($path[$i] == '.') || ($path[$i] == '..' && $i == 1 && $path[0] == ''))
- {
- unset($path[$i]);
- $path = array_values($path);
- $i--;
- $n--;
- }
- elseif ($path[$i] == '..' && ($i > 1 || ($i == 1 && $path[0] != '')))
- {
- unset($path[$i]);
- unset($path[$i - 1]);
- $path = array_values($path);
- $i -= 2;
- $n -= 2;
- }
- }
- }
- return implode('/', $path);
- }
- }