template commands. * * Themes * * See http://doc.silverstripe.org/themes and http://doc.silverstripe.org/themes:developing * * Caching * * Compiled templates are cached via {@link SS_Cache}, usually on the filesystem. * If you put ?flush=all on your URL, it will force the template to be recompiled. * * Manifest File and Structure * * Works with the global $_TEMPLATE_MANIFEST which is compiled by {@link ManifestBuilder->getTemplateManifest()}. * This associative array lists all template filepaths by "identifier", meaning the name * of the template without its path or extension. * * Example: *


 * array(
 *  'LeftAndMain' => 
 *  array (
 * 	'main' => '/my/system/path/cms/templates/LeftAndMain.ss',
 *  ),
 * 'CMSMain_left' => 
 *   array (
 *     'Includes' => '/my/system/path/cms/templates/Includes/CMSMain_left.ss',
 *   ),
 * 'Page' => 
 *   array (
 *     'themes' => 
 *     array (
 *       'blackcandy' => 
 *       array (
 *         'Layout' => '/my/system/path/themes/blackcandy/templates/Layout/Page.ss',
 *         'main' => '/my/system/path/themes/blackcandy/templates/Page.ss',
 *       ),
 *       'blue' => 
 *       array (
 *         'Layout' => '/my/system/path/themes/mysite/templates/Layout/Page.ss',
 *         'main' => '/my/system/path/themes/mysite/templates/Page.ss',
 *       ),
 *     ),
 *   ),
 *   // ...
 * )
 *

* * @see http://doc.silverstripe.org/themes * @see http://doc.silverstripe.org/themes:developing * * @package sapphire * @subpackage view */ class SSViewer { /** * @var boolean $source_file_comments */ protected static $source_file_comments = false; /** * Set whether HTML comments indicating the source .SS file used to render this page should be * included in the output. This is enabled by default * * @param boolean $val */ static function set_source_file_comments($val) { self::$source_file_comments = $val; } /** * @return boolean */ static function get_source_file_comments() { return self::$source_file_comments; } /** * @var array $chosenTemplates Associative array for the different * template containers: "main" and "Layout". Values are absolute file paths to *.ss files. */ private $chosenTemplates = array(); /** * @var boolean */ protected $rewriteHashlinks = true; /** * @var string */ protected static $current_theme = null; /** * @var string */ protected static $current_custom_theme = null; /** * Create a template from a string instead of a .ss file * * @return SSViewer */ static function fromString($content) { return new SSViewer_FromString($content); } /** * @param string $theme The "base theme" name (without underscores). */ static function set_theme($theme) { self::$current_theme = $theme; //Static publishing needs to have a theme set, otherwise it defaults to the content controller theme if(!is_null($theme)) self::$current_custom_theme=$theme; } /** * @return string */ static function current_theme() { return self::$current_theme; } /** * Returns the path to the theme folder * * @return String */ static function get_theme_folder() { return self::current_theme() ? THEMES_DIR . "/" . self::current_theme() : project(); } /** * @return string */ static function current_custom_theme(){ return self::$current_custom_theme; } /** * @param string|array $templateList If passed as a string with .ss extension, used as the "main" template. * If passed as an array, it can be used for template inheritance (first found template "wins"). * Usually the array values are PHP class names, which directly correlate to template names. *


	 *  array('MySpecificPage', 'MyPage', 'Page')
	 *

Template: $cacheFile

"; echo "

";
			foreach($lines as $num => $line) {
				echo str_pad($num+1,5) . htmlentities($line);
			}
			echo "

Template: $tmpFile

"; echo "

";
			foreach($lines as $num => $line) {
				echo str_pad($num+1,5) . htmlentities($line);
			}
			echo "

"; } $itemStack = array(); $val = ""; $valStack = array(); $cache = SS_Cache::factory('cacheblock'); include($tmpFile); unlink($tmpFile); return $val; } } /** * Handle the parsing for cacheblock tags. * * Needs to be handled differently from the other tags, because cacheblock can take any number of arguments * * This shouldn't be used as an example of how to add functionality to SSViewer - the eventual plan is to re-write * SSViewer using a proper parser (probably http://github.com/hafriedlander/php-peg), so that extra functionality * can be added without relying on ad-hoc parsers like this. * * @package sapphire * @subpackage view */ class SSViewer_PartialParser { static $tag = '/< % [ \t]+ (cached|cacheblock|uncached|end_cached|end_cacheblock|end_uncached) [ \t]+ ([^%]+ [ \t]+)? % >/xS'; static $argument_splitter = '/^\s* # The argument itself ( (?P if | unless ) | # The if or unless keybreak (?P (?P \w+) \s* # A property lookup or a function call ( $ (?P [^$]*) \) )? ) | (?P \' (\\\'|[^\'])+ \' ) | # A string surrounded by \' (?P " (\\"|[^"])+ " ) # A string surrounded by " ) # Some seperator after the argument ( \s*(?P,)\s* | # A comma (maybe with whitespace before or after) (?P\.) # A period (no whitespace before) )? /xS'; static function process($template, $content) { $parser = new SSViewer_PartialParser($template, $content, 0); $parser->parse(); return $parser->generate(); } function __construct($template, $content, $offset) { $this->template = $template; $this->content = $content; $this->offset = $offset; $this->blocks = array(); } function controlcheck($text) { // NOP - hook for Cached_PartialParser } function parse() { $current_tag_offset = 0; while (preg_match(self::$tag, $this->content, $matches, PREG_OFFSET_CAPTURE, $this->offset)) { $tag = $matches[1][0]; $startpos = $matches[0][1]; $endpos = $matches[0][1] + strlen($matches[0][0]); switch($tag) { case 'cached': case 'uncached': case 'cacheblock': $pretext = substr($this->content, $this->offset, $startpos - $this->offset); $this->controlcheck($pretext); $this->blocks[] = $pretext; if ($tag == 'cached' || $tag == 'cacheblock') { list($keyparts, $conditional, $condition) = $this->parseargs(@$matches[2][0]); $parser = new SSViewer_Cached_PartialParser($this->template, $this->content, $endpos, $keyparts, $conditional, $condition); } else { $parser = new SSViewer_PartialParser($this->template, $this->content, $endpos); } $parser->parse(); $this->blocks[] = $parser; $this->offset = $parser->offset; break; case 'end_cached': case 'end_cacheblock': case 'end_uncached': $this->blocks[] = substr($this->content, $this->offset, $startpos - $this->offset); $this->content = null; $this->offset = $endpos; return $this; } } $this->blocks[] = substr($this->content, $this->offset); $this->content = null; } function parseargs($string) { preg_match_all(self::$argument_splitter, $string, $matches, PREG_SET_ORDER); $parts = array(); $conditional = null; $condition = null; $current = '$item->'; while (strlen($string) && preg_match(self::$argument_splitter, $string, $match)) { $string = substr($string, strlen($match[0])); // If this is a conditional keyword, break, and the next loop will grab the conditional if (@$match['conditional']) { $conditional = $match['conditional']; continue; } // If it's a property lookup or a function call if (@$match['property']) { // Get the property $what = $match['identifier']; $args = array(); // Extract any arguments passed to the function call if (@$match['arguments']) { foreach (explode(',', $match['arguments']) as $arg) { $args[] = is_numeric($arg) ? (string)$arg : '"'.$arg.'"'; } } $args = empty($args) ? 'null' : 'array('.implode(',',$args).')'; // If this fragment ended with '.', then there's another lookup coming, so return an obj for that lookup if (@$match['fullstop']) { $current .= "obj('$what', $args, true)->"; } // Otherwise this is the end of the lookup chain, so add the resultant value to the key array and reset the key-get php fragement else { $accessor = $current . "XML_val('$what', $args, true)"; $current = '$item->'; // If we've hit a conditional already, this is the condition. Set it and be done. if ($conditional) { $condition = $accessor; break; } // Otherwise we're another key component. Add it to array. else $parts[] = $accessor; } } // Else it's a quoted string of some kind else if (@$match['sqstring']) $parts[] = $match['sqstring']; else if (@$match['dqstring']) $parts[] = $match['dqstring']; } if ($conditional && !$condition) { throw new Exception("You need to have a condition after the conditional $conditional in your cache block"); } return array($parts, $conditional, $condition); } function generate() { $res = array(); foreach ($this->blocks as $i => $block) { if ($block instanceof SSViewer_PartialParser) $res[] = $block->generate(); else { $res[] = $block; } } return implode('', $res); } } /** * @package sapphire * @subpackage view */ class SSViewer_Cached_PartialParser extends SSViewer_PartialParser { function __construct($template, $content, $offset, $keyparts, $conditional, $condition) { $this->keyparts = $keyparts; $this->conditional = $conditional; $this->condition = $condition; parent::__construct($template, $content, $offset); } function controlcheck($text) { $ifs = preg_match_all('/<'.'% +if +/', $text, $matches); $end_ifs = preg_match_all('/<'.'% +end_if +/', $text, $matches); if ($ifs != $end_ifs) throw new Exception('You can\'t have cached or uncached blocks within condition structures'); $controls = preg_match_all('/<'.'% +control +/', $text, $matches); $end_controls = preg_match_all('/<'.'% +end_control +/', $text, $matches); if ($controls != $end_controls) throw new Exception('You can\'t have cached or uncached blocks within control structures'); } function key() { if (empty($this->keyparts)) return "''"; return 'sha1(' . implode(".'_'.", $this->keyparts) . ')'; } function generate() { $res = array(); $key = $this->key(); $condition = ""; switch ($this->conditional) { case 'if': $condition = "{$this->condition} && "; break; case 'unless': $condition = "!({$this->condition}) && "; break; } /* Output this set of blocks */ foreach ($this->blocks as $i => $block) { if ($block instanceof SSViewer_PartialParser) $res[] = $block->generate(); else { // Include the template name and this cache block's current contents as a sha hash, so we get auto-seperation // of cache blocks, and invalidation of the cache when the template changes $partialkey = "'".sha1($this->template . $block)."_'.$key.'_$i'"; // Try to load from cache $res[] = "load('.$partialkey.'))) $val .= $partial;'."\n"; // Cache miss - regenerate $res[] = "else {\n"; $res[] = '$oldval = $val; $val = "";'."\n"; $res[] = "\n?>" . $block . "save($val); $val = $oldval . $val ;'."\n"; $res[] = "}\n?>"; } } return implode('', $res); } } function supressOutput() { return ""; } ?>