* @link http://www.pradosoft.com/ * @copyright Copyright © 2005-2014 PradoSoft * @license http://www.pradosoft.com/license/ * @package Prado\Web\UI */ namespace Prado\Web\UI; use Prado\Prado; use Prado\TComponent; use Prado\Web\Javascripts\TJavaScriptLiteral; use Prado\Exceptions\TConfigurationException; use Prado\Exceptions\TTemplateException; use Prado\Exceptions\TException; /** * TTemplate implements PRADO template parsing logic. * A TTemplate object represents a parsed PRADO control template. * It can instantiate the template as child controls of a specified control. * The template format is like HTML, with the following special tags introduced, * - component tags: a component tag represents the configuration of a component. * The tag name is in the format of com:ComponentType, where ComponentType is the component * class name. Component tags must be well-formed. Attributes of the component tag * are treated as either property initial values, event handler attachment, or regular * tag attributes. * - property tags: property tags are used to set large block of attribute values. * The property tag name is in the format of where AttributeName * can be a property name, an event name or a regular tag attribute name. * - group subproperty tags: subproperties of a common property can be configured using * * - directive: directive specifies the property values for the template owner. * It is in the format of <%@ property name-value pairs %>; * - expressions: They are in the format of <%= PHP expression %> and <%% PHP statements %> * - comments: There are two kinds of comments, regular HTML comments and special template comments. * The former is in the format of , which will be treated as text strings. * The latter is in the format of , which will be stripped out. * * Tags other than the above are not required to be well-formed. * * A TTemplate object represents a parsed PRADO template. To instantiate the template * for a particular control, call {@link instantiateIn($control)}, which * will create and intialize all components specified in the template and * set their parent as $control. * * @author Qiang Xue * @package Prado\Web\UI * @since 3.0 */ class TTemplate extends \Prado\TApplicationComponent implements ITemplate { /** * '' - template comments * '' - HTML comments * '<\/?com:([\w\.]+)((?:\s*[\w\.]+\s*=\s*\'.*?\'|\s*[\w\.]+\s*=\s*".*?"|\s*[\w\.]+\s*=\s*<%.*?%>)*)\s*\/?>' - component tags * '<\/?prop:([\w\.]+)\s*>' - property tags * '<%@\s*((?:\s*[\w\.]+\s*=\s*\'.*?\'|\s*[\w\.]+\s*=\s*".*?")*)\s*%>' - directives * '<%[%#~\/\\$=\\[](.*?)%>' - expressions * ')*)\s*\/>' - group subproperty tags */ const REGEX_RULES='/||<\/?com:([\w\.]+)((?:\s*[\w\.]+\s*=\s*\'.*?\'|\s*[\w\.]+\s*=\s*".*?"|\s*[\w\.]+\s*=\s*<%.*?%>)*)\s*\/?>|<\/?prop:([\w\.]+)\s*>|<%@\s*((?:\s*[\w\.]+\s*=\s*\'.*?\'|\s*[\w\.]+\s*=\s*".*?")*)\s*%>|<%[%#~\/\\$=\\[](.*?)%>|)*)\s*\/>/msS'; /** * Different configurations of component property/event/attribute */ const CONFIG_DATABIND=0; const CONFIG_EXPRESSION=1; const CONFIG_ASSET=2; const CONFIG_PARAMETER=3; const CONFIG_LOCALIZATION=4; const CONFIG_TEMPLATE=5; /** * @var array list of component tags and strings */ private $_tpl=array(); /** * @var array list of directive settings */ private $_directive=array(); /** * @var string context path */ private $_contextPath; /** * @var string template file path (if available) */ private $_tplFile=null; /** * @var integer the line number that parsing starts from (internal use) */ private $_startingLine=0; /** * @var string template content to be parsed */ private $_content; /** * @var boolean whether this template is a source template */ private $_sourceTemplate=true; /** * @var string hash code of the template */ private $_hashCode=''; private $_tplControl=null; private $_includedFiles=array(); private $_includeAtLine=array(); private $_includeLines=array(); /** * Constructor. * The template will be parsed after construction. * @param string the template string * @param string the template context directory * @param string the template file, null if no file * @param integer the line number that parsing starts from (internal use) * @param boolean whether this template is a source template, i.e., this template is loaded from * some external storage rather than from within another template. */ public function __construct($template,$contextPath,$tplFile=null,$startingLine=0,$sourceTemplate=true) { $this->_sourceTemplate=$sourceTemplate; $this->_contextPath=$contextPath; $this->_tplFile=$tplFile; $this->_startingLine=$startingLine; $this->_content=$template; $this->_hashCode=md5($template); $this->parse($template); $this->_content=null; // reset to save memory } /** * @return string template file path if available, null otherwise. */ public function getTemplateFile() { return $this->_tplFile; } /** * @return boolean whether this template is a source template, i.e., this template is loaded from * some external storage rather than from within another template. */ public function getIsSourceTemplate() { return $this->_sourceTemplate; } /** * @return string context directory path */ public function getContextPath() { return $this->_contextPath; } /** * @return array name-value pairs declared in the directive */ public function getDirective() { return $this->_directive; } /** * @return string hash code that can be used to identify the template */ public function getHashCode() { return $this->_hashCode; } /** * @return array the parsed template */ public function &getItems() { return $this->_tpl; } /** * Instantiates the template. * Content in the template will be instantiated as components and text strings * and passed to the specified parent control. * @param TControl the control who owns the template * @param TControl the control who will become the root parent of the controls on the template. If null, it uses the template control. */ public function instantiateIn($tplControl,$parentControl=null) { $this->_tplControl=$tplControl; if($parentControl===null) $parentControl=$tplControl; if(($page=$tplControl->getPage())===null) $page=$this->getService()->getRequestedPage(); $controls=array(); $directChildren=array(); foreach($this->_tpl as $key=>$object) { if($object[0]===-1) $parent=$parentControl; else if(isset($controls[$object[0]])) $parent=$controls[$object[0]]; else continue; if(isset($object[2])) // component { $component=Prado::createComponent($object[1]); $properties=&$object[2]; if($component instanceof TControl) { if($component instanceof \Prado\Web\UI\WebControls\TOutputCache) $component->setCacheKeyPrefix($this->_hashCode.$key); $component->setTemplateControl($tplControl); if(isset($properties['id'])) { if(is_array($properties['id'])) $properties['id']=$component->evaluateExpression($properties['id'][1]); $tplControl->registerObject($properties['id'],$component); } if(isset($properties['skinid'])) { if(is_array($properties['skinid'])) $component->setSkinID($component->evaluateExpression($properties['skinid'][1])); else $component->setSkinID($properties['skinid']); unset($properties['skinid']); } $component->trackViewState(false); $component->applyStyleSheetSkin($page); foreach($properties as $name=>$value) $this->configureControl($component,$name,$value); $component->trackViewState(true); if($parent===$parentControl) $directChildren[]=$component; else $component->createdOnTemplate($parent); if($component->getAllowChildControls()) $controls[$key]=$component; } else if($component instanceof TComponent) { $controls[$key]=$component; if(isset($properties['id'])) { if(is_array($properties['id'])) $properties['id']=$component->evaluateExpression($properties['id'][1]); $tplControl->registerObject($properties['id'],$component); if(!$component->hasProperty('id')) unset($properties['id']); } foreach($properties as $name=>$value) $this->configureComponent($component,$name,$value); if($parent===$parentControl) $directChildren[]=$component; else $component->createdOnTemplate($parent); } } else { if($object[1] instanceof TCompositeLiteral) { // need to clone a new object because the one in template is reused $o=clone $object[1]; $o->setContainer($tplControl); if($parent===$parentControl) $directChildren[]=$o; else $parent->addParsedObject($o); } else { if($parent===$parentControl) $directChildren[]=$object[1]; else $parent->addParsedObject($object[1]); } } } // delay setting parent till now because the parent may cause // the child to do lifecycle catchup which may cause problem // if the child needs its own child controls. foreach($directChildren as $control) { if($control instanceof TComponent) $control->createdOnTemplate($parentControl); else $parentControl->addParsedObject($control); } } /** * Configures a property/event of a control. * @param TControl control to be configured * @param string property name * @param mixed property initial value */ protected function configureControl($control,$name,$value) { if(strncasecmp($name,'on',2)===0) // is an event $this->configureEvent($control,$name,$value,$control); else if(($pos=strrpos($name,'.'))===false) // is a simple property or custom attribute $this->configureProperty($control,$name,$value); else // is a subproperty $this->configureSubProperty($control,$name,$value); } /** * Configures a property of a non-control component. * @param TComponent component to be configured * @param string property name * @param mixed property initial value */ protected function configureComponent($component,$name,$value) { if(strpos($name,'.')===false) // is a simple property or custom attribute $this->configureProperty($component,$name,$value); else // is a subproperty $this->configureSubProperty($component,$name,$value); } /** * Configures an event for a control. * @param TControl control to be configured * @param string event name * @param string event handler * @param TControl context control */ protected function configureEvent($control,$name,$value,$contextControl) { if(strpos($value,'.')===false) $control->attachEventHandler($name,array($contextControl,'TemplateControl.'.$value)); else $control->attachEventHandler($name,array($contextControl,$value)); } /** * Configures a simple property for a component. * @param TComponent component to be configured * @param string property name * @param mixed property initial value */ protected function configureProperty($component,$name,$value) { if(is_array($value)) { switch($value[0]) { case self::CONFIG_DATABIND: $component->bindProperty($name,$value[1]); break; case self::CONFIG_EXPRESSION: if($component instanceof TControl) $component->autoBindProperty($name,$value[1]); else { $setter='set'.$name; $component->$setter($this->_tplControl->evaluateExpression($value[1])); } break; case self::CONFIG_TEMPLATE: $setter='set'.$name; $component->$setter($value[1]); break; case self::CONFIG_ASSET: // asset URL $setter='set'.$name; $url=$this->publishFilePath($this->_contextPath.DIRECTORY_SEPARATOR.$value[1]); $component->$setter($url); break; case self::CONFIG_PARAMETER: // application parameter $setter='set'.$name; $component->$setter($this->getApplication()->getParameters()->itemAt($value[1])); break; case self::CONFIG_LOCALIZATION: $setter='set'.$name; $component->$setter(Prado::localize($value[1])); break; default: // an error if reaching here throw new TConfigurationException('template_tag_unexpected',$name,$value[1]); break; } } else { if (substr($name,0,2)=='js') if ($value and !($value instanceof TJavaScriptLiteral)) $value = new TJavaScriptLiteral($value); $setter='set'.$name; $component->$setter($value); } } /** * Configures a subproperty for a component. * @param TComponent component to be configured * @param string subproperty name * @param mixed subproperty initial value */ protected function configureSubProperty($component,$name,$value) { if(is_array($value)) { switch($value[0]) { case self::CONFIG_DATABIND: // databinding $component->bindProperty($name,$value[1]); break; case self::CONFIG_EXPRESSION: // expression if($component instanceof TControl) $component->autoBindProperty($name,$value[1]); else $component->setSubProperty($name,$this->_tplControl->evaluateExpression($value[1])); break; case self::CONFIG_TEMPLATE: $component->setSubProperty($name,$value[1]); break; case self::CONFIG_ASSET: // asset URL $url=$this->publishFilePath($this->_contextPath.DIRECTORY_SEPARATOR.$value[1]); $component->setSubProperty($name,$url); break; case self::CONFIG_PARAMETER: // application parameter $component->setSubProperty($name,$this->getApplication()->getParameters()->itemAt($value[1])); break; case self::CONFIG_LOCALIZATION: $component->setSubProperty($name,Prado::localize($value[1])); break; default: // an error if reaching here throw new TConfigurationException('template_tag_unexpected',$name,$value[1]); break; } } else $component->setSubProperty($name,$value); } /** * Parses a template string. * * This template parser recognizes five types of data: * regular string, well-formed component tags, well-formed property tags, directives, and expressions. * * The parsing result is returned as an array. Each array element can be of three types: * - a string, 0: container index; 1: string content; * - a component tag, 0: container index; 1: component type; 2: attributes (name=>value pairs) * If a directive is found in the template, it will be parsed and can be * retrieved via {@link getDirective}, which returns an array consisting of * name-value pairs in the directive. * * Note, attribute names are treated as case-insensitive and will be turned into lower cases. * Component and directive types are case-sensitive. * Container index is the index to the array element that stores the container object. * If an object has no container, its container index is -1. * * @param string the template string * @throws TConfigurationException if a parsing error is encountered */ protected function parse($input) { $input=$this->preprocess($input); $tpl=&$this->_tpl; $n=preg_match_all(self::REGEX_RULES,$input,$matches,PREG_SET_ORDER|PREG_OFFSET_CAPTURE); $expectPropEnd=false; $textStart=0; $stack=array(); $container=-1; $matchEnd=0; $c=0; $this->_directive=null; try { for($i=0;$i<$n;++$i) { $match=&$matches[$i]; $str=$match[0][0]; $matchStart=$match[0][1]; $matchEnd=$matchStart+strlen($str)-1; if(strpos($str,'$textStart) $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); $textStart=$matchEnd+1; $type=$match[1][0]; $attributes=$this->parseAttributes($match[2][0],$match[2][1]); $this->validateAttributes($type,$attributes); $tpl[$c++]=array($container,$type,$attributes); if($str[strlen($str)-2]!=='/') // open tag { $stack[] = $type; $container=$c-1; } } else if(strpos($str,'$textStart) $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); $textStart=$matchEnd+1; $type=$match[1][0]; if(empty($stack)) throw new TConfigurationException('template_closingtag_unexpected',""); $name=array_pop($stack); if($name!==$type) { $tag=$name[0]==='@' ? '' : ""; throw new TConfigurationException('template_closingtag_expected',$tag); } $container=$tpl[$container][0]; } else if(strpos($str,'<%@')===0) // directive { if($expectPropEnd) continue; if($matchStart>$textStart) $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); $textStart=$matchEnd+1; if(isset($tpl[0]) || $this->_directive!==null) throw new TConfigurationException('template_directive_nonunique'); $this->_directive=$this->parseAttributes($match[4][0],$match[4][1]); } else if(strpos($str,'<%')===0) // expression { if($expectPropEnd) continue; if($matchStart>$textStart) $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); $textStart=$matchEnd+1; $literal=trim($match[5][0]); if($str[2]==='=') // expression $tpl[$c++]=array($container,array(TCompositeLiteral::TYPE_EXPRESSION,$literal)); else if($str[2]==='%') // statements $tpl[$c++]=array($container,array(TCompositeLiteral::TYPE_STATEMENTS,$literal)); else if($str[2]==='#') $tpl[$c++]=array($container,array(TCompositeLiteral::TYPE_DATABINDING,$literal)); else if($str[2]==='$') $tpl[$c++]=array($container,array(TCompositeLiteral::TYPE_EXPRESSION,"\$this->getApplication()->getParameters()->itemAt('$literal')")); else if($str[2]==='~') $tpl[$c++]=array($container,array(TCompositeLiteral::TYPE_EXPRESSION,"\$this->publishFilePath('$this->_contextPath/$literal')")); else if($str[2]==='/') $tpl[$c++]=array($container,array(TCompositeLiteral::TYPE_EXPRESSION,"rtrim(dirname(\$this->getApplication()->getRequest()->getApplicationUrl()), '/').'/$literal'")); else if($str[2]==='[') { $literal=strtr(trim(substr($literal,0,strlen($literal)-1)),array("'"=>"\'","\\"=>"\\\\")); $tpl[$c++]=array($container,array(TCompositeLiteral::TYPE_EXPRESSION,"Prado::localize('$literal')")); } } else if(strpos($str,'')===strlen($str)-2) //subproperties { if($expectPropEnd) continue; if($matchStart>$textStart) $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); $textStart=$matchEnd+1; $prop=strtolower($match[6][0]); $attrs=$this->parseAttributes($match[7][0],$match[7][1]); $attributes=array(); foreach($attrs as $name=>$value) $attributes[$prop.'.'.$name]=$value; $type=$tpl[$container][1]; $this->validateAttributes($type,$attributes); foreach($attributes as $name=>$value) { if(isset($tpl[$container][2][$name])) throw new TConfigurationException('template_property_duplicated',$name); $tpl[$container][2][$name]=$value; } } else // regular property { $prop=strtolower($match[3][0]); $stack[] = '@'.$prop; if(!$expectPropEnd) { if($matchStart>$textStart) $tpl[$c++]=array($container,substr($input,$textStart,$matchStart-$textStart)); $textStart=$matchEnd+1; $expectPropEnd=true; } } } else if(strpos($str,'"); $name=array_pop($stack); if($name!=='@'.$prop) { $tag=$name[0]==='@' ? '' : ""; throw new TConfigurationException('template_closingtag_expected',$tag); } if(($last=count($stack))<1 || $stack[$last-1][0]!=='@') { if($matchStart>$textStart) { $value=substr($input,$textStart,$matchStart-$textStart); if(substr($prop,-8,8)==='template') $value=$this->parseTemplateProperty($value,$textStart); else $value=$this->parseAttribute($value); if($container>=0) { $type=$tpl[$container][1]; $this->validateAttributes($type,array($prop=>$value)); if(isset($tpl[$container][2][$prop])) throw new TConfigurationException('template_property_duplicated',$prop); $tpl[$container][2][$prop]=$value; } else // a property for the template control $this->_directive[$prop]=$value; $textStart=$matchEnd+1; } $expectPropEnd=false; } } else if(strpos($str,'