forked from phptal/PHPTAL
/
SaxXmlParser.php
568 lines (512 loc) · 21.8 KB
/
SaxXmlParser.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
<?php
declare(strict_types=1);
/**
* PHPTAL templating engine
*
* @category HTML
* @package PHPTAL
* @author Laurent Bedubourg <lbedubourg@motion-twin.com>
* @author Kornel Lesiński <kornel@aardvarkmedia.co.uk>
* @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
* @link http://phptal.org/
*/
namespace PhpTal\Dom;
use PhpTal\Exception\IOException;
use PhpTal\Exception\ParserException;
use PhpTal\Exception\TemplateException;
/**
* Simple sax like xml parser for PHPTAL
* ("Dom" in the class name comes from name of the directory, not mode of operation)
*
* At the time this parser was created, standard PHP libraries were not suitable
* (could not retrieve doctypes, xml declaration, problems with comments and CDATA).
*
* There are still some problems: XML parsers don't care about exact format of enties
* or CDATA sections (PHPTAL tries to preserve them),
* <?php ?> blocks are not allowed in attributes.
*
* This parser failed to enforce some XML well-formedness constraints,
* and there are ill-formed templates "in the wild" because of this.
*
* @package PHPTAL
* @see PHPTAL_DOM_DocumentBuilder
*/
class SaxXmlParser
{
// available parser states
public const ST_ROOT = 0;
public const ST_TEXT = 1;
public const ST_LT = 2;
public const ST_TAG_NAME = 3;
public const ST_TAG_CLOSE = 4;
public const ST_TAG_SINGLE = 5;
public const ST_TAG_ATTRIBUTES = 6;
public const ST_TAG_BETWEEN_ATTRIBUTE = 7;
public const ST_CDATA = 8;
public const ST_COMMENT = 9;
public const ST_DOCTYPE = 10;
public const ST_XMLDEC = 11;
public const ST_PREPROC = 12;
public const ST_ATTR_KEY = 13;
public const ST_ATTR_EQ = 14;
public const ST_ATTR_QUOTE = 15;
public const ST_ATTR_VALUE = 16;
public const BOM_STR = "\xef\xbb\xbf";
/**
* @var array
*/
public static $state_names = [
self::ST_ROOT => 'root node',
self::ST_TEXT => 'text',
self::ST_LT => 'start of tag',
self::ST_TAG_NAME => 'tag name',
self::ST_TAG_CLOSE => 'closing tag',
self::ST_TAG_SINGLE => 'self-closing tag',
self::ST_TAG_ATTRIBUTES => 'tag',
self::ST_TAG_BETWEEN_ATTRIBUTE => 'tag attributes',
self::ST_CDATA => 'CDATA',
self::ST_COMMENT => 'comment',
self::ST_DOCTYPE => 'doctype',
self::ST_XMLDEC => 'XML declaration',
self::ST_PREPROC => 'preprocessor directive',
self::ST_ATTR_KEY => 'attribute name',
self::ST_ATTR_EQ => 'attribute value',
self::ST_ATTR_QUOTE => 'quoted attribute value',
self::ST_ATTR_VALUE => 'unquoted attribute value',
];
/**
* @var string
*/
private $file;
/**
* @var int
*/
private $line;
/**
* @var string
*/
private $input_encoding;
/**
* SaxXmlParser constructor.
*
* @param string $input_encoding
*/
public function __construct(string $input_encoding)
{
$this->input_encoding = $input_encoding;
$this->file = '<string>';
}
/**
* @param DocumentBuilder $builder
* @param string $src
*
* @return DocumentBuilder
* @throws IOException
* @throws ParserException
* @throws TemplateException
*/
public function parseFile(DocumentBuilder $builder, string $src): DocumentBuilder
{
if (!file_exists($src)) {
throw new IOException("file $src not found");
}
return $this->parseString($builder, file_get_contents($src), $src);
}
/**
* @param DocumentBuilder $builder
* @param string $src
* @param string $filename
*
* @return DocumentBuilder
* @throws ParserException
* @throws TemplateException
*/
public function parseString(DocumentBuilder $builder, string $src, string $filename = null): DocumentBuilder
{
try {
$builder->setEncoding($this->input_encoding);
$this->file = $filename ?? '<string>';
$this->line = 1;
$state = self::ST_ROOT;
$mark = 0;
$len = strlen($src);
$quoteStyle = '"';
$tagname = '';
$attribute = '';
$attributes = [];
$customDoctype = false;
$builder->setSource($this->file, $this->line);
$builder->onDocumentStart();
$i = 0;
// remove BOM (UTF-8 byte order mark)...
if (strpos($src, self::BOM_STR) === 0) {
$i = 3;
}
for (; $i < $len; $i++) {
$c = $src[$i]; // Change to substr($src, $i, 1); if you want to use mb_string.func_overload
if ($c === "\n") {
$builder->setSource($this->file, ++$this->line);
}
switch ($state) {
case self::ST_ROOT:
if ($c === '<') {
$mark = $i; // mark tag start
$state = self::ST_LT;
} elseif (!self::isWhiteChar($c)) {
$this->raiseError('Characters found before beginning of the document! (wrap document in < tal:block > to avoid this error)');
}
break;
case self::ST_TEXT:
if ($c === '<') {
if ($mark !== $i) {
$builder->onElementData(
$this->sanitizeEscapedText(
$this->checkEncoding(
substr($src, $mark, $i - $mark)
)
)
);
}
$mark = $i;
$state = self::ST_LT;
}
break;
case self::ST_LT:
if ($c === '/') {
$mark = $i + 1;
$state = self::ST_TAG_CLOSE;
} elseif ($c === '?' && strtolower(substr($src, $i, 5)) === '?xml ') {
$state = self::ST_XMLDEC;
} elseif ($c === '?') {
$state = self::ST_PREPROC;
} elseif ($c === '!' && substr($src, $i, 3) === '!--') {
$state = self::ST_COMMENT;
} elseif ($c === '!' && substr($src, $i, 8) === '![CDATA[') {
$state = self::ST_CDATA;
$mark = $i + 8; // past opening tag
} elseif ($c === '!' && strtoupper(substr($src, $i, 8)) === '!DOCTYPE') {
$state = self::ST_DOCTYPE;
} elseif (self::isWhiteChar($c)) {
$state = self::ST_TEXT;
} else {
$mark = $i; // mark node name start
$attributes = [];
$attribute = '';
$state = self::ST_TAG_NAME;
}
break;
case self::ST_TAG_NAME:
if (self::isWhiteChar($c) || $c === '/' || $c === '>') {
$tagname = substr($src, $mark, $i - $mark);
if (!$this->isValidQName($tagname)) {
$this->raiseError("Invalid tag name '$tagname'");
}
if ($c === '/') {
$state = self::ST_TAG_SINGLE;
} elseif ($c === '>') {
$mark = $i + 1; // mark text start
$state = self::ST_TEXT;
$builder->onElementStart($tagname, $attributes);
} else /* isWhiteChar */ {
$state = self::ST_TAG_ATTRIBUTES;
}
}
break;
case self::ST_TAG_CLOSE:
if ($c === '>') {
$tagname = rtrim(substr($src, $mark, $i - $mark));
$builder->onElementClose($tagname);
$mark = $i + 1; // mark text start
$state = self::ST_TEXT;
}
break;
case self::ST_TAG_SINGLE:
if ($c !== '>') {
$this->raiseError("Expected '/>', but found '/$c' inside tag < $tagname >");
}
$mark = $i + 1; // mark text start
$state = self::ST_TEXT;
$builder->onElementStart($tagname, $attributes);
$builder->onElementClose($tagname);
break;
case self::ST_TAG_BETWEEN_ATTRIBUTE:
case self::ST_TAG_ATTRIBUTES:
if ($c === '>') {
$mark = $i + 1; // mark text start
$state = self::ST_TEXT;
$builder->onElementStart($tagname, $attributes);
} elseif ($c === '/') {
$state = self::ST_TAG_SINGLE;
} elseif (self::isWhiteChar($c)) {
$state = self::ST_TAG_ATTRIBUTES;
} elseif ($state === self::ST_TAG_ATTRIBUTES && $this->isValidQName($c)) {
$mark = $i; // mark attribute key start
$state = self::ST_ATTR_KEY;
} else {
$this->raiseError("Unexpected character '$c' between attributes of < $tagname >");
}
break;
case self::ST_COMMENT:
if ($c === '>' && $i > $mark + 4 && substr($src, $i - 2, 2) === '--') {
if (preg_match('/^-|--|-$/', substr($src, $mark + 4, $i - $mark + 1 - 7))) {
$this->raiseError(
"Ill-formed comment. XML comments are not allowed to contain '--' or start/end with '-': " .
substr($src, $mark + 4, $i - $mark + 1 - 7)
);
}
$builder->onComment($this->checkEncoding(substr($src, $mark + 4, $i - $mark + 1 - 7)));
$mark = $i + 1; // mark text start
$state = self::ST_TEXT;
}
break;
case self::ST_CDATA:
if ($c === '>' && substr($src, $i - 2, 2) === ']]') {
$builder->onCDATASection($this->checkEncoding(substr($src, $mark, $i - $mark - 2)));
$mark = $i + 1; // mark text start
$state = self::ST_TEXT;
}
break;
case self::ST_XMLDEC:
if ($c === '?' && substr($src, $i, 2) === '?>') {
$builder->onXmlDecl($this->checkEncoding(substr($src, $mark, $i - $mark + 2)));
$i++; // skip '>'
$mark = $i + 1; // mark text start
$state = self::ST_TEXT;
}
break;
case self::ST_DOCTYPE:
if ($c === '[') {
$customDoctype = true;
} elseif ($customDoctype && $c === '>' && substr($src, $i - 1, 2) === ']>') {
$customDoctype = false;
$builder->onDocType($this->checkEncoding(substr($src, $mark, $i - $mark + 1)));
$mark = $i + 1; // mark text start
$state = self::ST_TEXT;
} elseif (!$customDoctype && $c === '>') {
$customDoctype = false;
$builder->onDocType($this->checkEncoding(substr($src, $mark, $i - $mark + 1)));
$mark = $i + 1; // mark text start
$state = self::ST_TEXT;
}
break;
case self::ST_PREPROC:
if ($c === '>' && $src[$i - 1] === '?') {
$builder->onProcessingInstruction($this->checkEncoding(substr($src, $mark, $i - $mark + 1)));
$mark = $i + 1; // mark text start
$state = self::ST_TEXT;
}
break;
case self::ST_ATTR_KEY:
if ($c === '=' || self::isWhiteChar($c)) {
$attribute = substr($src, $mark, $i - $mark);
if (!$this->isValidQName($attribute)) {
$this->raiseError("Invalid attribute name '$attribute' in < $tagname >");
}
if (isset($attributes[$attribute])) {
$this->raiseError("Attribute $attribute in < $tagname > is defined more than once");
}
if ($c === '=') {
$state = self::ST_ATTR_VALUE;
} else /* white char */ {
$state = self::ST_ATTR_EQ;
}
} elseif ($c === '/' || $c === '>') {
$attribute = substr($src, $mark, $i - $mark);
if (!$this->isValidQName($attribute)) {
$this->raiseError("Invalid attribute name '$attribute'");
}
$this->raiseError("Attribute $attribute does not have value (found end of tag instead of '=')");
}
break;
case self::ST_ATTR_EQ:
if ($c === '=') {
$state = self::ST_ATTR_VALUE;
} elseif (!self::isWhiteChar($c)) {
$this->raiseError("Attribute $attribute in < $tagname > does not have value (found character '$c' instead of '=')");
}
break;
case self::ST_ATTR_VALUE:
if (self::isWhiteChar($c)) {
// noop
} elseif ($c === '"' || $c === '\'') {
$quoteStyle = $c;
$state = self::ST_ATTR_QUOTE;
$mark = $i + 1; // mark attribute real value start
} else {
$this->raiseError("Value of attribute $attribute in < $tagname > is not in quotes (found character '$c' instead of quote)");
}
break;
case self::ST_ATTR_QUOTE:
if ($c === $quoteStyle) {
$attributes[$attribute] = $this->sanitizeEscapedText($this->checkEncoding(substr($src, $mark, $i - $mark)));
// PHPTAL's code generator assumes input is escaped for double-quoted strings. Single-quoted attributes need to be converted.
// FIXME: it should be escaped at later stage.
$attributes[$attribute] = str_replace('"', '"', $attributes[$attribute]);
$state = self::ST_TAG_BETWEEN_ATTRIBUTE;
}
break;
}
}
if ($state === self::ST_TEXT) {// allows text past root node, which is in violation of XML spec
if ($i > $mark) {
$text = substr($src, $mark, $i - $mark);
if (!ctype_space($text)) {
$this->raiseError('Characters found after end of the root element (wrap document in < tal:block > to avoid this error)');
}
}
} else {
if ($state === self::ST_ROOT) {
$msg = 'Document does not have any tags';
} else {
$msg = 'Finished document in unexpected state: ' . self::$state_names[$state] . ' is not finished';
}
$this->raiseError($msg);
}
$builder->onDocumentEnd();
} catch (ParserException $e) {
$e->hintSrcPosition($this->file, $this->line);
throw $e;
} catch (TemplateException $e) {
$e->hintSrcPosition($this->file, $this->line);
throw $e;
}
return $builder;
}
/**
* @param string $name
*
* @return false|int
* @throws ParserException
*/
private function isValidQName(string $name): bool
{
$name = $this->checkEncoding($name);
return (bool) preg_match(
'/^([a-z_\x80-\xff]+[a-z0-9._\x80-\xff-]*:)?[a-z_\x80-\xff]+[a-z0-9._\x80-\xff-]*$/i',
$name
);
}
/**
* @param string $str
*
* @return string
* @throws ParserException
*/
private function checkEncoding(string $str): string
{
if ($str === '') {
return '';
}
if ($this->input_encoding === 'UTF-8') {
// $match expression below somehow triggers quite deep recurrency and stack overflow in preg
// to avoid this, check string bit by bit, omitting ASCII fragments.
if (strlen($str) > 200) {
$chunks = preg_split('/(?>[\x09\x0A\x0D\x20-\x7F]+)/', $str, -1, PREG_SPLIT_NO_EMPTY);
foreach ($chunks as $chunk) {
if (strlen($chunk) < 200) {
$this->checkEncoding($chunk);
}
}
return $str;
}
// http://www.w3.org/International/questions/qa-forms-utf-8
$match = '[\x09\x0A\x0D\x20-\x7F]' // ASCII
. '|[\xC2-\xDF][\x80-\xBF]' // non-overlong 2-byte
. '|\xE0[\xA0-\xBF][\x80-\xBF]' // excluding overlongs
. '|[\xE1-\xEC\xEE\xEE][\x80-\xBF]{2}' // straight 3-byte (exclude FFFE and FFFF)
. '|\xEF[\x80-\xBE][\x80-\xBF]' // straight 3-byte
. '|\xEF\xBF[\x80-\xBD]' // straight 3-byte
. '|\xED[\x80-\x9F][\x80-\xBF]' // excluding surrogates
. '|\xF0[\x90-\xBF][\x80-\xBF]{2}' // planes 1-3
. '|[\xF1-\xF3][\x80-\xBF]{3}' // planes 4-15
. '|\xF4[\x80-\x8F][\x80-\xBF]{2}'; // plane 16
if (!preg_match('/^(?:(?>' . $match . '))+$/s', $str)) {
$res = preg_split('/((?>' . $match . ')+)/s', $str, -1, PREG_SPLIT_DELIM_CAPTURE);
for ($i = 0, $iMax = count($res); $i < $iMax; $i += 2) {
$res[$i] = self::convertBytesToEntities(array(1 => $res[$i]));
}
$this->raiseError('Invalid UTF-8 bytes: ' . implode('', $res));
}
}
if ($this->input_encoding === 'ISO-8859-1') {
// http://www.w3.org/TR/2006/REC-xml11-20060816/#NT-RestrictedChar
$forbid = '/((?>[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x84\x86-\x9F]+))/s';
if (preg_match($forbid, $str)) {
$str = preg_replace_callback($forbid, ['self', 'convertBytesToEntities'], $str);
$this->raiseError('Invalid ISO-8859-1 characters: ' . $str);
}
}
return $str;
}
/**
* preg callback
* Changes all bytes to hexadecimal XML entities
*
* @param array $m first array element is used for input
*
* @return string
*/
private static function convertBytesToEntities(array $m): string
{
$m = $m[1];
$out = '';
for ($i = 0, $iMax = strlen($m); $i < $iMax; $i++) {
$out .= '&#X'.strtoupper(dechex(ord($m[$i]))).';';
}
return $out;
}
/**
* This is where this parser violates XML and refuses to be an annoying bastard.
*
* @param string $str
*
* @return string
*/
private function sanitizeEscapedText(string $str): string
{
$str = str_replace(''', ''', $str); // PHP's html_entity_decode doesn't seem to support that!
// corrects all non-entities and neutralizes potentially problematic CDATA end marker
$str = strtr(
preg_replace(
'/&(?!(?:#x?[a-f0-9]+|[a-z][a-z0-9]*);)/i',
'&',
$str
),
['<' => '<', ']]>' => ']]>']
);
return $str;
}
/**
* @return string
*/
public function getSourceFile(): string
{
return $this->file;
}
/**
* @return int
*/
public function getLineNumber(): int
{
return $this->line;
}
/**
* @param string $c
*
* @return bool
*/
public static function isWhiteChar($c): bool
{
return strpos(" \t\n\r\0", $c) !== false;
}
/**
* @param string $errStr
*
* @return void
* @throws ParserException
*/
protected function raiseError(string $errStr): void
{
throw new ParserException($errStr, $this->file, $this->line);
}
}