powerdlz23 1.1.6 → 1.1.8

package/pto/yaamp/web/framework-1.0.8/web/CUrlManager.php

@@ -0,0 +1,613 @@
+<?php
+/**
+ * CUrlManager class file
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright &copy; 2008-2009 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+/**
+ * CUrlManager manages the URLs of Yii Web applications.
+ *
+ * It provides URL construction ({@link createUrl()}) as well as parsing ({@link parseUrl()}) functionality.
+ *
+ * URLs managed via CUrlManager can be in one of the following two formats,
+ * by setting {@link setUrlFormat urlFormat} property:
+ * <ul>
+ * <li>'path' format: /path/to/EntryScript.php/name1/value1/name2/value2...</li>
+ * <li>'get' format:  /path/to/EntryScript.php?name1=value1&name2=value2...</li>
+ * </ul>
+ *
+ * When using 'path' format, CUrlManager uses a set of {@link setRules rules} to:
+ * <ul>
+ * <li>parse the requested URL into a route ('ControllerID/ActionID') and GET parameters;</li>
+ * <li>create URLs based on the given route and GET parameters.</li>
+ * </ul>
+ *
+ * A rule consists of a route and a pattern. The latter is used by CUrlManager to determine
+ * which rule is used for parsing/creating URLs. A pattern is meant to match the path info
+ * part of a URL. It may contain named parameters using the syntax '&lt;ParamName:RegExp&gt;'.
+ *
+ * When parsing a URL, a matching rule will extract the named parameters from the path info
+ * and put them into the $_GET variable; when creating a URL, a matching rule will extract
+ * the named parameters from $_GET and put them into the path info part of the created URL.
+ *
+ * If a pattern ends with '/*', it means additional GET parameters may be appended to the path
+ * info part of the URL; otherwise, the GET parameters can only appear in the query string part.
+ *
+ * To specify URL rules, set the {@link setRules rules} property as an array of rules (pattern=>route).
+ * For example,
+ * <pre>
+ * array(
+ *     'articles'=>'article/list',
+ *     'article/<id:\d+>/*'=>'article/read',
+ * )
+ * </pre>
+ * Two rules are specified in the above:
+ * <ul>
+ * <li>The first rule says that if the user requests the URL '/path/to/index.php/articles',
+ *   it should be treated as '/path/to/index.php/article/list'; and vice versa applies
+ *   when constructing such a URL.</li>
+ * <li>The second rule contains a named parameter 'id' which is specified using
+ *   the &lt;ParamName:RegExp&gt; syntax. It says that if the user requests the URL
+ *   '/path/to/index.php/article/13', it should be treated as '/path/to/index.php/article/read?id=13';
+ *   and vice versa applies when constructing such a URL.</li>
+ * </ul>
+ *
+ * Starting from version 1.0.5, the route part may contain references to named parameters defined
+ * in the pattern part. This allows a rule to be applied to different routes based on matching criteria.
+ * For example,
+ * <pre>
+ * array(
+ *      '<_c:(post|comment)>/<id:\d+>/<_a:(create|update|delete)>'=>'<_c>/<_a>',
+ *      '<_c:(post|comment)>/<id:\d+>'=>'<_a>/view',
+ *      '<_c:(post|comment)>s/*'=>'<_a>/list',
+ * )
+ * </pre>
+ * In the above, we use two named parameters '<_c>' and '<_a>' in the route part. The '<_c>'
+ * parameter matches either 'post' or 'comment', while the '<_a>' parameter matches an action ID.
+ *
+ * Like normal rules, these rules can be used for both parsing and creating URLs.
+ * For example, using the rules above, the URL '/index.php/post/123/create'
+ * would be parsed as the route 'post/create' with GET parameter 'id' being 123.
+ * And given the route 'post/list' and GET parameter 'page' being 2, we should get a URL
+ * '/index.php/posts/page/2'.
+ *
+ * CUrlManager is a default application component that may be accessed via
+ * {@link CWebApplication::getUrlManager()}.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id: CUrlManager.php 1292 2009-08-06 18:43:07Z qiang.xue $
+ * @package system.web
+ * @since 1.0
+ */
+class CUrlManager extends CApplicationComponent
+{
+	const CACHE_KEY='Yii.CUrlManager.rules';
+	const GET_FORMAT='get';
+	const PATH_FORMAT='path';
+
+	/**
+	 * @var array the URL rules (pattern=>route).
+	 */
+	public $rules=array();
+	/**
+	 * @var string the URL suffix used when in 'path' format.
+	 * For example, ".html" can be used so that the URL looks like pointing to a static HTML page. Defaults to empty.
+	 */
+	public $urlSuffix='';
+	/**
+	 * @var boolean whether to show entry script name in the constructed URL. Defaults to true.
+	 */
+	public $showScriptName=true;
+	/**
+	 * @var boolean whether to append GET parameters to the path info part. Defaults to true.
+	 * This property is only effective when {@link urlFormat} is 'path' and is mainly used when
+	 * creating URLs. When it is true, GET parameters will be appended to the path info and
+	 * separate from each other using slashes. If this is false, GET parameters will be in query part.
+	 * @since 1.0.3
+	 */
+	public $appendParams=true;
+	/**
+	 * @var string the GET variable name for route. Defaults to 'r'.
+	 */
+	public $routeVar='r';
+	/**
+	 * @var boolean whether routes are case-sensitive. Defaults to true. By setting this to false,
+	 * the route in the incoming request will be turned to lower case first before further processing.
+	 * As a result, you should follow the convention that you use lower case when specifying
+	 * controller mapping ({@link CWebApplication::controllerMap}) and action mapping
+	 * ({@link CController::actions}). Also, the directory names for organizing controllers should
+	 * be in lower case.
+	 * @since 1.0.1
+	 */
+	public $caseSensitive=true;
+	/**
+	 * @var string the ID of the cache application component that is used to cache the parsed URL rules.
+	 * Defaults to 'cache' which refers to the primary cache application component.
+	 * Set this property to false if you want to disable caching URL rules.
+	 * @since 1.0.3
+	 */
+	public $cacheID='cache';
+	/**
+	 * @var boolean whether to enable strict URL parsing.
+	 * This property is only effective when {@link urlFormat} is 'path'.
+	 * If it is set true, then an incoming URL must match one of the {@link rules URL rules}.
+	 * Otherwise, it will be treated as an invalid request and trigger a 404 HTTP exception.
+	 * Defaults to false.
+	 * @since 1.0.6
+	 */
+	public $useStrictParsing=false;
+
+	private $_urlFormat=self::GET_FORMAT;
+	private $_rules=array();
+	private $_baseUrl;
+
+
+	/**
+	 * Initializes the application component.
+	 */
+	public function init()
+	{
+		parent::init();
+		$this->processRules();
+	}
+
+	/**
+	 * Processes the URL rules.
+	 */
+	protected function processRules()
+	{
+		if(empty($this->rules) || $this->getUrlFormat()===self::GET_FORMAT)
+			return;
+		if($this->cacheID!==false && ($cache=Yii::app()->getComponent($this->cacheID))!==null)
+		{
+			$hash=md5(serialize($this->rules));
+			if(($data=$cache->get(self::CACHE_KEY))!==false && isset($data[1]) && $data[1]===$hash)
+			{
+				$this->_rules=$data[0];
+				return;
+			}
+		}
+		foreach($this->rules as $pattern=>$route)
+			$this->_rules[]=new CUrlRule($route,$pattern);
+		if(isset($cache))
+			$cache->set(self::CACHE_KEY,array($this->_rules,$hash));
+	}
+
+	/**
+	 * Constructs a URL.
+	 * @param string the controller and the action (e.g. article/read)
+	 * @param array list of GET parameters (name=>value). Both the name and value will be URL-encoded.
+	 * If the name is '#', the corresponding value will be treated as an anchor
+	 * and will be appended at the end of the URL. This anchor feature has been available since version 1.0.1.
+	 * @param string the token separating name-value pairs in the URL. Defaults to '&'.
+	 * @return string the constructed URL
+	 */
+	public function createUrl($route,$params=array(),$ampersand='&')
+	{
+		unset($params[$this->routeVar]);
+		foreach($params as &$param)
+			if($param===null)
+				$param='';
+		if(isset($params['#']))
+		{
+			$anchor='#'.$params['#'];
+			unset($params['#']);
+		}
+		else
+			$anchor='';
+		$route=trim($route,'/');
+		foreach($this->_rules as $rule)
+		{
+			if(($url=$rule->createUrl($this,$route,$params,$ampersand))!==false)
+				return $this->getBaseUrl().'/'.$url.$anchor;
+		}
+		
+		$url = $this->createUrlDefault($route,$params,$ampersand).$anchor;
+		return $url;
+	}
+
+	/**
+	 * Contructs a URL based on default settings.
+	 * @param string the controller and the action (e.g. article/read)
+	 * @param array list of GET parameters
+	 * @param string the token separating name-value pairs in the URL.
+	 * @return string the constructed URL
+	 */
+	protected function createUrlDefault($route,$params,$ampersand)
+	{
+		if($this->getUrlFormat()===self::PATH_FORMAT)
+		{
+			$url=rtrim($this->getBaseUrl().'/'.$route,'/');
+			if($this->appendParams)
+			{
+				$url=rtrim($url.'/'.$this->createPathInfo($params,'/','/'),'/');
+				return $route==='' ? $url : $url.$this->urlSuffix;
+			}
+			else
+			{
+				if($route!=='')
+					$url.=$this->urlSuffix;
+				$query=$this->createPathInfo($params,'=',$ampersand);
+				return $query==='' ? $url : $url.'?'.$query;
+			}
+		}
+		else
+		{
+			$url=$this->getBaseUrl();
+			if(!$this->showScriptName)
+				$url.='/';
+			if($route!=='')
+			{
+				$url.='?'.$this->routeVar.'='.$route;
+				if(($query=$this->createPathInfo($params,'=',$ampersand))!=='')
+					$url.=$ampersand.$query;
+			}
+			else if(($query=$this->createPathInfo($params,'=',$ampersand))!=='')
+				$url.='?'.$query;
+			return $url;
+		}
+	}
+
+	/**
+	 * Parses the user request.
+	 * @param CHttpRequest the request application component
+	 * @return string the route (controllerID/actionID) and perhaps GET parameters in path format.
+	 */
+	public function parseUrl($request)
+	{
+		if($this->getUrlFormat()===self::PATH_FORMAT && 0)
+		{
+			$rawPathInfo=urldecode($request->getPathInfo());
+			$pathInfo=$this->removeUrlSuffix($rawPathInfo,$this->urlSuffix);
+			foreach($this->_rules as $rule)
+			{
+				if(($r=$rule->parseUrl($this,$pathInfo,$rawPathInfo))!==false)
+					return isset($_GET[$this->routeVar]) ? $_GET[$this->routeVar] : $r;
+			}
+			if($this->useStrictParsing)
+				throw new CHttpException(404,Yii::t('yii','Unable to resolve the request "{route}".',
+					array('{route}'=>$pathInfo)));
+			else
+				return $pathInfo;
+		}
+		else if(isset($_GET[$this->routeVar]))
+			return $_GET[$this->routeVar];
+		else if(isset($_POST[$this->routeVar]))
+			return $_POST[$this->routeVar];
+		else
+			return '';
+	}
+
+	/**
+	 * Parses a path info into URL segments and saves them to $_GET.
+	 * @param string path info
+	 * @since 1.0.3
+	 */
+	public static function parsePathInfo($pathInfo)
+	{
+		if($pathInfo==='')
+			return;
+		$segs=explode('/',$pathInfo.'/');
+		$n=count($segs);
+		for($i=0;$i<$n-1;$i+=2)
+		{
+			$key=$segs[$i];
+			if($key==='') continue;
+			$value=$segs[$i+1];
+			if(($pos=strpos($key,'[]'))!==false)
+				$_GET[substr($key,0,$pos)][]=$value;
+			else
+				$_GET[$key]=$value;
+		}
+	}
+
+	/**
+	 * Creates a path info based on the given parameters.
+	 * @param array list of GET parameters
+	 * @param string the separator between name and value
+	 * @param string the separator between name-value pairs
+	 * @return string the created path info
+	 * @since 1.0.3
+	 */
+	public function createPathInfo($params,$equal,$ampersand)
+	{
+		$pairs=array();
+		foreach($params as $key=>$value)
+		{
+			if(is_array($value))
+			{
+				foreach($value as $k=>$v)
+					$pairs[]=urlencode($key).'['.urlencode($k).']'.$equal.urlencode($v);
+			}
+			else
+				$pairs[]=urlencode($key).$equal.urlencode($value);
+		}
+		return implode($ampersand,$pairs);
+	}
+
+	/**
+	 * Removes the URL suffix from path info.
+	 * @param string path info part in the URL
+	 * @param string the URL suffix to be removed
+	 * @return string path info with URL suffix removed.
+	 */
+	public function removeUrlSuffix($pathInfo,$urlSuffix)
+	{
+		if($urlSuffix!=='' && substr($pathInfo,-strlen($urlSuffix))===$urlSuffix)
+			return substr($pathInfo,0,-strlen($urlSuffix));
+		else
+			return $pathInfo;
+	}
+
+	/**
+	 * @return string the base URL of the application (the part after host name and before query string).
+	 * If {@link showScriptName} is true, it will include the script name part.
+	 * Otherwise, it will not, and the ending slashes are stripped off.
+	 */
+	public function getBaseUrl()
+	{
+		if($this->_baseUrl!==null)
+			return $this->_baseUrl;
+		else
+		{
+			if($this->showScriptName)
+				$this->_baseUrl=Yii::app()->getRequest()->getScriptUrl();
+			else
+				$this->_baseUrl=Yii::app()->getRequest()->getBaseUrl();
+			return $this->_baseUrl;
+		}
+	}
+
+	/**
+	 * @return string the URL format. Defaults to 'path'.
+	 */
+	public function getUrlFormat()
+	{
+		return $this->_urlFormat;
+	}
+
+	/**
+	 * @param string the URL format. It must be either 'path' or 'get'.
+	 */
+	public function setUrlFormat($value)
+	{
+		if($value===self::PATH_FORMAT || $value===self::GET_FORMAT)
+			$this->_urlFormat=$value;
+		else
+			throw new CException(Yii::t('yii','CUrlManager.UrlFormat must be either "path" or "get".'));
+	}
+}
+
+
+/**
+ * CUrlRule represents a URL formatting/parsing rule.
+ *
+ * It mainly consists of two parts: route and pattern. The former classifies
+ * the rule so that it only applies to specific controller-action route.
+ * The latter performs the actual formatting and parsing role. The pattern
+ * may have a set of named parameters.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id: CUrlManager.php 1292 2009-08-06 18:43:07Z qiang.xue $
+ * @package system.web
+ * @since 1.0
+ */
+class CUrlRule extends CComponent
+{
+	/**
+	 * @var string the URL suffix used for this rule.
+	 * For example, ".html" can be used so that the URL looks like pointing to a static HTML page.
+	 * Defaults to null, meaning using the value of {@link CUrlManager::urlSuffix}.
+	 * @since 1.0.6
+	 */
+	public $urlSuffix;
+	/**
+	 * @var boolean whether the rule is case sensitive. Defaults to null, meaning
+	 * using the value of {@link CUrlManager::caseSensitive}.
+	 * @since 1.0.1
+	 */
+	public $caseSensitive;
+	/**
+	 * @var array the default GET parameters (name=>value) that this rule provides.
+	 * When this rule is used to parse the incoming request, the values declared in this property
+	 * will be injected into $_GET.
+	 * @since 1.0.8
+	 */
+	public $defaultParams=array();
+	/**
+	 * @var string the controller/action pair
+	 */
+	public $route;
+	/**
+	 * @var array the mapping from route param name to token name (e.g. _r1=><1>)
+	 * @since 1.0.5
+	 */
+	public $references=array();
+	/**
+	 * @var string the pattern used to match route
+	 * @since 1.0.5
+	 */
+	public $routePattern;
+	/**
+	 * @var string regular expression used to parse a URL
+	 */
+	public $pattern;
+	/**
+	 * @var string template used to construct a URL
+	 */
+	public $template;
+	/**
+	 * @var array list of parameters (name=>regular expression)
+	 */
+	public $params=array();
+	/**
+	 * @var boolean whether the URL allows additional parameters at the end of the path info.
+	 */
+	public $append;
+
+	/**
+	 * Constructor.
+	 * @param string the route of the URL (controller/action)
+	 * @param string the pattern for matching the URL
+	 */
+	public function __construct($route,$pattern)
+	{
+		if(is_array($route))
+		{
+			if(isset($route['urlSuffix']))
+				$this->urlSuffix=$route['urlSuffix'];
+			if(isset($route['caseSensitive']))
+				$this->caseSensitive=$route['caseSensitive'];
+			if(isset($route['defaultParams']))
+				$this->defaultParams=$route['defaultParams'];
+			$route=$this->route=$route[0];
+		}
+		else
+			$this->route=$route;
+
+		$tr2['/']=$tr['/']='\\/';
+
+		if(strpos($route,'<')!==false && preg_match_all('/<(\w+)>/',$route,$matches2))
+		{
+			foreach($matches2[1] as $name)
+				$this->references[$name]="<$name>";
+		}
+
+		if(preg_match_all('/<(\w+):?(.*?)?>/',$pattern,$matches))
+		{
+			$tokens=array_combine($matches[1],$matches[2]);
+			foreach($tokens as $name=>$value)
+			{
+				$tr["<$name>"]="(?P<$name>".($value!==''?$value:'[^\/]+').')';
+				if(isset($this->references[$name]))
+					$tr2["<$name>"]=$tr["<$name>"];
+				else
+					$this->params[$name]=$value;
+			}
+		}
+		$p=rtrim($pattern,'*');
+		$this->append=$p!==$pattern;
+		$p=trim($p,'/');
+		$this->template=preg_replace('/<(\w+):?.*?>/','<$1>',$p);
+		$this->pattern='/^'.strtr($this->template,$tr).'\/';
+		if($this->append)
+			$this->pattern.='/u';
+		else
+			$this->pattern.='$/u';
+
+		if($this->references!==array())
+			$this->routePattern='/^'.strtr($this->route,$tr2).'$/u';
+
+		if(YII_DEBUG && @preg_match($this->pattern,'test')===false)
+			throw new CException(Yii::t('yii','The URL pattern "{pattern}" for route "{route}" is not a valid regular expression.',
+				array('{route}'=>$route,'{pattern}'=>$pattern)));
+	}
+
+	/**
+	 * Creates a URL based on this rule.
+	 * @param CUrlManager the manager
+	 * @param string the route
+	 * @param array list of parameters
+	 * @param string the token separating name-value pairs in the URL.
+	 * @return string the constructed URL
+	 */
+	public function createUrl($manager,$route,$params,$ampersand)
+	{
+		if($manager->caseSensitive && $this->caseSensitive===null || $this->caseSensitive)
+			$case='';
+		else
+			$case='i';
+
+		$tr=array();
+		if($route!==$this->route)
+		{
+			if($this->routePattern!==null && preg_match($this->routePattern.$case,$route,$matches))
+			{
+				foreach($this->references as $key=>$name)
+					$tr[$name]=$matches[$key];
+			}
+			else
+				return false;
+		}
+
+		foreach($this->params as $key=>$value)
+			if(!isset($params[$key]))
+				return false;
+
+		foreach($this->params as $key=>$value)
+		{
+			$tr["<$key>"]=urlencode($params[$key]);
+			unset($params[$key]);
+		}
+
+		$suffix=$this->urlSuffix===null ? $manager->urlSuffix : $this->urlSuffix;
+
+		$url=strtr($this->template,$tr);
+		if(empty($params))
+			return $url!=='' ? $url.$suffix : $url;
+
+		if($this->append)
+			$url.='/'.$manager->createPathInfo($params,'/','/').$suffix;
+		else
+		{
+			if($url!=='')
+				$url.=$suffix;
+			$url.='?'.$manager->createPathInfo($params,'=',$ampersand);
+		}
+		return $url;
+	}
+
+	/**
+	 * Parases a URL based on this rule.
+	 * @param CUrlManager the URL manager
+	 * @param string path info part of the URL
+	 * @param string path info that contains the potential URL suffix
+	 * @return string the route that consists of the controller ID and action ID
+	 */
+	public function parseUrl($manager,$pathInfo,$rawPathInfo)
+	{
+		if($manager->caseSensitive && $this->caseSensitive===null || $this->caseSensitive)
+			$case='';
+		else
+			$case='i';
+
+		if($this->urlSuffix!==null)
+			$pathInfo=$manager->removeUrlSuffix($rawPathInfo,$this->urlSuffix);
+
+		// URL suffix required, but not found in the requested URL
+		if($manager->useStrictParsing && $pathInfo===$rawPathInfo
+			&& ($this->urlSuffix!='' || $this->urlSuffix===null && $manager->urlSuffix!=''))
+			throw new CHttpException(404,Yii::t('yii','Unable to resolve the request "{route}".',
+				array('{route}'=>$rawPathInfo)));
+
+		$pathInfo.='/';
+		if(preg_match($this->pattern.$case,$pathInfo,$matches))
+		{
+			foreach($this->defaultParams as $name=>$value)
+			{
+				if(!isset($_GET[$name]))
+					$_GET[$name]=$value;
+			}
+			$tr=array();
+			foreach($matches as $key=>$value)
+			{
+				if(isset($this->references[$key]))
+					$tr[$this->references[$key]]=$value;
+				else if(isset($this->params[$key]))
+					$_GET[$key]=$value;
+			}
+			if($pathInfo!==$matches[0]) // there're additional GET params
+				CUrlManager::parsePathInfo(ltrim(substr($pathInfo,strlen($matches[0])),'/'));
+			if($this->routePattern!==null)
+				return strtr($this->route,$tr);
+			else
+				return $this->route;
+		}
+		else
+			return false;
+	}
+}