-
-
Notifications
You must be signed in to change notification settings - Fork 108
/
Engine.php
653 lines (522 loc) · 15 KB
/
Engine.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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
<?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;
use Latte\Compiler\Nodes\TemplateNode;
/**
* Templating engine Latte.
*/
class Engine
{
public const Version = '3.0.18';
public const VersionId = 30018;
/** @deprecated use Engine::Version */
public const
VERSION = self::Version,
VERSION_ID = self::VersionId;
/** @deprecated use ContentType::* */
public const
CONTENT_HTML = ContentType::Html,
CONTENT_XML = ContentType::Xml,
CONTENT_JS = ContentType::JavaScript,
CONTENT_CSS = ContentType::Css,
CONTENT_ICAL = ContentType::ICal,
CONTENT_TEXT = ContentType::Text;
private ?Loader $loader = null;
private Runtime\FilterExecutor $filters;
private Runtime\FunctionExecutor $functions;
private \stdClass $providers;
/** @var Extension[] */
private array $extensions = [];
private string $contentType = ContentType::Html;
private ?string $tempDirectory = null;
private bool $autoRefresh = true;
private bool $strictTypes = false;
private bool $strictParsing = false;
private ?Policy $policy = null;
private bool $sandboxed = false;
private ?string $phpBinary = null;
private ?string $cacheKey;
private ?string $locale = null;
public function __construct()
{
$this->filters = new Runtime\FilterExecutor;
$this->functions = new Runtime\FunctionExecutor;
$this->providers = new \stdClass;
$this->addExtension(new Essential\CoreExtension);
$this->addExtension(new Sandbox\SandboxExtension);
}
/**
* Renders template to output.
* @param object|mixed[] $params
*/
public function render(string $name, object|array $params = [], ?string $block = null): void
{
$template = $this->createTemplate($name, $this->processParams($params));
$template->global->coreCaptured = false;
$template->render($block);
}
/**
* Renders template to string.
* @param object|mixed[] $params
*/
public function renderToString(string $name, object|array $params = [], ?string $block = null): string
{
$template = $this->createTemplate($name, $this->processParams($params));
$template->global->coreCaptured = true;
return $template->capture(fn() => $template->render($block));
}
/**
* Creates template object.
* @param mixed[] $params
*/
public function createTemplate(string $name, array $params = [], $clearCache = true): Runtime\Template
{
$this->cacheKey = $clearCache ? null : $this->cacheKey;
$class = $this->getTemplateClass($name);
if (!class_exists($class, false)) {
$this->loadTemplate($name);
}
$this->providers->fn = $this->functions;
return new $class(
$this,
$params,
$this->filters,
$this->providers,
$name,
);
}
/**
* Compiles template to PHP code.
*/
public function compile(string $name): string
{
if ($this->sandboxed && !$this->policy) {
throw new \LogicException('In sandboxed mode you need to set a security policy.');
}
$template = $this->getLoader()->getContent($name);
try {
$node = $this->parse($template);
$this->applyPasses($node);
$compiled = $this->generate($node, $name);
} catch (\Throwable $e) {
if (!$e instanceof CompileException && !$e instanceof SecurityViolationException) {
$e = new CompileException("Thrown exception '{$e->getMessage()}'", previous: $e);
}
throw $e->setSource($template, $name);
}
if ($this->phpBinary) {
Compiler\PhpHelpers::checkCode($this->phpBinary, $compiled, "(compiled $name)");
}
return $compiled;
}
/**
* Parses template to AST node.
*/
public function parse(string $template): TemplateNode
{
$parser = new Compiler\TemplateParser;
$parser->strict = $this->strictParsing;
foreach ($this->extensions as $extension) {
$extension->beforeCompile($this);
$parser->addTags($extension->getTags());
}
return $parser
->setContentType($this->contentType)
->setPolicy($this->getPolicy(effective: true))
->parse($template);
}
/**
* Calls node visitors.
*/
public function applyPasses(TemplateNode &$node): void
{
$passes = [];
foreach ($this->extensions as $extension) {
$passes = array_merge($passes, $extension->getPasses());
}
$passes = Helpers::sortBeforeAfter($passes);
foreach ($passes as $pass) {
$pass = $pass instanceof \stdClass ? $pass->subject : $pass;
($pass)($node);
}
}
/**
* Generates compiled PHP code.
*/
public function generate(TemplateNode $node, string $name): string
{
$generator = new Compiler\TemplateGenerator;
return $generator->generate(
$node,
$this->getTemplateClass($name),
$name,
$this->strictTypes,
);
}
/**
* Compiles template to cache.
* @throws \LogicException
*/
public function warmupCache(string $name): void
{
if (!$this->tempDirectory) {
throw new \LogicException('Path to temporary directory is not set.');
}
$class = $this->getTemplateClass($name);
if (!class_exists($class, false)) {
$this->loadTemplate($name);
}
}
private function loadTemplate(string $name): void
{
if (!$this->tempDirectory) {
$compiled = $this->compile($name);
if (@eval(substr($compiled, 5)) === false) { // @ is escalated to exception, substr removes <?php
throw (new CompileException('Error in template: ' . error_get_last()['message']))
->setSource($compiled, "$name (compiled)");
}
return;
}
// Solving atomicity to work everywhere is really pain in the ass.
// 1) We want to do as little as possible IO calls on production and also directory and file can be not writable
// so on Linux we include the file directly without shared lock, therefore, the file must be created atomically by renaming.
// 2) On Windows file cannot be renamed-to while is open (ie by include), so we have to acquire a lock.
$cacheFile = $this->getCacheFile($name);
$cacheKey = $this->autoRefresh
? md5(serialize($this->getCacheSignature($name)))
: null;
$lock = defined('PHP_WINDOWS_VERSION_BUILD') || $this->autoRefresh
? $this->acquireLock("$cacheFile.lock", LOCK_SH)
: null;
if (
!($this->autoRefresh && $cacheKey !== stream_get_contents($lock))
&& (@include $cacheFile) !== false // @ - file may not exist
) {
return;
}
if ($lock) {
flock($lock, LOCK_UN); // release shared lock so we can get exclusive
fseek($lock, 0);
}
$lock = $this->acquireLock("$cacheFile.lock", LOCK_EX);
// while waiting for exclusive lock, someone might have already created the cache
if (!is_file($cacheFile) || ($this->autoRefresh && $cacheKey !== stream_get_contents($lock))) {
$compiled = $this->compile($name);
if (
file_put_contents("$cacheFile.tmp", $compiled) !== strlen($compiled)
|| !rename("$cacheFile.tmp", $cacheFile)
) {
@unlink("$cacheFile.tmp"); // @ - file may not exist
throw new RuntimeException("Unable to create '$cacheFile'.");
}
fseek($lock, 0);
fwrite($lock, $cacheKey ?? md5(serialize($this->getCacheSignature($name))));
ftruncate($lock, ftell($lock));
if (function_exists('opcache_invalidate')) {
@opcache_invalidate($cacheFile, true); // @ can be restricted
}
}
if ((include $cacheFile) === false) {
throw new RuntimeException("Unable to load '$cacheFile'.");
}
flock($lock, LOCK_UN);
}
/**
* @return resource
*/
private function acquireLock(string $file, int $mode)
{
$dir = dirname($file);
if (!is_dir($dir) && !@mkdir($dir) && !is_dir($dir)) { // @ - dir may already exist
throw new RuntimeException("Unable to create directory '$dir'. " . error_get_last()['message']);
}
$handle = @fopen($file, 'c+'); // @ is escalated to exception
if (!$handle) {
throw new RuntimeException("Unable to create file '$file'. " . error_get_last()['message']);
} elseif (!@flock($handle, $mode)) { // @ is escalated to exception
throw new RuntimeException('Unable to acquire ' . ($mode & LOCK_EX ? 'exclusive' : 'shared') . " lock on file '$file'. " . error_get_last()['message']);
}
return $handle;
}
public function getCacheFile(string $name): string
{
$base = preg_match('#([/\\\\][\w@.-]{3,35}){1,3}$#D', '/' . $name, $m)
? preg_replace('#[^\w@.-]+#', '-', substr($m[0], 1)) . '--'
: '';
return $this->tempDirectory . '/' . $base . $this->generateCacheHash($name) . '.php';
}
public function getTemplateClass(string $name): string
{
return 'Template_' . $this->generateCacheHash($name);
}
private function generateCacheHash(string $name): string
{
$this->cacheKey ??= md5(serialize($this->getCacheKey()));
$hash = $this->cacheKey . $this->getLoader()->getUniqueId($name);
return substr(md5($hash), 0, 10);
}
/**
* Values that affect the results of compilation and the name of the cache file.
*/
protected function getCacheKey(): array
{
return [
$this->contentType,
array_keys($this->getFunctions()),
array_map(
fn($extension) => [
get_debug_type($extension),
$extension->getCacheKey($this),
filemtime((new \ReflectionObject($extension))->getFileName()),
],
$this->extensions,
),
];
}
/**
* Values that check the expiration of the compiled template.
*/
protected function getCacheSignature(string $name): array
{
return [
self::Version,
$this->getLoader()->getContent($name),
array_map(
fn($extension) => filemtime((new \ReflectionObject($extension))->getFileName()),
$this->extensions,
),
];
}
/**
* Registers run-time filter.
*/
public function addFilter(string $name, callable $callback): static
{
if (!preg_match('#^[a-z]\w*$#iD', $name)) {
throw new \LogicException("Invalid filter name '$name'.");
}
$this->filters->add($name, $callback);
return $this;
}
/**
* Registers filter loader.
*/
public function addFilterLoader(callable $loader): static
{
$this->filters->add(null, $loader);
return $this;
}
/**
* Returns all run-time filters.
* @return callable[]
*/
public function getFilters(): array
{
return $this->filters->getAll();
}
/**
* Call a run-time filter.
* @param mixed[] $args
*/
public function invokeFilter(string $name, array $args): mixed
{
return ($this->filters->$name)(...$args);
}
/**
* Adds new extension.
*/
public function addExtension(Extension $extension): static
{
$this->extensions[] = $extension;
foreach ($extension->getFilters() as $name => $value) {
$this->filters->add($name, $value);
}
foreach ($extension->getFunctions() as $name => $value) {
$this->functions->add($name, $value);
}
foreach ($extension->getProviders() as $name => $value) {
$this->providers->$name = $value;
}
return $this;
}
/** @return Extension[] */
public function getExtensions(): array
{
return $this->extensions;
}
/**
* Registers run-time function.
*/
public function addFunction(string $name, callable $callback): static
{
if (!preg_match('#^[a-z]\w*$#iD', $name)) {
throw new \LogicException("Invalid function name '$name'.");
}
$this->functions->add($name, $callback);
return $this;
}
/**
* Call a run-time function.
* @param mixed[] $args
*/
public function invokeFunction(string $name, array $args): mixed
{
return ($this->functions->$name)(null, ...$args);
}
/**
* @return callable[]
*/
public function getFunctions(): array
{
return $this->functions->getAll();
}
/**
* Adds new provider.
*/
public function addProvider(string $name, mixed $provider): static
{
if (!preg_match('#^[a-z]\w*$#iD', $name)) {
throw new \LogicException("Invalid provider name '$name'.");
}
$this->providers->$name = $provider;
return $this;
}
/**
* Returns all providers.
* @return mixed[]
*/
public function getProviders(): array
{
return (array) $this->providers;
}
public function setPolicy(?Policy $policy): static
{
$this->policy = $policy;
return $this;
}
public function getPolicy(bool $effective = false): ?Policy
{
return !$effective || $this->sandboxed
? $this->policy
: null;
}
public function setExceptionHandler(callable $handler): static
{
$this->providers->coreExceptionHandler = $handler;
return $this;
}
public function setSandboxMode(bool $state = true): static
{
$this->sandboxed = $state;
return $this;
}
public function setContentType(string $type): static
{
$this->contentType = $type;
return $this;
}
/**
* Sets path to temporary directory.
*/
public function setTempDirectory(?string $path): static
{
$this->tempDirectory = $path;
return $this;
}
/**
* Sets auto-refresh mode.
*/
public function setAutoRefresh(bool $state = true): static
{
$this->autoRefresh = $state;
return $this;
}
/**
* Enables declare(strict_types=1) in templates.
*/
public function setStrictTypes(bool $state = true): static
{
$this->strictTypes = $state;
return $this;
}
public function setStrictParsing(bool $state = true): static
{
$this->strictParsing = $state;
return $this;
}
public function isStrictParsing(): bool
{
return $this->strictParsing;
}
/**
* Sets the locale. It uses the same identifiers as the PHP intl extension.
*/
public function setLocale(?string $locale): static
{
if ($locale && !extension_loaded('intl')) {
throw new RuntimeException("Setting a locale requires the 'intl' extension to be installed.");
}
$this->locale = $locale;
return $this;
}
public function getLocale(): ?string
{
return $this->locale;
}
public function setLoader(Loader $loader): static
{
$this->loader = $loader;
return $this;
}
public function getLoader(): Loader
{
return $this->loader ??= new Loaders\FileLoader;
}
public function enablePhpLinter(?string $phpBinary): static
{
$this->phpBinary = $phpBinary;
return $this;
}
/**
* @param object|mixed[] $params
* @return mixed[]
*/
private function processParams(object|array $params): array
{
if (is_array($params)) {
return $params;
}
$methods = (new \ReflectionClass($params))->getMethods(\ReflectionMethod::IS_PUBLIC);
foreach ($methods as $method) {
if ($method->getAttributes(Attributes\TemplateFilter::class)) {
$this->addFilter($method->name, [$params, $method->name]);
}
if ($method->getAttributes(Attributes\TemplateFunction::class)) {
$this->addFunction($method->name, [$params, $method->name]);
}
if (strpos((string) $method->getDocComment(), '@filter')) {
trigger_error('Annotation @filter is deprecated, use attribute #[Latte\Attributes\TemplateFilter]', E_USER_DEPRECATED);
$this->addFilter($method->name, [$params, $method->name]);
}
if (strpos((string) $method->getDocComment(), '@function')) {
trigger_error('Annotation @function is deprecated, use attribute #[Latte\Attributes\TemplateFunction]', E_USER_DEPRECATED);
$this->addFunction($method->name, [$params, $method->name]);
}
}
return array_filter((array) $params, fn($key) => $key[0] !== "\0", ARRAY_FILTER_USE_KEY);
}
public function __get(string $name)
{
if ($name === 'onCompile') {
$trace = debug_backtrace(0)[0];
$loc = isset($trace['file'], $trace['line'])
? ' (in ' . $trace['file'] . ' on ' . $trace['line'] . ')'
: '';
throw new \LogicException('You use Latte 3 together with the code designed for Latte 2' . $loc);
}
}
}