Changeset 1539

Timestamp:

12/02/2006 01:20:40 PM (2 years ago)

Author:

xue

Message:

added TUrlManager and fixed #451.

Location:

branches/3.0

Files:

• HISTORY (modified) (2 diffs)
• framework/Exceptions/messages.txt (modified) (1 diff)
• framework/TApplication.php (modified) (1 diff)
• framework/Web/THttpRequest.php (modified) (13 diffs)
• framework/Web/TUrlManager.php (added)
• framework/Web/TUrlMapping.php (modified) (11 diffs)

branches/3.0/HISTORY

@@ -8 +8 @@
 BUG: TPager would not display if it was invisible previously (Qiang)
 ENH: Ticket#446 - Added TMetaTagCollection.getMetaTagByID method (Qiang)
+ENH: Ticket#451 - Modified TUrlMapping to extend from TUrlManager (Qiang)
 ENH: Ticket#468 - Added support of using all property tags in skins (Qiang)
 ENH: Ticket#471 - Added methods in TAssetManager to expose published path and URL (Qiang)
@@ -17 +18 @@
 CHG: THttpRequest.constructUrl() now encodes ampersand by default (Qiang)
 CHG: TDataBoundControl will not throw exception if CurrentPageIndex is out of range (Qiang)
+NEW: TUrlManager (Qiang)
 
 Version 3.0.5 October 23, 2006

branches/3.0/framework/Exceptions/messages.txt

@@ -48 +48 @@
 
 uri_format_invalid                                              = '{0}' is not a valid URI.
+
+httprequest_separator_invalid                   = THttpRequest.UrlParamSeparator can only contain a single character.
+httprequest_urlmanager_inexist                  = THttpRequest.UrlManager '{0}' does not point to an existing module.
+httprequest_urlmanager_invalid                  = THttpRequest.UrlManager '{0}' must point to a module extending from TUrlManager.
 
 httpresponse_bufferoutput_unchangeable  = THttpResponse.BufferOutput cannot be modified after THttpResponse is initialized.

branches/3.0/framework/TApplication.php

@@ -880 +880 @@
                 $request->setAvailableServices($serviceIDs);
 
+                $request->resolveRequest();
+
                 if(($serviceID=$request->getServiceID())===null)
                         $serviceID=self::PAGE_SERVICE_ID;

branches/3.0/framework/Web/THttpRequest.php

@@ -10 +10 @@
  * @package System.Web
  */
+
+Prado::using('System.Web.TUrlManager');
 
 /**
@@ -39 +41 @@
  *
  * To construct a URL that can be recognized by Prado, use {@link constructUrl()}.
+ * The format of the recognizable URLs is determined according to
+ * {@link setUrlManager UrlManager}. By default, the following two formats
+ * are recognized:
+ * <code>
+ * /index.php?ServiceID=ServiceParameter&Name1=Value1&Name2=Value2
+ * /index.php/ServiceID,ServiceParameter/Name1,Value1/Name2,Value2
+ * </code>
+ * The first format is called 'Get' while the second 'Path', which is specified
+ * via {@link setUrlFormat UrlFormat}. For advanced users who want to use
+ * their own URL formats, they can write customized URL management modules
+ * and install the managers as application modules and set {@link setUrlManager UrlManager}.
+ *
+ * The ServiceID in the above URLs is as defined in the application configuration
+ * (e.g. the default page service's service ID is 'page').
+ * As a consequence, your GET variable names should not conflict with the service
+ * IDs that your application supports.
+ *
  * THttpRequest also provides the cookies sent by the user, user information such
  * as his browser capabilities, accepted languages, etc.
- * Currently, THttpRequest recognizes the following URL format:
- * <code>
- * /index.php?ServiceID=ServiceParameter
- * </code>
- * where ServiceID is as defined in the application configuration (e.g.
- * the default page service's service ID is 'page').
- * Therefore, your GET variable names should not conflict with the service
- * IDs that your application supports.
  *
  * By default, THttpRequest is registered with {@link TApplication} as the
@@ -61 +72 @@
 {
         /**
-         * Separator used to separate GET variable name and value when URL format is Path.
+         * @var TUrlManager the URL manager module
+         */
+        private $_urlManager=null;
+        /**
+         * @var string the ID of the URL manager module
+         */
+        private $_urlManagerID='';
+        /**
+         * @var string Separator used to separate GET variable name and value when URL format is Path.
          */
         private $_separator=',';
         /**
-         * @var boolean whether the module is initialized
-         */
-        private $_initialized=false;
-        /**
          * @var string requested service ID
          */
@@ -88 +103 @@
          */
         private $_pathInfo;
-
+        /**
+         * @var boolean whether the session ID should be kept in cookie only
+         */
+        private $_cookieOnly=false;
         private $_urlFormat=THttpRequestUrlFormat::Get;
         private $_services;
@@ -131 +149 @@
         public function init($config)
         {
+                if(empty($this->_urlManagerID))
+                {
+                        $this->_urlManager=new TUrlManager;
+                        $this->_urlManager->init(null);
+                }
+                else
+                {
+                        $this->_urlManager=$this->getApplication()->getModule($this->_urlManagerID);
+                        if($this->_urlManager===null)
+                                throw new TConfigurationException('httprequest_urlmanager_inexist',$this->_urlManagerID);
+                        if(!($this->_urlManager instanceof TUrlManager))
+                                throw new TConfigurationException('httprequest_urlmanager_invalid',$this->_urlManagerID);
+                }
+
                 // Fill in default request info when the script is run in command line
                 if(php_sapi_name()==='cli')
@@ -140 +172 @@
                         $_SERVER['HTTP_USER_AGENT']='';
                 }
+
+                $this->_cookieOnly=(int)ini_get('session.use_cookies') && (int)ini_get('session.use_only_cookies');
 
                 // Info about server variables:
@@ -171 +205 @@
                 }
 
-                if($this->getUrlFormat()===THttpRequestUrlFormat::Path && ($pathInfo=trim($this->_pathInfo,'/'))!=='')
-                        $this->_items=array_merge($this->parseUrl(),$_POST);
-                else
-                        $this->_items=array_merge($_GET,$_POST);
-
-                $this->_initialized=true;
                 $this->getApplication()->setRequest($this);
         }
@@ -213 +241 @@
                 }
                 return $this->_url;
+        }
+
+        /**
+         * @return string the ID of the URL manager module
+         */
+        public function getUrlManager()
+        {
+                return $this->_urlManagerID;
+        }
+
+        /**
+         * Sets the URL manager module.
+         * By default, {@link TUrlManager} is used for managing URLs.
+         * You may specify a different module for URL managing tasks
+         * by loading it as an application module and setting this property
+         * with the module ID.
+         * @param string the ID of the URL manager module
+         */
+        public function setUrlManager($value)
+        {
+                $this->_urlManagerID=$value;
+        }
+
+        /**
+         * @return TUrlManager the URL manager module
+         */
+        public function getUrlManagerModule()
+        {
+                return $this->_urlManager;
         }
 
@@ -473 +530 @@
 
         /**
-         * Constructs a URL that is recognizable by Prado.
-         * You may override this method to provide your own way of URL formatting.
-         * If you do so, you may also need to override {@link parseUrl} so that the URL can be properly parsed.
-         * The URL is constructed as the following format:
-         * /entryscript.php?serviceID=serviceParameter&get1=value1&...
-         * If {@link setUrlFormat UrlFormat} is Path, the following format is used instead:
-         * /entryscript.php/serviceID/serviceParameter/get1,value1/get2,value2...
+         * Constructs a URL that can be recognized by PRADO.
+         * The actual construction work is done by the URL manager module.
+         * This method may append session information to the generated URL if needed.
+         * You may provide your own URL manager module by setting {@link setUrlManager UrlManager}
+         * to provide your own URL scheme.
          * @param string service ID
          * @param string service parameter
@@ -486 +541 @@
          * @param boolean whether to encode the GET parameters (their names and values), defaults to false.
          * @return string URL
-         * @see parseUrl
+         * @see TUrlManager::constructUrl
          */
         public function constructUrl($serviceID,$serviceParam,$getItems=null,$encodeAmpersand=true,$encodeGetItems=true)
         {
-                $url=$serviceID.'='.$serviceParam;
-                $amp=$encodeAmpersand?'&amp;':'&';
-                if(is_array($getItems) || $getItems instanceof Traversable)
-                {
-                        if($encodeGetItems)
-                        {
-                                foreach($getItems as $name=>$value)
-                                {
-                                        if(is_array($value))
-                                        {
-                                                $name=urlencode($name.'[]');
-                                                foreach($value as $v)
-                                                        $url.=$amp.$name.'='.urlencode($v);
-                                        }
-                                        else
-                                                $url.=$amp.urlencode($name).'='.urlencode($value);
-                                }
-                        }
-                        else
-                        {
-                                foreach($getItems as $name=>$value)
-                                {
-                                        if(is_array($value))
-                                        {
-                                                foreach($value as $v)
-                                                        $url.=$amp.$name.'[]='.$v;
-                                        }
-                                        else
-                                                $url.=$amp.$name.'='.$value;
-                                }
-                        }
-                }
-                if($this->getUrlFormat()===THttpRequestUrlFormat::Path)
-                {
-                        $url=strtr($url,array($amp=>'/','?'=>'/','='=>$this->_separator));
-                        if(defined('SID') && SID != '' && !((int)ini_get('session.use_cookies')===1 && ((int)ini_get('session.use_only_cookies')===1)))
-                                $url.='?'.SID;
-                        return $this->getApplicationUrl().'/'.$url;
-                }
+                $url=$this->_urlManager->constructUrl($serviceID,$serviceParam,$getItems,$encodeAmpersand,$encodeGetItems);
+                if(defined('SID') && SID != '' && !$this->_cookieOnly)
+                        return $url . (strpos($url,'?')===false? '?' : ($encodeAmpersand?'&amp;':'&')) . SID;
                 else
-                {
-                        if(defined('SID') && SID != '' && !((int)ini_get('session.use_cookies')===1 && ((int)ini_get('session.use_only_cookies')===1)))
-                                $url.=$amp.SID;
-                        return $this->getApplicationUrl().'?'.$url;
-                }
-        }
-
-        /**
-         * Parses the request URL and returns an array of input parameters (including GET variables).
-         * This method is invoked when the URL format is Path.
+                        return $url;
+        }
+
+        /**
+         * Parses the request URL and returns an array of input parameters (excluding GET variables).
          * You may override this method to support customized URL format.
          * @return array list of input parameters, indexed by parameter names
-         * @see constructUrl
+         * @see TUrlManager::parseUrl
          */
         protected function parseUrl()
         {
-                if($this->_pathInfo!=='')
-                {
-                        $paths=explode('/',$this->_pathInfo);
-                        $getVariables=$_GET;
-                        $serviceID=null;
-                        foreach($paths as $path)
-                        {
-                                if(($path=trim($path))!=='')
-                                {
-                                        if(($pos=strpos($path,$this->_separator))!==false)
-                                        {
-                                                $name=substr($path,0,$pos);
-                                                $value=substr($path,$pos+1);
-                                                if(($pos=strpos($name,'[]'))!==false)
-                                                        $getVariables[substr($name,0,$pos)][]=$value;
-                                                else
-                                                        $getVariables[$name]=$value;
-                                        }
-                                        else
-                                                $getVariables[$path]='';
-                                }
-                        }
-                        return $getVariables;
-                }
-                else
-                        return $_GET;
+                return $this->_urlManager->parseUrl();
         }
 
@@ -582 +571 @@
          * @see constructUrl
          */
-        protected function resolveRequest()
+        public function resolveRequest()
         {
                 Prado::trace("Resolving request from ".$_SERVER['REMOTE_ADDR'],'System.Web.THttpRequest');
                 $this->_requestResolved=true;
+                $this->_items=array_merge($_GET,$this->parseUrl(),$_POST);
                 foreach($this->_services as $id)
                 {
@@ -626 +616 @@
         public function getServiceID()
         {
-                if(!$this->_requestResolved)
-                        $this->resolveRequest();
                 return $this->_serviceID;
         }
@@ -645 +633 @@
         public function getServiceParameter()
         {
-                if(!$this->_requestResolved)
-                        $this->resolveRequest();
                 return $this->_serviceParam;
         }

branches/3.0/framework/Web/TUrlMapping.php

@@ -11 +11 @@
  */
 
+Prado::using('System.Web.TUrlManager');
+
 /**
  * TUrlMapping Class
@@ -18 +20 @@
  * before a service is initialized, thus this module should be configured
  * globally in the <tt>application.xml</tt> file and before any services.
- *
- * The mapping format is as follows.
  * <code>
  *  <module id="friendly-url" class="System.Web.TUrlMapping">
@@ -26 +26 @@
  *    <url ServiceParameter="Posts.ListPost" pattern="category/{cat}/?" parameters.cat="\d+" />
  *  </module>
+ *  <module id="request" class="THttpRequest" UrlManager="friendly-url" />
  * </code>
  *
@@ -38 +39 @@
  * The mapping can be load from an external file by specifying a configuration
  * file using the {@link setConfigFile ConfigFile} property.
+ *
+ * Since TUrlMapping is a URL manager extending from {@link TUrlManager},
+ * you may override {@link TUrlManager::constructUrl} to support your pattern-based
+ * URL scheme.
  *
  * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
@@ -44 +49 @@
  * @since 3.0.5
  */
-class TUrlMapping extends TModule
+class TUrlMapping extends TUrlManager
 {
         /**
+         * File extension of external configuration file
+         */
+        const CONFIG_FILE_EXT='.xml';
+        /**
          * @var string default pattern class.
          */
@@ -58 +67 @@
          */
         private $_matched;
-        /**
-         * File extension of external configuration file
-         */
-        const CONFIG_FILE_EXT='.xml';
         /**
          * @var string external configuration file
@@ -75 +80 @@
         public function init($xml)
         {
+                parent::init($xml);
                 if($this->getRequest()->getRequestResolved())
                         throw new TConfigurationException('urlpath_dispatch_module_must_be_global');
@@ -80 +86 @@
                         $this->loadConfigFile();
                 $this->loadUrlMappings($xml);
-                $this->resolveMappings();
         }
 
@@ -143 +148 @@
 
         /**
-         * Using the request URL path, find the first matching pattern. If found
-         * the matched pattern parameters are used in the Request object.
-         */
-        protected function resolveMappings()
+         * Parses the request URL and returns an array of input parameters.
+         * This method overrides the parent implementation.
+         * The input parameters do not include GET and POST variables.
+         * This method uses the request URL path to find the first matching pattern. If found
+         * the matched pattern parameters are used to return as the input parameters.
+         * @return array list of input parameters
+         */
+        public function parseUrl()
         {
                 $url = $this->getRequest()->getUrl();
@@ -154 +163 @@
                         if(count($matches) > 0)
                         {
+                                $this->_matched=$pattern;
                                 $this->changeServiceParameters($pattern);
-                                $this->initializeRequestParameters($matches);
-                                $this->_matched=$pattern;
-                                break;
+                                $params=array();
+                                foreach($matches as $key=>$value)
+                                        if(is_string($key))
+                                                $params[$key]=$value;
+                                return $params;
                         }
                 }
+                return array();
         }
 
@@ -168 +181 @@
         {
                 return $this->_matched;
-        }
-
-        /**
-         * @param array initialize the Request with matched parameters.
-         */
-        protected function initializeRequestParameters($matches)
-        {
-                $request = $this->getRequest();
-                foreach($matches as $k => $v)
-                {
-                        if(!is_int($k))
-                                $request->add($k,$v);
-                }
         }