Source for file CurlyBracketsFilter.php

Documentation is available at CurlyBracketsFilter.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Templates
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../../Object.php';
24:
25:
26:
27: /**
28: * Template filter curlyBrackets: support for {...} in template.
29: *
30: * - {$variable} with escaping
31: * - {!$variable} without escaping
32: * - {*comment*} will be removed
33: * - {=expression} echo with escaping
34: * - {!=expression} echo without escaping
35: * - {?expression} evaluate PHP statement
36: * - {_expression} echo translation with escaping
37: * - {!_expression} echo translation without escaping
38: * - {link destination ...} control link
39: * - {plink destination ...} presenter link
40: * - {ajaxlink destination ...} ajax link
41: * - {if ?} ... {elseif ?} ... {else} ... {/if} // or <%else%>, <%/if%>, <%/foreach%> ?
42: * - {for ?} ... {/for}
43: * - {foreach ?} ... {/foreach}
44: * - {include ?}
45: * - {cache ?} ... {/cache} cached block
46: * - {snippet ?} ... {/snippet ?} control snippet
47: * - {attr ?} HTML element attributes
48: * - {block|texy} ... {/block} capture of filter block
49: * - {contentType ...} HTTP Content-Type header
50: * - {assign $var value} set template parameter
51: * - {debugbreak}
52: *
53: * @author David Grudl
54: * @copyright Copyright (c) 2004, 2009 David Grudl
55: * @package Nette\Templates
56: */
57: class CurlyBracketsFilter extends Object
58: {
59:
60: /** @var array */
61: public static $macros = array(
62: 'block' => '<?php %:macroBlock% ?>',
63: '/block' => '<?php %:macroBlockEnd% ?>',
64:
65: 'snippet' => '<?php } if ($_cb->foo = $template->snippet($control%:macroSnippet%)) { $_cb->snippets[] = $_cb->foo; ?>',
66: '/snippet' => '<?php array_pop($_cb->snippets)->finish(); } if (SnippetHelper::$outputAllowed) { ?>',
67:
68: 'cache' => '<?php if ($_cb->foo = $template->cache($_cb->key = md5(__FILE__) . __LINE__, $template->getFile(), array(%%))) { $_cb->caches[] = $_cb->foo; ?>',
69: '/cache' => '<?php array_pop($_cb->caches)->save(); } if (!empty($_cb->caches)) end($_cb->caches)->addItem($_cb->key); ?>',
70:
71: 'if' => '<?php if (%%): ?>',
72: 'elseif' => '<?php elseif (%%): ?>',
73: 'else' => '<?php else: ?>',
74: '/if' => '<?php endif ?>',
75: 'foreach' => '<?php foreach (%:macroForeach%): ?>',
76: '/foreach' => '<?php endforeach; array_pop($_cb->its); $iterator = end($_cb->its) ?>',
77: 'for' => '<?php for (%%): ?>',
78: '/for' => '<?php endfor ?>',
79: 'while' => '<?php while (%%): ?>',
80: '/while' => '<?php endwhile ?>',
81:
82: 'include' => '<?php %:macroInclude% ?>',
83: 'extends' => '<?php %:macroExtends% ?>',
84:
85: 'ajaxlink' => '<?php echo %:macroEscape%(%:macroAjaxlink%) ?>',
86: 'plink' => '<?php echo %:macroEscape%(%:macroPlink%) ?>',
87: 'link' => '<?php echo %:macroEscape%(%:macroLink%) ?>',
88: 'ifCurrent' => '<?php %:macroIfCurrent%; if ($presenter->getLastCreatedRequestFlag("current")): ?>',
89:
90: 'attr' => '<?php echo Html::el(NULL)->%:macroAttr%attributes() ?>',
91: 'contentType' => '<?php %:macroContentType% ?>',
92: 'assign' => '<?php %:macroAssign% ?>',
93: 'debugbreak' => '<?php if (function_exists("debugbreak")) debugbreak() ?>',
94:
95: '!_' => '<?php echo $template->translate(%:macroModifiers%) ?>',
96: '!=' => '<?php echo %:macroModifiers% ?>',
97: '_' => '<?php echo %:macroEscape%($template->translate(%:macroModifiers%)) ?>',
98: '=' => '<?php echo %:macroEscape%(%:macroModifiers%) ?>',
99: '!$' => '<?php echo %:macroVar% ?>',
100: '!' => '<?php echo %:macroVar% ?>',
101: '$' => '<?php echo %:macroEscape%(%:macroVar%) ?>',
102: '?' => '<?php %:macroModifiers% ?>',
103: );
104:
105: /** @var array */
106: private $blocks = array();
107:
108: /** @var array */
109: private $namedBlocks = array();
110:
111: /** @var string */
112: private $context, $escape, $tag;
113:
114: /**#@+ Context-aware escaping states */
115: const CONTEXT_TEXT = 1;
116: const CONTEXT_CDATA = 2;
117: const CONTEXT_TAG = 3;
118: const CONTEXT_ATTRIBUTE_SINGLE = "'";
119: const CONTEXT_ATTRIBUTE_DOUBLE = '"';
120: const CONTEXT_NONE = 4;
121: /**#@-*/
122:
123:
124:
125: /**
126: * Invokes filter.
127: * @param string
128: * @return string
129: */
130: public static function invoke($s)
131: {
132: $filter = new self;
133: return $filter->__invoke($s);
134: }
135:
136:
137:
138: /**
139: * Invokes filter.
140: * @param string
141: * @return string
142: */
143: public function __invoke($s)
144: {
145: $this->blocks = array();
146: $this->namedBlocks = array();
147:
148: // context-aware escaping
149: $this->context = self::CONTEXT_TEXT;
150: $this->escape = 'TemplateHelpers::escapeHtml';
151: $this->tag = NULL;
152:
153: // remove comments
154: $s = preg_replace('#\\{\\*.*?\\*\\}[\r\n]*#s', '', $s);
155:
156: // snippets support (temporary solution)
157: $s = "<?php\nif (SnippetHelper::\$outputAllowed) {\n?>\n$s<?php\n}\n?>"; // \n$s is required by following RE
158: $s = preg_replace(
159: '#@(\\{[^}]+?\\})#s',
160: '<?php } ?>$1<?php if (SnippetHelper::\\$outputAllowed) { ?>',
161: $s
162: );
163:
164: // process all {tags} and <tags/>
165: $s = preg_replace_callback('~
166: <(/?)([a-z]+)| ## 1,2) start tag: <tag </tag ; ignores <!-- <!DOCTYPE
167: (>)| ## 3) end tag
168: (?<=\\s)(style|on[a-z]+)\s*=\s*(["\'])| ## 4,5) attribute
169: (["\'])| ## 6) attribute delimiter
170: (\n[ \t]*)?\\{([^\\s\'"{}][^}]*?)(\\|[a-z](?:[^\'"}\s|]+|\\|[a-z]|\'[^\']*\'|"[^"]*")*)?\\}([ \t]*(?=\r|\n))? ## 7,8,9,10) indent & macro & modifiers & newline
171: ~xsi',
172: array($this, 'cbContent'),
173: $s
174: );
175:
176: // named blocks
177: if ($this->namedBlocks) {
178: foreach (array_reverse($this->namedBlocks, TRUE) as $name => $foo) {
179: $s = preg_replace_callback("#{block\#($name)} \?>(.*)<\?php {/block\#$name}#sU", array($this, 'cbNamedBlocks'), $s);
180: }
181: preg_match('#function (\S+)\(#', reset($this->namedBlocks), $m);
182: $s = "<?php\nif (!function_exists('$m[1]')) {\n\n" . implode("\n\n\n", $this->namedBlocks) . "\n\n} ?>" . $s;
183: }
184:
185: // internal state holder
186: $s = "<?php "
187:
188: . "\$_cb = CurlyBracketsFilter::initState(\$template) ?>" . $s;
189:
190: return $s;
191: }
192:
193:
194:
195: /**
196: * Searches for curly brackets, HTML tags and attributes.
197: */
198: private function cbContent($matches)
199: {
200: // [1] => /
201: // [2] => tag
202: // [3] => >
203: // [4] => style|on...
204: // [5] => '"
205: // [6] => '"
206: // [7] => indent
207: // [8] => {macro
208: // [9] => {...|modifiers}
209: // [10] => newline?
210:
211: if (!empty($matches[8])) { // {macro|var|modifiers}
212: $matches[] = NULL;
213: list(, , , , , , , $indent, $macro, $modifiers) = $matches;
214: foreach (self::$macros as $key => $val) {
215: if (strncmp($macro, $key, strlen($key)) === 0) {
216: $var = substr($macro, strlen($key));
217: if (preg_match('#[a-zA-Z0-9]$#', $key) && preg_match('#^[a-zA-Z0-9._-]#', $var)) {
218: continue;
219: }
220: $result = $this->macro($key, trim($var), $modifiers);
221: $nl = isset($matches[10]) ? "\n" : ''; // double newline
222: if ($nl && $indent && strncmp($result, '<?php echo ', 11)) {
223: return "\n" . $result; // remove indent, single newline
224: } else {
225: return $indent . $result . $nl;
226: }
227: }
228: }
229: throw new InvalidStateException("Unknown macro '$matches[0]'.");
230:
231: } elseif ($this->context === self::CONTEXT_NONE) {
232: // skip analyse
233:
234: } elseif (!empty($matches[6])) { // (attribute) '"
235: if ($this->context === $matches[6]) {
236: $this->context = self::CONTEXT_TAG;
237: $this->escape = 'TemplateHelpers::escapeHtml';
238: } elseif ($this->context === self::CONTEXT_TAG) {
239: $this->context = $matches[6];
240: }
241:
242: } elseif (!empty($matches[4])) { // (style|on...) '"
243: if ($this->context === self::CONTEXT_TAG) {
244: $this->context = $matches[5]; // self::CONTEXT_ATTRIBUTE_SINGLE || self::CONTEXT_ATTRIBUTE_DOUBLE
245: $this->escape = strncasecmp($matches[4], 'on', 2) ? 'TemplateHelpers::escapeHtmlCss' : 'TemplateHelpers::escapeHtmlJs';
246: }
247:
248: } elseif (!empty($matches[3])) { // >
249: if ($this->context === self::CONTEXT_TAG) {
250: if ($this->tag === 'script' || $this->tag === 'style') {
251: $this->context = self::CONTEXT_CDATA;
252: $this->escape = $this->tag === 'script' ? 'TemplateHelpers::escapeJs' : 'TemplateHelpers::escapeCss';
253: } else {
254: $this->context = self::CONTEXT_TEXT;
255: $this->escape = 'TemplateHelpers::escapeHtml';
256: }
257: }
258:
259: } elseif (empty($matches[1])) { // <tag
260: if ($this->context === self::CONTEXT_TEXT) {
261: $this->context = self::CONTEXT_TAG;
262: $this->escape = 'TemplateHelpers::escapeHtml';
263: $this->tag = strtolower($matches[2]);
264: }
265:
266: } else { // </tag
267: if ($this->context === self::CONTEXT_TEXT || ($this->context === self::CONTEXT_CDATA && $this->tag === strtolower($matches[2]))) {
268: $this->context = self::CONTEXT_TAG;
269: $this->escape = 'TemplateHelpers::escapeHtml';
270: $this->tag = NULL;
271: }
272: }
273: return $matches[0];
274: }
275:
276:
277:
278: /**
279: * Process specified macro.
280: */
281: public function macro($macro, $var, $modifiers)
282: {
283: $this->_cbMacro = array($var, $modifiers);
284: return preg_replace_callback('#%(.*?)%#', array($this, 'cbMacro'), self::$macros[$macro]);
285: }
286:
287:
288:
289: /** @var array */
290: private $_cbMacro;
291:
292: /**
293: * Callback for self::macro().
294: */
295: private function cbMacro($m)
296: {
297: list($var, $modifiers) = $this->_cbMacro;
298: if ($m[1]) {
299: $callback = $m[1][0] === ':' ? array($this, substr($m[1], 1)) : $m[1];
300: fixCallback($callback);
301: if (!is_callable($callback)) {
302: $able = is_callable($callback, TRUE, $textual);
303: throw new InvalidStateException("CurlyBrackets macro handler '$textual' is not " . ($able ? 'callable.' : 'valid PHP callback.'));
304: }
305: return call_user_func($callback, $var, $modifiers);
306:
307: } else {
308: return $var;
309: }
310: }
311:
312:
313:
314: /**
315: * {$var |modifiers}
316: */
317: private function macroVar($var, $modifiers)
318: {
319: return $this->macroModifiers('$' . $var, $modifiers);
320: }
321:
322:
323:
324: /**
325: * {include ...}
326: */
327: private function macroInclude($var, $modifiers)
328: {
329: if (substr($var, 0, 1) === '#') {
330: preg_match('#^.([^\s,]+),?\s*(.*)$()#', $var, $m); // #name[,] [params]
331: list(, $name, $params) = $m;
332:
333: if (!preg_match('#^[a-zA-Z0-9_]+$#', $name)) {
334: throw new InvalidStateException("Included block name must be alphanumeric string, '$name' given.");
335: }
336:
337: $params = ($params ? "array($params) + " : '') . '$template->getParams()'; // or get_defined_vars() ?
338: $cmd = $name === 'parent' ? 'next' : 'reset';
339: if ($name === 'parent' || $name === 'this') {
340: $item = end($this->blocks);
341: while ($item && $item[0][0] !== '#') $item = prev($this->blocks);
342: if (!$item) {
343: throw new InvalidStateException("Cannot include $name block outside of any block.");
344: }
345: $name = substr($item[0], 1);
346: }
347: $name = var_export($name, TRUE);
348: $cmd = "call_user_func($cmd(\$_cb->blks[$name]), $params)";
349: return $modifiers ? $this->macroBlock('', $modifiers) . $cmd . ";" . $this->macroBlockEnd(NULL) : $cmd;
350: }
351:
352: return 'echo ' . $this->macroModifiers('$template->subTemplate(' . $this->formatVars($var) . ')->__toString(TRUE)', $modifiers);
353: }
354:
355:
356:
357: /**
358: * {extends ...}
359: */
360: private function macroExtends($var)
361: {
362: return $this->macroInclude($var, '') . '; return';
363: }
364:
365:
366:
367: /**
368: * {block ...}
369: */
370: private function macroBlock($var, $modifiers)
371: {
372: if (substr($var, 0, 1) === '#') { // named block
373: $name = substr($var, 1);
374: if (!preg_match('#^[a-zA-Z0-9_]+$#', $name)) {
375: throw new InvalidStateException("Block name must be alphanumeric string, '$name' given.");
376:
377: } elseif (isset($this->namedBlocks[$name])) {
378: throw new InvalidStateException("Cannot redeclare block '$name'.");
379: }
380:
381: $this->namedBlocks[$name] = $name;
382: $this->blocks[] = array($var, '');
383: return $this->macroInclude($var, $modifiers) . "{block#$name}";
384: }
385:
386: if ($var === '' || $var[0] === '$') { // capture or modifier
387: $this->blocks[] = array($var, $modifiers);
388: return ($var === '' && $modifiers === '') ? '' : 'ob_start(); try {';
389: }
390:
391: throw new InvalidStateException("Invalid block parameter '$var'.");
392: }
393:
394:
395:
396: /**
397: * {/block ...}
398: */
399: private function macroBlockEnd($optVar)
400: {
401: list($var, $modifiers) = array_pop($this->blocks);
402:
403: if ($optVar && $optVar !== $var) {
404: throw new InvalidStateException("Tag {/block $var} was not expected here.");
405:
406: } elseif (substr($var, 0, 1) === '#') { // named block
407: return "{/block$var}";
408:
409: } else { // capture or modifier
410: return ($var === '' && $modifiers === '') ? ''
411: : '} catch (Exception $_e) { ob_end_clean(); throw $_e; } '
412: . ($var === '' ? 'echo ' : $var . '=')
413: . $this->macroModifiers('ob_get_clean()', $modifiers);
414: }
415: }
416:
417:
418:
419: /**
420: * Converts {block#named}...{/block} to functions.
421: */
422: private function cbNamedBlocks($matches)
423: {
424: list(, $name, $content) = $matches;
425: $func = '_cbb' . substr(md5(uniqid($name)), 0, 15) . '_' . $name;
426: $this->namedBlocks[$name] = "\$_cb->blks[" . var_export($name, TRUE) . "][] = '$func';\n"
427: . "function $func() { extract(func_get_arg(0)) // block #$name\n?>$content<?php\n}";
428: return '';
429: }
430:
431:
432:
433: /**
434: * {foreach ...}
435: */
436: private function macroForeach($var)
437: {
438: return '$iterator = $_cb->its[] = new SmartCachingIterator(' . preg_replace('# +as +#i', ') as ', $var, 1);
439: }
440:
441:
442:
443: /**
444: * {attr ...}
445: */
446: private function macroAttr($var)
447: {
448: return str_replace(') ', ')->', $var . ' ');
449: }
450:
451:
452:
453: /**
454: * {contentType ...}
455: */
456: private function macroContentType($var)
457: {
458: if (strpos($var, 'html') !== FALSE) {
459: $this->escape = 'TemplateHelpers::escapeHtml';
460: $this->context = self::CONTEXT_TEXT;
461:
462: } elseif (strpos($var, 'xml') !== FALSE) {
463: $this->escape = 'TemplateHelpers::escapeXml';
464: $this->context = self::CONTEXT_NONE;
465:
466: } elseif (strpos($var, 'javascript') !== FALSE) {
467: $this->escape = 'TemplateHelpers::escapeJs';
468: $this->context = self::CONTEXT_NONE;
469:
470: } elseif (strpos($var, 'css') !== FALSE) {
471: $this->escape = 'TemplateHelpers::escapeCss';
472: $this->context = self::CONTEXT_NONE;
473:
474: } else {
475: $this->escape = '$template->escape';
476: $this->context = self::CONTEXT_NONE;
477: }
478:
479: // temporary solution
480: return strpos($var, '/') ? 'Environment::getHttpResponse()->setHeader("Content-Type", "' . $var . '")' : '';
481: }
482:
483:
484:
485: /**
486: * {snippet ...}
487: */
488: private function macroSnippet($var)
489: {
490: if (preg_match('#^([^\s,]+),?\s*(.*)$#', $var, $m)) { // [name[,]] [tag]
491: $var = ', "' . $m[1] . '"' . ($m[2] ? ', ' . var_export($m[2], TRUE) : '');
492: }
493: return $var;
494: }
495:
496:
497:
498: /**
499: * {link ...}
500: */
501: private function macroLink($var, $modifiers)
502: {
503: return $this->macroModifiers('$control->link(' . $this->formatVars($var) .')', $modifiers);
504: }
505:
506:
507:
508: /**
509: * {plink ...}
510: */
511: private function macroPlink($var, $modifiers)
512: {
513: return $this->macroModifiers('$presenter->link(' . $this->formatVars($var) .')', $modifiers);
514: }
515:
516:
517:
518: /**
519: * {ifCurrent ...}
520: */
521: private function macroIfCurrent($var, $modifiers)
522: {
523: return $var ? $this->macroModifiers('$presenter->link(' . $this->formatVars($var) .')', $modifiers) : '';
524: }
525:
526:
527:
528: /**
529: * {ajaxlink ...}
530: */
531: private function macroAjaxlink($var, $modifiers)
532: {
533: return $this->macroModifiers('$control->ajaxlink(' . $this->formatVars($var) .')', $modifiers);
534: }
535:
536:
537:
538: /**
539: * {assign ...}
540: */
541: private function macroAssign($var, $modifiers)
542: {
543: preg_match('#^\\$?(\S+)\s*(.*)$#', $var, $m); // [$]params value
544: return '$template->' . $m[1] . ' = $' . $m[1] . ' = ' . $this->macroModifiers($m[2] === '' ? 'NULL' : $m[2], $modifiers);
545: }
546:
547:
548:
549: /**
550: * Escaping helper.
551: */
552: private function macroEscape($var)
553: {
554: return $this->escape;
555: }
556:
557:
558:
559: /**
560: * Applies modifiers.
561: */
562: public function macroModifiers($var, $modifiers)
563: {
564: if (!$modifiers) return $var;
565: preg_match_all(
566: '#[^\'"}\s|:]+|[|:]|\'[^\']*\'|"[^"]*"#s',
567: $modifiers . '|',
568: $tokens
569: );
570: $state = FALSE;
571: foreach ($tokens[0] as $token) {
572: if ($token === ':' || $token === '|') {
573: if (!isset($prev)) {
574: continue;
575:
576: } elseif ($state === FALSE) {
577: $var = "\$template->$prev($var";
578:
579: } else {
580: $var .= ', ' . $prev;
581: }
582:
583: if ($token === '|') {
584: $var .= ')';
585: $state = FALSE;
586:
587: } else {
588: $state = TRUE;
589: }
590: } else {
591: $prev = $token;
592: }
593: }
594: return $var;
595: }
596:
597:
598:
599: /**
600: * Formats {*link ...} parameters.
601: */
602: private function formatVars($var)
603: {
604: if (preg_match('#^([^\s,]+),?\s*(.*)$#', $var, $m)) { // destination[,] args
605: $var = strspn($m[1], '\'"$') ? $m[1] : "'$m[1]'";
606: if ($m[2]) {
607: $var .= ', ' . (strpos($m[2], '=>') === FALSE ? $m[2] : "array($m[2])");
608: }
609: }
610: return $var;
611: }
612:
613:
614:
615: /**
616: * Initializes state holder $_cb in template.
617: * @param ITemplate
618: * @return stdClass
619: */
620: public static function initState($template)
621: {
622: if (!isset($template->_cb)) {
623: $template->_cb = (object) NULL;
624: }
625: if (!empty($template->_cb->caches)) { // cache support
626: end($template->_cb->caches)->addFile($template->getFile());
627: }
628: return $template->_cb;
629: }
630:
631: }

Source for file CurlyBracketsFilter.php

Namespaces