-
-
Notifications
You must be signed in to change notification settings - Fork 108
/
BlockMacros.php
421 lines (366 loc) · 14 KB
/
BlockMacros.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
<?php
/**
* This file is part of the Latte (https://latte.nette.org)
* Copyright (c) 2008 David Grudl (https://davidgrudl.com)
*/
declare(strict_types=1);
namespace Latte\Macros;
use Latte;
use Latte\CompileException;
use Latte\Helpers;
use Latte\MacroNode;
use Latte\PhpWriter;
use Latte\Runtime\SnippetDriver;
/**
* Block macros.
*/
class BlockMacros extends MacroSet
{
/** @var array */
private $namedBlocks = [];
/** @var array */
private $blockTypes = [];
/** @var bool */
private $extends;
/** @var string[] */
private $imports;
public static function install(Latte\Compiler $compiler): void
{
$me = new static($compiler);
$me->addMacro('include', [$me, 'macroInclude']);
$me->addMacro('includeblock', [$me, 'macroIncludeBlock']); // deprecated
$me->addMacro('import', [$me, 'macroImport'], null, null, self::ALLOWED_IN_HEAD);
$me->addMacro('extends', [$me, 'macroExtends'], null, null, self::ALLOWED_IN_HEAD);
$me->addMacro('layout', [$me, 'macroExtends'], null, null, self::ALLOWED_IN_HEAD);
$me->addMacro('snippet', [$me, 'macroBlock'], [$me, 'macroBlockEnd']);
$me->addMacro('block', [$me, 'macroBlock'], [$me, 'macroBlockEnd'], null, self::AUTO_CLOSE);
$me->addMacro('define', [$me, 'macroBlock'], [$me, 'macroBlockEnd']);
$me->addMacro('snippetArea', [$me, 'macroBlock'], [$me, 'macroBlockEnd']);
$me->addMacro('ifset', [$me, 'macroIfset'], '}');
$me->addMacro('elseifset', [$me, 'macroIfset']);
}
/**
* Initializes before template parsing.
* @return void
*/
public function initialize()
{
$this->namedBlocks = [];
$this->blockTypes = [];
$this->extends = null;
$this->imports = [];
}
/**
* Finishes template parsing.
*/
public function finalize()
{
$compiler = $this->getCompiler();
$functions = [];
foreach ($this->namedBlocks as $name => $code) {
$compiler->addMethod(
$functions[$name] = $this->generateMethodName($name),
'?>' . $compiler->expandTokens($code) . '<?php',
'$_args'
);
}
if ($this->namedBlocks) {
$compiler->addProperty('blocks', $functions);
$compiler->addProperty('blockTypes', $this->blockTypes);
}
return [
($this->extends === null ? '' : '$this->parentName = ' . $this->extends . ';') . implode($this->imports),
];
}
/********************* macros ****************d*g**/
/**
* {include block}
*/
public function macroInclude(MacroNode $node, PhpWriter $writer)
{
$node->replaced = false;
$destination = $node->tokenizer->fetchWord(); // destination [,] [params]
if (!preg_match('~#|[\w-]+$~DA', $destination)) {
return false;
}
$destination = ltrim($destination, '#');
$parent = $destination === 'parent';
if ($destination === 'parent' || $destination === 'this') {
for (
$item = $node->parentNode;
$item && $item->name !== 'block' && !isset($item->data->name);
$item = $item->parentNode
);
if (!$item) {
throw new CompileException("Cannot include $destination block outside of any block.");
}
$destination = $item->data->name;
}
$noEscape = Helpers::removeFilter($node->modifiers, 'noescape');
if (!$noEscape && Helpers::removeFilter($node->modifiers, 'escape')) {
trigger_error('Macro ' . $node->getNotation() . ' provides auto-escaping, remove |escape.');
}
if ($node->modifiers && !$noEscape) {
$node->modifiers .= '|escape';
}
return $writer->write(
'$this->renderBlock' . ($parent ? 'Parent' : '') . '('
. (strpos($destination, '$') === false ? var_export($destination, true) : $destination)
. ', %node.array? + '
. (isset($this->namedBlocks[$destination]) || $parent ? 'get_defined_vars()' : '$this->params')
. ($node->modifiers
? ', function ($s, $type) { $_fi = new LR\FilterInfo($type); return %modifyContent($s); }'
: ($noEscape || $parent ? '' : ', ' . var_export(implode($node->context), true)))
. ');'
);
}
/**
* {includeblock "file"}
* @deprecated
*/
public function macroIncludeBlock(MacroNode $node, PhpWriter $writer)
{
//trigger_error('Macro {includeblock} is deprecated, use similar macro {import}.', E_USER_DEPRECATED);
$node->replaced = false;
if ($node->modifiers) {
throw new CompileException('Modifiers are not allowed in ' . $node->getNotation());
}
return $writer->write(
'ob_start(function () {}); $this->createTemplate(%node.word, %node.array? + get_defined_vars(), "includeblock")->renderToContentType(%var); echo rtrim(ob_get_clean());',
implode($node->context)
);
}
/**
* {import "file"}
*/
public function macroImport(MacroNode $node, PhpWriter $writer)
{
if ($node->modifiers) {
throw new CompileException('Modifiers are not allowed in ' . $node->getNotation());
}
$destination = $node->tokenizer->fetchWord();
$this->checkExtraArgs($node);
$code = $writer->write('$this->createTemplate(%word, $this->params, "import")->render();', $destination);
if ($this->getCompiler()->isInHead()) {
$this->imports[] = $code;
} else {
return $code;
}
}
/**
* {extends none | $var | "file"}
*/
public function macroExtends(MacroNode $node, PhpWriter $writer)
{
$notation = $node->getNotation();
if ($node->modifiers) {
throw new CompileException("Modifiers are not allowed in $notation");
} elseif (!$node->args) {
throw new CompileException("Missing destination in $notation");
} elseif ($node->parentNode) {
throw new CompileException("$notation must be placed outside any macro.");
} elseif ($this->extends !== null) {
throw new CompileException("Multiple $notation declarations are not allowed.");
} elseif ($node->args === 'none') {
$this->extends = 'FALSE';
} else {
$this->extends = $writer->write('%node.word%node.args');
}
if (!$this->getCompiler()->isInHead()) {
trigger_error("$notation must be placed in template head.", E_USER_WARNING);
}
}
/**
* {block [name]}
* {snippet [name]}
* {snippetArea [name]}
* {define name}
*/
public function macroBlock(MacroNode $node, PhpWriter $writer)
{
$name = $node->tokenizer->fetchWord();
if ($node->name === 'block' && $name === null) { // anonymous block
return $node->modifiers === '' ? '' : 'ob_start(function () {})';
} elseif ($node->name === 'define' && $node->modifiers) {
throw new CompileException('Modifiers are not allowed in ' . $node->getNotation());
}
$node->data->name = $name = ltrim((string) $name, '#');
if ($name == null) {
if ($node->name === 'define') {
throw new CompileException('Missing block name.');
}
} elseif (strpos($name, '$') !== false) { // dynamic block/snippet
if ($node->name === 'snippet') {
for (
$parent = $node->parentNode;
$parent && !($parent->name === 'snippet' || $parent->name === 'snippetArea');
$parent = $parent->parentNode
);
if (!$parent) {
throw new CompileException('Dynamic snippets are allowed only inside static snippet/snippetArea.');
}
$parent->data->dynamic = true;
$node->data->leave = true;
$node->closingCode = '<?php $this->global->snippetDriver->leave(); ?>';
$enterCode = '$this->global->snippetDriver->enter(' . $writer->formatWord($name) . ', "' . SnippetDriver::TYPE_DYNAMIC . '");';
if ($node->prefix) {
$node->attrCode = $writer->write("<?php echo ' id=\"' . htmlSpecialChars(\$this->global->snippetDriver->getHtmlId({$writer->formatWord($name)})) . '\"' ?>");
return $writer->write($enterCode);
}
$node->closingCode .= "\n</div>";
$this->checkExtraArgs($node);
return $writer->write("?>\n<div id=\"<?php echo htmlSpecialChars(\$this->global->snippetDriver->getHtmlId({$writer->formatWord($name)})) ?>\"><?php " . $enterCode);
} else {
$node->data->leave = true;
$node->data->func = $this->generateMethodName($name);
$fname = $writer->formatWord($name);
if ($node->name === 'define') {
$node->closingCode = '<?php ?>';
} else {
if (Helpers::startsWith((string) $node->context[1], Latte\Compiler::CONTEXT_HTML_ATTRIBUTE)) {
$node->context[1] = '';
$node->modifiers .= '|escape';
} elseif ($node->modifiers) {
$node->modifiers .= '|escape';
}
$node->closingCode = $writer->write('<?php $this->renderBlock(%raw, get_defined_vars()'
. ($node->modifiers ? ', function ($s, $type) { $_fi = new LR\FilterInfo($type); return %modifyContent($s); }' : '') . '); ?>', $fname);
}
$blockType = var_export(implode($node->context), true);
$this->checkExtraArgs($node);
return "\$this->checkBlockContentType($blockType, $fname);"
. "\$this->blockQueue[$fname][] = [\$this, '{$node->data->func}'];";
}
} elseif ($name[0] === '_') {
throw new CompileException("Block name '$name' must not start with an underscore.");
}
// static snippet/snippetArea
if ($node->name === 'snippet' || $node->name === 'snippetArea') {
if ($node->prefix && isset($node->htmlNode->attrs['id'])) {
throw new CompileException('Cannot combine HTML attribute id with n:snippet.');
}
$node->data->name = $name = '_' . $name;
}
if (isset($this->namedBlocks[$name])) {
throw new CompileException("Cannot redeclare static {$node->name} '$name'");
}
$extendsCheck = $this->namedBlocks ? '' : 'if ($this->getParentName()) return get_defined_vars();';
$this->namedBlocks[$name] = true;
if (Helpers::removeFilter($node->modifiers, 'escape')) {
trigger_error('Macro ' . $node->getNotation() . ' provides auto-escaping, remove |escape.');
}
if (Helpers::startsWith((string) $node->context[1], Latte\Compiler::CONTEXT_HTML_ATTRIBUTE)) {
$node->context[1] = '';
$node->modifiers .= '|escape';
} elseif ($node->modifiers) {
$node->modifiers .= '|escape';
}
$this->blockTypes[$name] = implode($node->context);
$include = '$this->renderBlock(%var, ' . (($node->name === 'snippet' || $node->name === 'snippetArea') ? '$this->params' : 'get_defined_vars()')
. ($node->modifiers ? ', function ($s, $type) { $_fi = new LR\FilterInfo($type); return %modifyContent($s); }' : '') . ')';
if ($node->name === 'snippet') {
if ($node->prefix) {
if (isset($node->htmlNode->macroAttrs['foreach'])) {
trigger_error('Combination of n:snippet with n:foreach is invalid, use n:inner-foreach.', E_USER_WARNING);
}
$node->attrCode = $writer->write('<?php echo \' id="\' . htmlSpecialChars($this->global->snippetDriver->getHtmlId(%var)) . \'"\' ?>', (string) substr($name, 1));
return $writer->write($include, $name);
}
$this->checkExtraArgs($node);
return $writer->write("?>\n<div id=\"<?php echo htmlSpecialChars(\$this->global->snippetDriver->getHtmlId(%var)) ?>\"><?php $include ?>\n</div><?php ",
(string) substr($name, 1), $name
);
} elseif ($node->name === 'define') {
$tokens = $node->tokenizer;
$args = [];
while ($tokens->isNext()) {
$arg = $tokens->consumeValue($tokens::T_VARIABLE);
$args[] = $arg . ' = $_args[' . count($args) . '] ?? ' . $arg . ' ?? null;';
if ($tokens->isNext()) {
$tokens->consumeValue(',');
}
}
$node->data->args = implode('', $args);
return $extendsCheck;
} else { // block, snippetArea
$this->checkExtraArgs($node);
return $writer->write($extendsCheck . $include, $name);
}
}
/**
* {/block}
* {/snippet}
* {/snippetArea}
* {/define}
*/
public function macroBlockEnd(MacroNode $node, PhpWriter $writer)
{
if (isset($node->data->name)) { // block, snippet, define
if ($asInner = $node->name === 'snippet' && $node->prefix === MacroNode::PREFIX_NONE) {
$node->content = $node->innerContent;
}
if (($node->name === 'snippet' || $node->name === 'snippetArea') && strpos($node->data->name, '$') === false) {
$type = $node->name === 'snippet' ? SnippetDriver::TYPE_STATIC : SnippetDriver::TYPE_AREA;
$node->content = '<?php $this->global->snippetDriver->enter('
. $writer->formatWord(substr($node->data->name, 1))
. ', "' . $type . '"); ?>'
. preg_replace('#(?<=\n)[ \t]+$#D', '', $node->content) . '<?php $this->global->snippetDriver->leave(); ?>';
}
if (empty($node->data->leave)) {
if (preg_match('#\$|n:#', $node->content)) {
$node->content = '<?php extract($_args);' . ($node->data->args ?? '') . ' ?>' . $node->content;
}
$this->namedBlocks[$node->data->name] = $tmp = preg_replace('#^\n+|(?<=\n)[ \t]+$#D', '', $node->content);
$node->content = substr_replace($node->content, $node->openingCode . "\n", strspn($node->content, "\n"), strlen($tmp));
$node->openingCode = '<?php ?>';
} elseif (isset($node->data->func)) {
$node->content = rtrim($node->content, " \t");
$this->getCompiler()->addMethod(
$node->data->func,
$this->getCompiler()->expandTokens("extract(\$_args);\n?>$node->content<?php"),
'$_args'
);
$node->content = '';
}
if ($asInner) { // n:snippet -> n:inner-snippet
$node->innerContent = $node->openingCode . $node->content . $node->closingCode;
$node->closingCode = $node->openingCode = '<?php ?>';
}
return ' '; // consume next new line
} elseif ($node->modifiers) { // anonymous block with modifier
$node->modifiers .= '|escape';
return $writer->write('$_fi = new LR\FilterInfo(%var); echo %modifyContent(ob_get_clean());', $node->context[0]);
}
}
/**
* {ifset block}
* {elseifset block}
*/
public function macroIfset(MacroNode $node, PhpWriter $writer)
{
if ($node->modifiers) {
throw new CompileException('Modifiers are not allowed in ' . $node->getNotation());
}
if (!preg_match('~#|[\w-]+$~DA', $node->args)) {
return false;
}
$list = [];
while (($name = $node->tokenizer->fetchWord()) !== null) {
$list[] = preg_match('~#|[\w-]+$~DA', $name)
? '$this->blockQueue["' . ltrim($name, '#') . '"]'
: $writer->formatArgs(new Latte\MacroTokens($name));
}
return ($node->name === 'elseifset' ? '} else' : '')
. 'if (isset(' . implode(', ', $list) . ')) {';
}
private function generateMethodName(string $blockName): string
{
$clean = trim(preg_replace('#\W+#', '_', $blockName), '_');
$name = 'block' . ucfirst($clean);
$methods = array_keys($this->getCompiler()->getMethods());
if (!$clean || in_array(strtolower($name), array_map('strtolower', $methods), true)) {
$name .= '_' . substr(md5($blockName), 0, 5);
}
return $name;
}
}