Inline.php 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Yaml;
  11. use Symfony\Component\Yaml\Exception\DumpException;
  12. use Symfony\Component\Yaml\Exception\ParseException;
  13. use Symfony\Component\Yaml\Tag\TaggedValue;
  14. /**
  15. * Inline implements a YAML parser/dumper for the YAML inline syntax.
  16. *
  17. * @author Fabien Potencier <fabien@symfony.com>
  18. *
  19. * @internal
  20. */
  21. class Inline
  22. {
  23. public const REGEX_QUOTED_STRING = '(?:"([^"\\\\]*+(?:\\\\.[^"\\\\]*+)*+)"|\'([^\']*+(?:\'\'[^\']*+)*+)\')';
  24. public static int $parsedLineNumber = -1;
  25. public static ?string $parsedFilename = null;
  26. private static bool $exceptionOnInvalidType = false;
  27. private static bool $objectSupport = false;
  28. private static bool $objectForMap = false;
  29. private static bool $constantSupport = false;
  30. public static function initialize(int $flags, ?int $parsedLineNumber = null, ?string $parsedFilename = null): void
  31. {
  32. self::$exceptionOnInvalidType = (bool) (Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE & $flags);
  33. self::$objectSupport = (bool) (Yaml::PARSE_OBJECT & $flags);
  34. self::$objectForMap = (bool) (Yaml::PARSE_OBJECT_FOR_MAP & $flags);
  35. self::$constantSupport = (bool) (Yaml::PARSE_CONSTANT & $flags);
  36. self::$parsedFilename = $parsedFilename;
  37. if (null !== $parsedLineNumber) {
  38. self::$parsedLineNumber = $parsedLineNumber;
  39. }
  40. }
  41. /**
  42. * Converts a YAML string to a PHP value.
  43. *
  44. * @param int $flags A bit field of Yaml::PARSE_* constants to customize the YAML parser behavior
  45. * @param array $references Mapping of variable names to values
  46. *
  47. * @throws ParseException
  48. */
  49. public static function parse(string $value, int $flags = 0, array &$references = []): mixed
  50. {
  51. self::initialize($flags);
  52. $value = trim($value);
  53. if ('' === $value) {
  54. return '';
  55. }
  56. $i = 0;
  57. $tag = self::parseTag($value, $i, $flags);
  58. switch ($value[$i]) {
  59. case '[':
  60. $result = self::parseSequence($value, $flags, $i, $references);
  61. ++$i;
  62. break;
  63. case '{':
  64. $result = self::parseMapping($value, $flags, $i, $references);
  65. ++$i;
  66. break;
  67. default:
  68. $result = self::parseScalar($value, $flags, null, $i, true, $references);
  69. }
  70. // some comments are allowed at the end
  71. if (preg_replace('/\s*#.*$/A', '', substr($value, $i))) {
  72. throw new ParseException(\sprintf('Unexpected characters near "%s".', substr($value, $i)), self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  73. }
  74. if (null !== $tag && '' !== $tag) {
  75. return new TaggedValue($tag, $result);
  76. }
  77. return $result;
  78. }
  79. /**
  80. * Dumps a given PHP variable to a YAML string.
  81. *
  82. * @param mixed $value The PHP variable to convert
  83. * @param int $flags A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
  84. *
  85. * @throws DumpException When trying to dump PHP resource
  86. */
  87. public static function dump(mixed $value, int $flags = 0, bool $rootLevel = false): string
  88. {
  89. switch (true) {
  90. case \is_resource($value):
  91. if (Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE & $flags) {
  92. throw new DumpException(\sprintf('Unable to dump PHP resources in a YAML file ("%s").', get_resource_type($value)));
  93. }
  94. return self::dumpNull($flags);
  95. case $value instanceof \DateTimeInterface:
  96. return $value->format(match (true) {
  97. !$length = \strlen(rtrim($value->format('u'), '0')) => 'c',
  98. $length < 4 => 'Y-m-d\TH:i:s.vP',
  99. default => 'Y-m-d\TH:i:s.uP',
  100. });
  101. case $value instanceof \UnitEnum:
  102. return \sprintf('!php/enum %s::%s', $value::class, $value->name);
  103. case \is_object($value):
  104. if ($value instanceof TaggedValue) {
  105. return '!'.$value->getTag().' '.self::dump($value->getValue(), $flags);
  106. }
  107. if (Yaml::DUMP_OBJECT & $flags) {
  108. return '!php/object '.self::dump(serialize($value));
  109. }
  110. if (Yaml::DUMP_OBJECT_AS_MAP & $flags && ($value instanceof \stdClass || $value instanceof \ArrayObject)) {
  111. return self::dumpHashArray($value, $flags);
  112. }
  113. if (Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE & $flags) {
  114. throw new DumpException('Object support when dumping a YAML file has been disabled.');
  115. }
  116. return self::dumpNull($flags);
  117. case \is_array($value):
  118. return self::dumpArray($value, $flags);
  119. case null === $value:
  120. return self::dumpNull($flags, $rootLevel);
  121. case true === $value:
  122. return 'true';
  123. case false === $value:
  124. return 'false';
  125. case \is_int($value):
  126. return $value;
  127. case is_numeric($value) && false === strpbrk($value, "\f\n\r\t\v"):
  128. $locale = setlocale(\LC_NUMERIC, 0);
  129. if (false !== $locale) {
  130. setlocale(\LC_NUMERIC, 'C');
  131. }
  132. if (\is_float($value)) {
  133. $repr = (string) $value;
  134. if (is_infinite($value)) {
  135. $repr = str_ireplace('INF', '.Inf', $repr);
  136. } elseif (floor($value) == $value && $repr == $value) {
  137. // Preserve float data type since storing a whole number will result in integer value.
  138. if (!str_contains($repr, 'E')) {
  139. $repr .= '.0';
  140. }
  141. }
  142. } else {
  143. $repr = \is_string($value) ? "'$value'" : (string) $value;
  144. }
  145. if (false !== $locale) {
  146. setlocale(\LC_NUMERIC, $locale);
  147. }
  148. return $repr;
  149. case '' == $value:
  150. return "''";
  151. case self::isBinaryString($value):
  152. return '!!binary '.base64_encode($value);
  153. case Escaper::requiresDoubleQuoting($value):
  154. case Yaml::DUMP_FORCE_DOUBLE_QUOTES_ON_VALUES & $flags:
  155. return Escaper::escapeWithDoubleQuotes($value);
  156. case Escaper::requiresSingleQuoting($value):
  157. $singleQuoted = Escaper::escapeWithSingleQuotes($value);
  158. if (!str_contains($value, "'")) {
  159. return $singleQuoted;
  160. }
  161. // Attempt double-quoting the string instead to see if it's more efficient.
  162. $doubleQuoted = Escaper::escapeWithDoubleQuotes($value);
  163. return \strlen($doubleQuoted) < \strlen($singleQuoted) ? $doubleQuoted : $singleQuoted;
  164. case Parser::preg_match('{^[0-9]+[_0-9]*$}', $value):
  165. case Parser::preg_match(self::getHexRegex(), $value):
  166. case Parser::preg_match(self::getTimestampRegex(), $value):
  167. return Escaper::escapeWithSingleQuotes($value);
  168. default:
  169. return $value;
  170. }
  171. }
  172. /**
  173. * Check if given array is hash or just normal indexed array.
  174. */
  175. public static function isHash(array|\ArrayObject|\stdClass $value): bool
  176. {
  177. if ($value instanceof \stdClass || $value instanceof \ArrayObject) {
  178. return true;
  179. }
  180. $expectedKey = 0;
  181. foreach ($value as $key => $val) {
  182. if ($key !== $expectedKey++) {
  183. return true;
  184. }
  185. }
  186. return false;
  187. }
  188. /**
  189. * Dumps a PHP array to a YAML string.
  190. *
  191. * @param array $value The PHP array to dump
  192. * @param int $flags A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
  193. */
  194. private static function dumpArray(array $value, int $flags): string
  195. {
  196. // array
  197. if (($value || Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE & $flags) && !self::isHash($value)) {
  198. $output = [];
  199. foreach ($value as $val) {
  200. $output[] = self::dump($val, $flags);
  201. }
  202. return \sprintf('[%s]', implode(', ', $output));
  203. }
  204. return self::dumpHashArray($value, $flags);
  205. }
  206. /**
  207. * Dumps hash array to a YAML string.
  208. *
  209. * @param array|\ArrayObject|\stdClass $value The hash array to dump
  210. * @param int $flags A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
  211. */
  212. private static function dumpHashArray(array|\ArrayObject|\stdClass $value, int $flags): string
  213. {
  214. $output = [];
  215. $keyFlags = $flags & ~Yaml::DUMP_FORCE_DOUBLE_QUOTES_ON_VALUES;
  216. foreach ($value as $key => $val) {
  217. if (\is_int($key) && Yaml::DUMP_NUMERIC_KEY_AS_STRING & $flags) {
  218. $key = (string) $key;
  219. }
  220. $output[] = \sprintf('%s: %s', self::dump($key, $keyFlags), self::dump($val, $flags));
  221. }
  222. return \sprintf('{ %s }', implode(', ', $output));
  223. }
  224. private static function dumpNull(int $flags, bool $rootLevel = false): string
  225. {
  226. if (Yaml::DUMP_NULL_AS_TILDE & $flags) {
  227. return '~';
  228. }
  229. if (Yaml::DUMP_NULL_AS_EMPTY & $flags && !$rootLevel) {
  230. return '';
  231. }
  232. return 'null';
  233. }
  234. /**
  235. * Parses a YAML scalar.
  236. *
  237. * @throws ParseException When malformed inline YAML string is parsed
  238. */
  239. public static function parseScalar(string $scalar, int $flags = 0, ?array $delimiters = null, int &$i = 0, bool $evaluate = true, array &$references = [], ?bool &$isQuoted = null): mixed
  240. {
  241. if (\in_array($scalar[$i], ['"', "'"], true)) {
  242. // quoted scalar
  243. $isQuoted = true;
  244. $output = self::parseQuotedScalar($scalar, $i);
  245. if (null !== $delimiters) {
  246. $tmp = ltrim(substr($scalar, $i), " \n");
  247. if ('' === $tmp) {
  248. throw new ParseException(\sprintf('Unexpected end of line, expected one of "%s".', implode('', $delimiters)), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  249. }
  250. if (!\in_array($tmp[0], $delimiters)) {
  251. throw new ParseException(\sprintf('Unexpected characters (%s).', substr($scalar, $i)), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  252. }
  253. }
  254. } else {
  255. // "normal" string
  256. $isQuoted = false;
  257. if (!$delimiters) {
  258. $output = substr($scalar, $i);
  259. $i += \strlen($output);
  260. // remove comments
  261. if (Parser::preg_match('/[ \t]+#/', $output, $match, \PREG_OFFSET_CAPTURE)) {
  262. $output = substr($output, 0, $match[0][1]);
  263. }
  264. } elseif (Parser::preg_match('/^(.*?)('.implode('|', $delimiters).')/', substr($scalar, $i), $match)) {
  265. $output = $match[1];
  266. $i += \strlen($output);
  267. $output = trim($output);
  268. } else {
  269. throw new ParseException(\sprintf('Malformed inline YAML string: "%s".', $scalar), self::$parsedLineNumber + 1, null, self::$parsedFilename);
  270. }
  271. // a non-quoted string cannot start with @ or ` (reserved) nor with a scalar indicator (| or >)
  272. if ($output && ('@' === $output[0] || '`' === $output[0] || '|' === $output[0] || '>' === $output[0] || '%' === $output[0])) {
  273. throw new ParseException(\sprintf('The reserved indicator "%s" cannot start a plain scalar; you need to quote the scalar.', $output[0]), self::$parsedLineNumber + 1, $output, self::$parsedFilename);
  274. }
  275. if ($evaluate) {
  276. $output = self::evaluateScalar($output, $flags, $references, $isQuoted);
  277. }
  278. }
  279. return $output;
  280. }
  281. /**
  282. * Parses a YAML quoted scalar.
  283. *
  284. * @throws ParseException When malformed inline YAML string is parsed
  285. */
  286. private static function parseQuotedScalar(string $scalar, int &$i = 0): string
  287. {
  288. if (!Parser::preg_match('/'.self::REGEX_QUOTED_STRING.'/Au', substr($scalar, $i), $match)) {
  289. throw new ParseException(\sprintf('Malformed inline YAML string: "%s".', substr($scalar, $i)), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  290. }
  291. $output = substr($match[0], 1, -1);
  292. $unescaper = new Unescaper();
  293. if ('"' == $scalar[$i]) {
  294. $output = $unescaper->unescapeDoubleQuotedString($output);
  295. } else {
  296. $output = $unescaper->unescapeSingleQuotedString($output);
  297. }
  298. $i += \strlen($match[0]);
  299. return $output;
  300. }
  301. /**
  302. * Parses a YAML sequence.
  303. *
  304. * @throws ParseException When malformed inline YAML string is parsed
  305. */
  306. private static function parseSequence(string $sequence, int $flags, int &$i = 0, array &$references = []): array
  307. {
  308. $output = [];
  309. $len = \strlen($sequence);
  310. ++$i;
  311. // [foo, bar, ...]
  312. $lastToken = null;
  313. while ($i < $len) {
  314. if (']' === $sequence[$i]) {
  315. return $output;
  316. }
  317. if (',' === $sequence[$i] || ' ' === $sequence[$i]) {
  318. if (',' === $sequence[$i] && (null === $lastToken || 'separator' === $lastToken)) {
  319. $output[] = null;
  320. } elseif (',' === $sequence[$i]) {
  321. $lastToken = 'separator';
  322. }
  323. ++$i;
  324. continue;
  325. }
  326. $tag = self::parseTag($sequence, $i, $flags);
  327. switch ($sequence[$i]) {
  328. case '[':
  329. // nested sequence
  330. $value = self::parseSequence($sequence, $flags, $i, $references);
  331. break;
  332. case '{':
  333. // nested mapping
  334. $value = self::parseMapping($sequence, $flags, $i, $references);
  335. break;
  336. default:
  337. $value = self::parseScalar($sequence, $flags, [',', ']'], $i, null === $tag, $references, $isQuoted);
  338. // the value can be an array if a reference has been resolved to an array var
  339. if (\is_string($value) && !$isQuoted && str_contains($value, ': ')) {
  340. // embedded mapping?
  341. try {
  342. $pos = 0;
  343. $value = self::parseMapping('{'.$value.'}', $flags, $pos, $references);
  344. } catch (\InvalidArgumentException) {
  345. // no, it's not
  346. }
  347. }
  348. if (!$isQuoted && \is_string($value) && '' !== $value && '&' === $value[0] && Parser::preg_match(Parser::REFERENCE_PATTERN, $value, $matches)) {
  349. $references[$matches['ref']] = $matches['value'];
  350. $value = $matches['value'];
  351. }
  352. --$i;
  353. }
  354. if (null !== $tag && '' !== $tag) {
  355. $value = new TaggedValue($tag, $value);
  356. }
  357. $output[] = $value;
  358. $lastToken = 'value';
  359. ++$i;
  360. }
  361. throw new ParseException(\sprintf('Malformed inline YAML string: "%s".', $sequence), self::$parsedLineNumber + 1, null, self::$parsedFilename);
  362. }
  363. /**
  364. * Parses a YAML mapping.
  365. *
  366. * @throws ParseException When malformed inline YAML string is parsed
  367. */
  368. private static function parseMapping(string $mapping, int $flags, int &$i = 0, array &$references = []): array|\stdClass
  369. {
  370. $output = [];
  371. $len = \strlen($mapping);
  372. ++$i;
  373. $allowOverwrite = false;
  374. // {foo: bar, bar:foo, ...}
  375. while ($i < $len) {
  376. switch ($mapping[$i]) {
  377. case ' ':
  378. case ',':
  379. case "\n":
  380. ++$i;
  381. continue 2;
  382. case '}':
  383. if (self::$objectForMap) {
  384. return (object) $output;
  385. }
  386. return $output;
  387. }
  388. // key
  389. $offsetBeforeKeyParsing = $i;
  390. $isKeyQuoted = \in_array($mapping[$i], ['"', "'"], true);
  391. $key = self::parseScalar($mapping, $flags, [':', ' '], $i, false);
  392. if ($offsetBeforeKeyParsing === $i) {
  393. throw new ParseException('Missing mapping key.', self::$parsedLineNumber + 1, $mapping);
  394. }
  395. if ('!php/const' === $key || '!php/enum' === $key) {
  396. $key .= ' '.self::parseScalar($mapping, $flags, [':'], $i, false);
  397. $key = self::evaluateScalar($key, $flags);
  398. }
  399. if (false === $i = strpos($mapping, ':', $i)) {
  400. break;
  401. }
  402. if (!$isKeyQuoted) {
  403. $evaluatedKey = self::evaluateScalar($key, $flags, $references);
  404. if ('' !== $key && $evaluatedKey !== $key && !\is_string($evaluatedKey) && !\is_int($evaluatedKey)) {
  405. throw new ParseException('Implicit casting of incompatible mapping keys to strings is not supported. Quote your evaluable mapping keys instead.', self::$parsedLineNumber + 1, $mapping);
  406. }
  407. }
  408. if (!$isKeyQuoted && (!isset($mapping[$i + 1]) || !\in_array($mapping[$i + 1], [' ', ',', '[', ']', '{', '}', "\n"], true))) {
  409. throw new ParseException('Colons must be followed by a space or an indication character (i.e. " ", ",", "[", "]", "{", "}").', self::$parsedLineNumber + 1, $mapping);
  410. }
  411. if ('<<' === $key) {
  412. $allowOverwrite = true;
  413. }
  414. while ($i < $len) {
  415. if (':' === $mapping[$i] || ' ' === $mapping[$i] || "\n" === $mapping[$i]) {
  416. ++$i;
  417. continue;
  418. }
  419. $tag = self::parseTag($mapping, $i, $flags);
  420. switch ($mapping[$i]) {
  421. case '[':
  422. // nested sequence
  423. $value = self::parseSequence($mapping, $flags, $i, $references);
  424. // Spec: Keys MUST be unique; first one wins.
  425. // Parser cannot abort this mapping earlier, since lines
  426. // are processed sequentially.
  427. // But overwriting is allowed when a merge node is used in current block.
  428. if ('<<' === $key) {
  429. foreach ($value as $parsedValue) {
  430. $output += $parsedValue;
  431. }
  432. } elseif ($allowOverwrite || !isset($output[$key])) {
  433. if (null !== $tag) {
  434. $output[$key] = new TaggedValue($tag, $value);
  435. } else {
  436. $output[$key] = $value;
  437. }
  438. } elseif (isset($output[$key])) {
  439. throw new ParseException(\sprintf('Duplicate key "%s" detected.', $key), self::$parsedLineNumber + 1, $mapping);
  440. }
  441. break;
  442. case '{':
  443. // nested mapping
  444. $value = self::parseMapping($mapping, $flags, $i, $references);
  445. // Spec: Keys MUST be unique; first one wins.
  446. // Parser cannot abort this mapping earlier, since lines
  447. // are processed sequentially.
  448. // But overwriting is allowed when a merge node is used in current block.
  449. if ('<<' === $key) {
  450. $output += $value;
  451. } elseif ($allowOverwrite || !isset($output[$key])) {
  452. if (null !== $tag) {
  453. $output[$key] = new TaggedValue($tag, $value);
  454. } else {
  455. $output[$key] = $value;
  456. }
  457. } elseif (isset($output[$key])) {
  458. throw new ParseException(\sprintf('Duplicate key "%s" detected.', $key), self::$parsedLineNumber + 1, $mapping);
  459. }
  460. break;
  461. default:
  462. $value = self::parseScalar($mapping, $flags, [',', '}', "\n"], $i, null === $tag, $references, $isValueQuoted);
  463. // Spec: Keys MUST be unique; first one wins.
  464. // Parser cannot abort this mapping earlier, since lines
  465. // are processed sequentially.
  466. // But overwriting is allowed when a merge node is used in current block.
  467. if ('<<' === $key) {
  468. $output += $value;
  469. } elseif ($allowOverwrite || !isset($output[$key])) {
  470. if (!$isValueQuoted && \is_string($value) && '' !== $value && '&' === $value[0] && !self::isBinaryString($value) && Parser::preg_match(Parser::REFERENCE_PATTERN, $value, $matches)) {
  471. $references[$matches['ref']] = $matches['value'];
  472. $value = $matches['value'];
  473. }
  474. if (null !== $tag) {
  475. $output[$key] = new TaggedValue($tag, $value);
  476. } else {
  477. $output[$key] = $value;
  478. }
  479. } elseif (isset($output[$key])) {
  480. throw new ParseException(\sprintf('Duplicate key "%s" detected.', $key), self::$parsedLineNumber + 1, $mapping);
  481. }
  482. --$i;
  483. }
  484. ++$i;
  485. continue 2;
  486. }
  487. }
  488. throw new ParseException(\sprintf('Malformed inline YAML string: "%s".', $mapping), self::$parsedLineNumber + 1, null, self::$parsedFilename);
  489. }
  490. /**
  491. * Evaluates scalars and replaces magic values.
  492. *
  493. * @throws ParseException when object parsing support was disabled and the parser detected a PHP object or when a reference could not be resolved
  494. */
  495. private static function evaluateScalar(string $scalar, int $flags, array &$references = [], ?bool &$isQuotedString = null): mixed
  496. {
  497. $isQuotedString = false;
  498. $scalar = trim($scalar);
  499. if (str_starts_with($scalar, '*')) {
  500. if (false !== $pos = strpos($scalar, '#')) {
  501. $value = substr($scalar, 1, $pos - 2);
  502. } else {
  503. $value = substr($scalar, 1);
  504. }
  505. // an unquoted *
  506. if ('' === $value) {
  507. throw new ParseException('A reference must contain at least one character.', self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  508. }
  509. if (!\array_key_exists($value, $references)) {
  510. throw new ParseException(\sprintf('Reference "%s" does not exist.', $value), self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  511. }
  512. return $references[$value];
  513. }
  514. $scalarLower = strtolower($scalar);
  515. switch (true) {
  516. case 'null' === $scalarLower:
  517. case '' === $scalar:
  518. case '~' === $scalar:
  519. return null;
  520. case 'true' === $scalarLower:
  521. return true;
  522. case 'false' === $scalarLower:
  523. return false;
  524. case '!' === $scalar[0]:
  525. switch (true) {
  526. case str_starts_with($scalar, '!!str '):
  527. $s = substr($scalar, 6);
  528. if (\in_array($s[0] ?? '', ['"', "'"], true)) {
  529. $isQuotedString = true;
  530. $s = self::parseQuotedScalar($s);
  531. }
  532. return $s;
  533. case str_starts_with($scalar, '! '):
  534. return substr($scalar, 2);
  535. case str_starts_with($scalar, '!php/object'):
  536. if (self::$objectSupport) {
  537. if (!isset($scalar[12])) {
  538. throw new ParseException('Missing value for tag "!php/object".', self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  539. }
  540. return unserialize(self::parseScalar(substr($scalar, 12)));
  541. }
  542. if (self::$exceptionOnInvalidType) {
  543. throw new ParseException('Object support when parsing a YAML file has been disabled.', self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  544. }
  545. return null;
  546. case str_starts_with($scalar, '!php/const'):
  547. if (self::$constantSupport) {
  548. if (!isset($scalar[11])) {
  549. throw new ParseException('Missing value for tag "!php/const".', self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  550. }
  551. $i = 0;
  552. if (\defined($const = self::parseScalar(substr($scalar, 11), 0, null, $i, false))) {
  553. return \constant($const);
  554. }
  555. throw new ParseException(\sprintf('The constant "%s" is not defined.', $const), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  556. }
  557. if (self::$exceptionOnInvalidType) {
  558. throw new ParseException(\sprintf('The string "%s" could not be parsed as a constant. Did you forget to pass the "Yaml::PARSE_CONSTANT" flag to the parser?', $scalar), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  559. }
  560. return null;
  561. case str_starts_with($scalar, '!php/enum'):
  562. if (self::$constantSupport) {
  563. if (!isset($scalar[11])) {
  564. throw new ParseException('Missing value for tag "!php/enum".', self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  565. }
  566. $i = 0;
  567. $enumName = self::parseScalar(substr($scalar, 10), 0, null, $i, false);
  568. $useName = str_contains($enumName, '::');
  569. $enum = $useName ? strstr($enumName, '::', true) : $enumName;
  570. if (!enum_exists($enum)) {
  571. throw new ParseException(\sprintf('The enum "%s" is not defined.', $enum), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  572. }
  573. if (!$useName) {
  574. return $enum::cases();
  575. }
  576. if ($useValue = str_ends_with($enumName, '->value')) {
  577. $enumName = substr($enumName, 0, -7);
  578. }
  579. if (!\defined($enumName)) {
  580. throw new ParseException(\sprintf('The string "%s" is not the name of a valid enum.', $enumName), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  581. }
  582. $value = \constant($enumName);
  583. if (!$useValue) {
  584. return $value;
  585. }
  586. if (!$value instanceof \BackedEnum) {
  587. throw new ParseException(\sprintf('The enum "%s" defines no value next to its name.', $enumName), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  588. }
  589. return $value->value;
  590. }
  591. if (self::$exceptionOnInvalidType) {
  592. throw new ParseException(\sprintf('The string "%s" could not be parsed as an enum. Did you forget to pass the "Yaml::PARSE_CONSTANT" flag to the parser?', $scalar), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  593. }
  594. return null;
  595. case str_starts_with($scalar, '!!float '):
  596. return (float) substr($scalar, 8);
  597. case str_starts_with($scalar, '!!binary '):
  598. return self::evaluateBinaryScalar(substr($scalar, 9));
  599. }
  600. throw new ParseException(\sprintf('The string "%s" could not be parsed as it uses an unsupported built-in tag.', $scalar), self::$parsedLineNumber, $scalar, self::$parsedFilename);
  601. case preg_match('/^(?:\+|-)?0o(?P<value>[0-7_]++)$/', $scalar, $matches):
  602. $value = str_replace('_', '', $matches['value']);
  603. if ('-' === $scalar[0]) {
  604. return -octdec($value);
  605. }
  606. return octdec($value);
  607. case \in_array($scalar[0], ['+', '-', '.'], true) || is_numeric($scalar[0]):
  608. if (Parser::preg_match('{^[+-]?[0-9][0-9_]*$}', $scalar)) {
  609. $scalar = str_replace('_', '', $scalar);
  610. }
  611. switch (true) {
  612. case ctype_digit($scalar):
  613. case '-' === $scalar[0] && ctype_digit(substr($scalar, 1)):
  614. $cast = (int) $scalar;
  615. return ($scalar === (string) $cast) ? $cast : $scalar;
  616. case is_numeric($scalar):
  617. case Parser::preg_match(self::getHexRegex(), $scalar):
  618. $scalar = str_replace('_', '', $scalar);
  619. return '0x' === $scalar[0].$scalar[1] ? hexdec($scalar) : (float) $scalar;
  620. case '.inf' === $scalarLower:
  621. case '.nan' === $scalarLower:
  622. return -log(0);
  623. case '-.inf' === $scalarLower:
  624. return log(0);
  625. case Parser::preg_match('/^(-|\+)?[0-9][0-9_]*(\.[0-9_]+)?$/', $scalar):
  626. return (float) str_replace('_', '', $scalar);
  627. case Parser::preg_match(self::getTimestampRegex(), $scalar):
  628. try {
  629. // When no timezone is provided in the parsed date, YAML spec says we must assume UTC.
  630. $time = new \DateTimeImmutable($scalar, new \DateTimeZone('UTC'));
  631. } catch (\Exception $e) {
  632. // Some dates accepted by the regex are not valid dates.
  633. throw new ParseException(\sprintf('The date "%s" could not be parsed as it is an invalid date.', $scalar), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename, $e);
  634. }
  635. if (Yaml::PARSE_DATETIME & $flags) {
  636. return $time;
  637. }
  638. if ('' !== rtrim($time->format('u'), '0')) {
  639. return (float) $time->format('U.u');
  640. }
  641. try {
  642. if (false !== $scalar = $time->getTimestamp()) {
  643. return $scalar;
  644. }
  645. } catch (\DateRangeError|\ValueError) {
  646. // no-op
  647. }
  648. return $time->format('U');
  649. }
  650. }
  651. return (string) $scalar;
  652. }
  653. private static function parseTag(string $value, int &$i, int $flags): ?string
  654. {
  655. if ('!' !== $value[$i]) {
  656. return null;
  657. }
  658. $tagLength = strcspn($value, " \t\n[]{},", $i + 1);
  659. $tag = substr($value, $i + 1, $tagLength);
  660. $nextOffset = $i + $tagLength + 1;
  661. $nextOffset += strspn($value, ' ', $nextOffset);
  662. if ('' === $tag && (!isset($value[$nextOffset]) || \in_array($value[$nextOffset], [']', '}', ','], true))) {
  663. throw new ParseException('Using the unquoted scalar value "!" is not supported. You must quote it.', self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  664. }
  665. // Is followed by a scalar and is a built-in tag
  666. if ('' !== $tag && (!isset($value[$nextOffset]) || !\in_array($value[$nextOffset], ['[', '{'], true)) && ('!' === $tag[0] || \in_array($tag, ['str', 'php/const', 'php/enum', 'php/object'], true))) {
  667. // Manage in {@link self::evaluateScalar()}
  668. return null;
  669. }
  670. $i = $nextOffset;
  671. // Built-in tags
  672. if ('' !== $tag && '!' === $tag[0]) {
  673. throw new ParseException(\sprintf('The built-in tag "!%s" is not implemented.', $tag), self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  674. }
  675. if ('' !== $tag && !isset($value[$i])) {
  676. throw new ParseException(\sprintf('Missing value for tag "%s".', $tag), self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  677. }
  678. if ('' === $tag || Yaml::PARSE_CUSTOM_TAGS & $flags) {
  679. return $tag;
  680. }
  681. throw new ParseException(\sprintf('Tags support is not enabled. Enable the "Yaml::PARSE_CUSTOM_TAGS" flag to use "!%s".', $tag), self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  682. }
  683. public static function evaluateBinaryScalar(string $scalar): string
  684. {
  685. $parsedBinaryData = self::parseScalar(preg_replace('/\s/', '', $scalar));
  686. if (0 !== (\strlen($parsedBinaryData) % 4)) {
  687. throw new ParseException(\sprintf('The normalized base64 encoded data (data without whitespace characters) length must be a multiple of four (%d bytes given).', \strlen($parsedBinaryData)), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  688. }
  689. if (!Parser::preg_match('#^[A-Z0-9+/]+={0,2}$#i', $parsedBinaryData)) {
  690. throw new ParseException(\sprintf('The base64 encoded data (%s) contains invalid characters.', $parsedBinaryData), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  691. }
  692. return base64_decode($parsedBinaryData, true);
  693. }
  694. private static function isBinaryString(string $value): bool
  695. {
  696. return !preg_match('//u', $value) || preg_match('/[^\x00\x07-\x0d\x1B\x20-\xff]/', $value);
  697. }
  698. /**
  699. * Gets a regex that matches a YAML date.
  700. *
  701. * @see http://www.yaml.org/spec/1.2/spec.html#id2761573
  702. */
  703. private static function getTimestampRegex(): string
  704. {
  705. return <<<EOF
  706. ~^
  707. (?P<year>[0-9][0-9][0-9][0-9])
  708. -(?P<month>[0-9][0-9]?)
  709. -(?P<day>[0-9][0-9]?)
  710. (?:(?:[Tt]|[ \t]+)
  711. (?P<hour>[0-9][0-9]?)
  712. :(?P<minute>[0-9][0-9])
  713. :(?P<second>[0-9][0-9])
  714. (?:\.(?P<fraction>[0-9]*))?
  715. (?:[ \t]*(?P<tz>Z|(?P<tz_sign>[-+])(?P<tz_hour>[0-9][0-9]?)
  716. (?::(?P<tz_minute>[0-9][0-9]))?))?)?
  717. $~x
  718. EOF;
  719. }
  720. /**
  721. * Gets a regex that matches a YAML number in hexadecimal notation.
  722. */
  723. private static function getHexRegex(): string
  724. {
  725. return '~^0x[0-9a-f_]++$~i';
  726. }
  727. }