Inline.php 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828
  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 = null, 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): 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/const %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);
  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 = $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. return Escaper::escapeWithDoubleQuotes($value);
  155. case Escaper::requiresSingleQuoting($value):
  156. $singleQuoted = Escaper::escapeWithSingleQuotes($value);
  157. if (!str_contains($value, "'")) {
  158. return $singleQuoted;
  159. }
  160. // Attempt double-quoting the string instead to see if it's more efficient.
  161. $doubleQuoted = Escaper::escapeWithDoubleQuotes($value);
  162. return \strlen($doubleQuoted) < \strlen($singleQuoted) ? $doubleQuoted : $singleQuoted;
  163. case Parser::preg_match('{^[0-9]+[_0-9]*$}', $value):
  164. case Parser::preg_match(self::getHexRegex(), $value):
  165. case Parser::preg_match(self::getTimestampRegex(), $value):
  166. return Escaper::escapeWithSingleQuotes($value);
  167. default:
  168. return $value;
  169. }
  170. }
  171. /**
  172. * Check if given array is hash or just normal indexed array.
  173. */
  174. public static function isHash(array|\ArrayObject|\stdClass $value): bool
  175. {
  176. if ($value instanceof \stdClass || $value instanceof \ArrayObject) {
  177. return true;
  178. }
  179. $expectedKey = 0;
  180. foreach ($value as $key => $val) {
  181. if ($key !== $expectedKey++) {
  182. return true;
  183. }
  184. }
  185. return false;
  186. }
  187. /**
  188. * Dumps a PHP array to a YAML string.
  189. *
  190. * @param array $value The PHP array to dump
  191. * @param int $flags A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
  192. */
  193. private static function dumpArray(array $value, int $flags): string
  194. {
  195. // array
  196. if (($value || Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE & $flags) && !self::isHash($value)) {
  197. $output = [];
  198. foreach ($value as $val) {
  199. $output[] = self::dump($val, $flags);
  200. }
  201. return sprintf('[%s]', implode(', ', $output));
  202. }
  203. return self::dumpHashArray($value, $flags);
  204. }
  205. /**
  206. * Dumps hash array to a YAML string.
  207. *
  208. * @param array|\ArrayObject|\stdClass $value The hash array to dump
  209. * @param int $flags A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
  210. */
  211. private static function dumpHashArray(array|\ArrayObject|\stdClass $value, int $flags): string
  212. {
  213. $output = [];
  214. foreach ($value as $key => $val) {
  215. if (\is_int($key) && Yaml::DUMP_NUMERIC_KEY_AS_STRING & $flags) {
  216. $key = (string) $key;
  217. }
  218. $output[] = sprintf('%s: %s', self::dump($key, $flags), self::dump($val, $flags));
  219. }
  220. return sprintf('{ %s }', implode(', ', $output));
  221. }
  222. private static function dumpNull(int $flags): string
  223. {
  224. if (Yaml::DUMP_NULL_AS_TILDE & $flags) {
  225. return '~';
  226. }
  227. return 'null';
  228. }
  229. /**
  230. * Parses a YAML scalar.
  231. *
  232. * @throws ParseException When malformed inline YAML string is parsed
  233. */
  234. public static function parseScalar(string $scalar, int $flags = 0, array $delimiters = null, int &$i = 0, bool $evaluate = true, array &$references = [], bool &$isQuoted = null): mixed
  235. {
  236. if (\in_array($scalar[$i], ['"', "'"], true)) {
  237. // quoted scalar
  238. $isQuoted = true;
  239. $output = self::parseQuotedScalar($scalar, $i);
  240. if (null !== $delimiters) {
  241. $tmp = ltrim(substr($scalar, $i), " \n");
  242. if ('' === $tmp) {
  243. throw new ParseException(sprintf('Unexpected end of line, expected one of "%s".', implode('', $delimiters)), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  244. }
  245. if (!\in_array($tmp[0], $delimiters)) {
  246. throw new ParseException(sprintf('Unexpected characters (%s).', substr($scalar, $i)), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  247. }
  248. }
  249. } else {
  250. // "normal" string
  251. $isQuoted = false;
  252. if (!$delimiters) {
  253. $output = substr($scalar, $i);
  254. $i += \strlen($output);
  255. // remove comments
  256. if (Parser::preg_match('/[ \t]+#/', $output, $match, \PREG_OFFSET_CAPTURE)) {
  257. $output = substr($output, 0, $match[0][1]);
  258. }
  259. } elseif (Parser::preg_match('/^(.*?)('.implode('|', $delimiters).')/', substr($scalar, $i), $match)) {
  260. $output = $match[1];
  261. $i += \strlen($output);
  262. $output = trim($output);
  263. } else {
  264. throw new ParseException(sprintf('Malformed inline YAML string: "%s".', $scalar), self::$parsedLineNumber + 1, null, self::$parsedFilename);
  265. }
  266. // a non-quoted string cannot start with @ or ` (reserved) nor with a scalar indicator (| or >)
  267. if ($output && ('@' === $output[0] || '`' === $output[0] || '|' === $output[0] || '>' === $output[0] || '%' === $output[0])) {
  268. 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);
  269. }
  270. if ($evaluate) {
  271. $output = self::evaluateScalar($output, $flags, $references, $isQuoted);
  272. }
  273. }
  274. return $output;
  275. }
  276. /**
  277. * Parses a YAML quoted scalar.
  278. *
  279. * @throws ParseException When malformed inline YAML string is parsed
  280. */
  281. private static function parseQuotedScalar(string $scalar, int &$i = 0): string
  282. {
  283. if (!Parser::preg_match('/'.self::REGEX_QUOTED_STRING.'/Au', substr($scalar, $i), $match)) {
  284. throw new ParseException(sprintf('Malformed inline YAML string: "%s".', substr($scalar, $i)), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  285. }
  286. $output = substr($match[0], 1, -1);
  287. $unescaper = new Unescaper();
  288. if ('"' == $scalar[$i]) {
  289. $output = $unescaper->unescapeDoubleQuotedString($output);
  290. } else {
  291. $output = $unescaper->unescapeSingleQuotedString($output);
  292. }
  293. $i += \strlen($match[0]);
  294. return $output;
  295. }
  296. /**
  297. * Parses a YAML sequence.
  298. *
  299. * @throws ParseException When malformed inline YAML string is parsed
  300. */
  301. private static function parseSequence(string $sequence, int $flags, int &$i = 0, array &$references = []): array
  302. {
  303. $output = [];
  304. $len = \strlen($sequence);
  305. ++$i;
  306. // [foo, bar, ...]
  307. while ($i < $len) {
  308. if (']' === $sequence[$i]) {
  309. return $output;
  310. }
  311. if (',' === $sequence[$i] || ' ' === $sequence[$i]) {
  312. ++$i;
  313. continue;
  314. }
  315. $tag = self::parseTag($sequence, $i, $flags);
  316. switch ($sequence[$i]) {
  317. case '[':
  318. // nested sequence
  319. $value = self::parseSequence($sequence, $flags, $i, $references);
  320. break;
  321. case '{':
  322. // nested mapping
  323. $value = self::parseMapping($sequence, $flags, $i, $references);
  324. break;
  325. default:
  326. $value = self::parseScalar($sequence, $flags, [',', ']'], $i, null === $tag, $references, $isQuoted);
  327. // the value can be an array if a reference has been resolved to an array var
  328. if (\is_string($value) && !$isQuoted && str_contains($value, ': ')) {
  329. // embedded mapping?
  330. try {
  331. $pos = 0;
  332. $value = self::parseMapping('{'.$value.'}', $flags, $pos, $references);
  333. } catch (\InvalidArgumentException) {
  334. // no, it's not
  335. }
  336. }
  337. if (!$isQuoted && \is_string($value) && '' !== $value && '&' === $value[0] && Parser::preg_match(Parser::REFERENCE_PATTERN, $value, $matches)) {
  338. $references[$matches['ref']] = $matches['value'];
  339. $value = $matches['value'];
  340. }
  341. --$i;
  342. }
  343. if (null !== $tag && '' !== $tag) {
  344. $value = new TaggedValue($tag, $value);
  345. }
  346. $output[] = $value;
  347. ++$i;
  348. }
  349. throw new ParseException(sprintf('Malformed inline YAML string: "%s".', $sequence), self::$parsedLineNumber + 1, null, self::$parsedFilename);
  350. }
  351. /**
  352. * Parses a YAML mapping.
  353. *
  354. * @throws ParseException When malformed inline YAML string is parsed
  355. */
  356. private static function parseMapping(string $mapping, int $flags, int &$i = 0, array &$references = []): array|\stdClass
  357. {
  358. $output = [];
  359. $len = \strlen($mapping);
  360. ++$i;
  361. $allowOverwrite = false;
  362. // {foo: bar, bar:foo, ...}
  363. while ($i < $len) {
  364. switch ($mapping[$i]) {
  365. case ' ':
  366. case ',':
  367. case "\n":
  368. ++$i;
  369. continue 2;
  370. case '}':
  371. if (self::$objectForMap) {
  372. return (object) $output;
  373. }
  374. return $output;
  375. }
  376. // key
  377. $offsetBeforeKeyParsing = $i;
  378. $isKeyQuoted = \in_array($mapping[$i], ['"', "'"], true);
  379. $key = self::parseScalar($mapping, $flags, [':', ' '], $i, false);
  380. if ($offsetBeforeKeyParsing === $i) {
  381. throw new ParseException('Missing mapping key.', self::$parsedLineNumber + 1, $mapping);
  382. }
  383. if ('!php/const' === $key || '!php/enum' === $key) {
  384. $key .= ' '.self::parseScalar($mapping, $flags, [':'], $i, false);
  385. $key = self::evaluateScalar($key, $flags);
  386. }
  387. if (false === $i = strpos($mapping, ':', $i)) {
  388. break;
  389. }
  390. if (!$isKeyQuoted) {
  391. $evaluatedKey = self::evaluateScalar($key, $flags, $references);
  392. if ('' !== $key && $evaluatedKey !== $key && !\is_string($evaluatedKey) && !\is_int($evaluatedKey)) {
  393. throw new ParseException('Implicit casting of incompatible mapping keys to strings is not supported. Quote your evaluable mapping keys instead.', self::$parsedLineNumber + 1, $mapping);
  394. }
  395. }
  396. if (!$isKeyQuoted && (!isset($mapping[$i + 1]) || !\in_array($mapping[$i + 1], [' ', ',', '[', ']', '{', '}', "\n"], true))) {
  397. throw new ParseException('Colons must be followed by a space or an indication character (i.e. " ", ",", "[", "]", "{", "}").', self::$parsedLineNumber + 1, $mapping);
  398. }
  399. if ('<<' === $key) {
  400. $allowOverwrite = true;
  401. }
  402. while ($i < $len) {
  403. if (':' === $mapping[$i] || ' ' === $mapping[$i] || "\n" === $mapping[$i]) {
  404. ++$i;
  405. continue;
  406. }
  407. $tag = self::parseTag($mapping, $i, $flags);
  408. switch ($mapping[$i]) {
  409. case '[':
  410. // nested sequence
  411. $value = self::parseSequence($mapping, $flags, $i, $references);
  412. // Spec: Keys MUST be unique; first one wins.
  413. // Parser cannot abort this mapping earlier, since lines
  414. // are processed sequentially.
  415. // But overwriting is allowed when a merge node is used in current block.
  416. if ('<<' === $key) {
  417. foreach ($value as $parsedValue) {
  418. $output += $parsedValue;
  419. }
  420. } elseif ($allowOverwrite || !isset($output[$key])) {
  421. if (null !== $tag) {
  422. $output[$key] = new TaggedValue($tag, $value);
  423. } else {
  424. $output[$key] = $value;
  425. }
  426. } elseif (isset($output[$key])) {
  427. throw new ParseException(sprintf('Duplicate key "%s" detected.', $key), self::$parsedLineNumber + 1, $mapping);
  428. }
  429. break;
  430. case '{':
  431. // nested mapping
  432. $value = self::parseMapping($mapping, $flags, $i, $references);
  433. // Spec: Keys MUST be unique; first one wins.
  434. // Parser cannot abort this mapping earlier, since lines
  435. // are processed sequentially.
  436. // But overwriting is allowed when a merge node is used in current block.
  437. if ('<<' === $key) {
  438. $output += $value;
  439. } elseif ($allowOverwrite || !isset($output[$key])) {
  440. if (null !== $tag) {
  441. $output[$key] = new TaggedValue($tag, $value);
  442. } else {
  443. $output[$key] = $value;
  444. }
  445. } elseif (isset($output[$key])) {
  446. throw new ParseException(sprintf('Duplicate key "%s" detected.', $key), self::$parsedLineNumber + 1, $mapping);
  447. }
  448. break;
  449. default:
  450. $value = self::parseScalar($mapping, $flags, [',', '}', "\n"], $i, null === $tag, $references, $isValueQuoted);
  451. // Spec: Keys MUST be unique; first one wins.
  452. // Parser cannot abort this mapping earlier, since lines
  453. // are processed sequentially.
  454. // But overwriting is allowed when a merge node is used in current block.
  455. if ('<<' === $key) {
  456. $output += $value;
  457. } elseif ($allowOverwrite || !isset($output[$key])) {
  458. if (!$isValueQuoted && \is_string($value) && '' !== $value && '&' === $value[0] && Parser::preg_match(Parser::REFERENCE_PATTERN, $value, $matches)) {
  459. $references[$matches['ref']] = $matches['value'];
  460. $value = $matches['value'];
  461. }
  462. if (null !== $tag) {
  463. $output[$key] = new TaggedValue($tag, $value);
  464. } else {
  465. $output[$key] = $value;
  466. }
  467. } elseif (isset($output[$key])) {
  468. throw new ParseException(sprintf('Duplicate key "%s" detected.', $key), self::$parsedLineNumber + 1, $mapping);
  469. }
  470. --$i;
  471. }
  472. ++$i;
  473. continue 2;
  474. }
  475. }
  476. throw new ParseException(sprintf('Malformed inline YAML string: "%s".', $mapping), self::$parsedLineNumber + 1, null, self::$parsedFilename);
  477. }
  478. /**
  479. * Evaluates scalars and replaces magic values.
  480. *
  481. * @throws ParseException when object parsing support was disabled and the parser detected a PHP object or when a reference could not be resolved
  482. */
  483. private static function evaluateScalar(string $scalar, int $flags, array &$references = [], bool &$isQuotedString = null): mixed
  484. {
  485. $isQuotedString = false;
  486. $scalar = trim($scalar);
  487. if (str_starts_with($scalar, '*')) {
  488. if (false !== $pos = strpos($scalar, '#')) {
  489. $value = substr($scalar, 1, $pos - 2);
  490. } else {
  491. $value = substr($scalar, 1);
  492. }
  493. // an unquoted *
  494. if (false === $value || '' === $value) {
  495. throw new ParseException('A reference must contain at least one character.', self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  496. }
  497. if (!\array_key_exists($value, $references)) {
  498. throw new ParseException(sprintf('Reference "%s" does not exist.', $value), self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  499. }
  500. return $references[$value];
  501. }
  502. $scalarLower = strtolower($scalar);
  503. switch (true) {
  504. case 'null' === $scalarLower:
  505. case '' === $scalar:
  506. case '~' === $scalar:
  507. return null;
  508. case 'true' === $scalarLower:
  509. return true;
  510. case 'false' === $scalarLower:
  511. return false;
  512. case '!' === $scalar[0]:
  513. switch (true) {
  514. case str_starts_with($scalar, '!!str '):
  515. $s = (string) substr($scalar, 6);
  516. if (\in_array($s[0] ?? '', ['"', "'"], true)) {
  517. $isQuotedString = true;
  518. $s = self::parseQuotedScalar($s);
  519. }
  520. return $s;
  521. case str_starts_with($scalar, '! '):
  522. return substr($scalar, 2);
  523. case str_starts_with($scalar, '!php/object'):
  524. if (self::$objectSupport) {
  525. if (!isset($scalar[12])) {
  526. throw new ParseException('Missing value for tag "!php/object".', self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  527. }
  528. return unserialize(self::parseScalar(substr($scalar, 12)));
  529. }
  530. if (self::$exceptionOnInvalidType) {
  531. throw new ParseException('Object support when parsing a YAML file has been disabled.', self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  532. }
  533. return null;
  534. case str_starts_with($scalar, '!php/const'):
  535. if (self::$constantSupport) {
  536. if (!isset($scalar[11])) {
  537. throw new ParseException('Missing value for tag "!php/const".', self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  538. }
  539. $i = 0;
  540. if (\defined($const = self::parseScalar(substr($scalar, 11), 0, null, $i, false))) {
  541. return \constant($const);
  542. }
  543. throw new ParseException(sprintf('The constant "%s" is not defined.', $const), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  544. }
  545. if (self::$exceptionOnInvalidType) {
  546. 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);
  547. }
  548. return null;
  549. case str_starts_with($scalar, '!php/enum'):
  550. if (self::$constantSupport) {
  551. if (!isset($scalar[11])) {
  552. throw new ParseException('Missing value for tag "!php/enum".', self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  553. }
  554. $i = 0;
  555. $enum = self::parseScalar(substr($scalar, 10), 0, null, $i, false);
  556. if ($useValue = str_ends_with($enum, '->value')) {
  557. $enum = substr($enum, 0, -7);
  558. }
  559. if (!\defined($enum)) {
  560. throw new ParseException(sprintf('The enum "%s" is not defined.', $enum), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  561. }
  562. $value = \constant($enum);
  563. if (!$value instanceof \UnitEnum) {
  564. throw new ParseException(sprintf('The string "%s" is not the name of a valid enum.', $enum), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  565. }
  566. if (!$useValue) {
  567. return $value;
  568. }
  569. if (!$value instanceof \BackedEnum) {
  570. throw new ParseException(sprintf('The enum "%s" defines no value next to its name.', $enum), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  571. }
  572. return $value->value;
  573. }
  574. if (self::$exceptionOnInvalidType) {
  575. 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);
  576. }
  577. return null;
  578. case str_starts_with($scalar, '!!float '):
  579. return (float) substr($scalar, 8);
  580. case str_starts_with($scalar, '!!binary '):
  581. return self::evaluateBinaryScalar(substr($scalar, 9));
  582. }
  583. 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);
  584. case preg_match('/^(?:\+|-)?0o(?P<value>[0-7_]++)$/', $scalar, $matches):
  585. $value = str_replace('_', '', $matches['value']);
  586. if ('-' === $scalar[0]) {
  587. return -octdec($value);
  588. }
  589. return octdec($value);
  590. case \in_array($scalar[0], ['+', '-', '.'], true) || is_numeric($scalar[0]):
  591. if (Parser::preg_match('{^[+-]?[0-9][0-9_]*$}', $scalar)) {
  592. $scalar = str_replace('_', '', $scalar);
  593. }
  594. switch (true) {
  595. case ctype_digit($scalar):
  596. case '-' === $scalar[0] && ctype_digit(substr($scalar, 1)):
  597. $cast = (int) $scalar;
  598. return ($scalar === (string) $cast) ? $cast : $scalar;
  599. case is_numeric($scalar):
  600. case Parser::preg_match(self::getHexRegex(), $scalar):
  601. $scalar = str_replace('_', '', $scalar);
  602. return '0x' === $scalar[0].$scalar[1] ? hexdec($scalar) : (float) $scalar;
  603. case '.inf' === $scalarLower:
  604. case '.nan' === $scalarLower:
  605. return -log(0);
  606. case '-.inf' === $scalarLower:
  607. return log(0);
  608. case Parser::preg_match('/^(-|\+)?[0-9][0-9_]*(\.[0-9_]+)?$/', $scalar):
  609. return (float) str_replace('_', '', $scalar);
  610. case Parser::preg_match(self::getTimestampRegex(), $scalar):
  611. // When no timezone is provided in the parsed date, YAML spec says we must assume UTC.
  612. $time = new \DateTimeImmutable($scalar, new \DateTimeZone('UTC'));
  613. if (Yaml::PARSE_DATETIME & $flags) {
  614. return $time;
  615. }
  616. if ('' !== rtrim($time->format('u'), '0')) {
  617. return (float) $time->format('U.u');
  618. }
  619. try {
  620. if (false !== $scalar = $time->getTimestamp()) {
  621. return $scalar;
  622. }
  623. } catch (\ValueError) {
  624. // no-op
  625. }
  626. return $time->format('U');
  627. }
  628. }
  629. return (string) $scalar;
  630. }
  631. private static function parseTag(string $value, int &$i, int $flags): ?string
  632. {
  633. if ('!' !== $value[$i]) {
  634. return null;
  635. }
  636. $tagLength = strcspn($value, " \t\n[]{},", $i + 1);
  637. $tag = substr($value, $i + 1, $tagLength);
  638. $nextOffset = $i + $tagLength + 1;
  639. $nextOffset += strspn($value, ' ', $nextOffset);
  640. if ('' === $tag && (!isset($value[$nextOffset]) || \in_array($value[$nextOffset], [']', '}', ','], true))) {
  641. throw new ParseException('Using the unquoted scalar value "!" is not supported. You must quote it.', self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  642. }
  643. // Is followed by a scalar and is a built-in tag
  644. if ('' !== $tag && (!isset($value[$nextOffset]) || !\in_array($value[$nextOffset], ['[', '{'], true)) && ('!' === $tag[0] || \in_array($tag, ['str', 'php/const', 'php/enum', 'php/object'], true))) {
  645. // Manage in {@link self::evaluateScalar()}
  646. return null;
  647. }
  648. $i = $nextOffset;
  649. // Built-in tags
  650. if ('' !== $tag && '!' === $tag[0]) {
  651. throw new ParseException(sprintf('The built-in tag "!%s" is not implemented.', $tag), self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  652. }
  653. if ('' !== $tag && !isset($value[$i])) {
  654. throw new ParseException(sprintf('Missing value for tag "%s".', $tag), self::$parsedLineNumber + 1, $value, self::$parsedFilename);
  655. }
  656. if ('' === $tag || Yaml::PARSE_CUSTOM_TAGS & $flags) {
  657. return $tag;
  658. }
  659. 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);
  660. }
  661. public static function evaluateBinaryScalar(string $scalar): string
  662. {
  663. $parsedBinaryData = self::parseScalar(preg_replace('/\s/', '', $scalar));
  664. if (0 !== (\strlen($parsedBinaryData) % 4)) {
  665. 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);
  666. }
  667. if (!Parser::preg_match('#^[A-Z0-9+/]+={0,2}$#i', $parsedBinaryData)) {
  668. throw new ParseException(sprintf('The base64 encoded data (%s) contains invalid characters.', $parsedBinaryData), self::$parsedLineNumber + 1, $scalar, self::$parsedFilename);
  669. }
  670. return base64_decode($parsedBinaryData, true);
  671. }
  672. private static function isBinaryString(string $value): bool
  673. {
  674. return !preg_match('//u', $value) || preg_match('/[^\x00\x07-\x0d\x1B\x20-\xff]/', $value);
  675. }
  676. /**
  677. * Gets a regex that matches a YAML date.
  678. *
  679. * @see http://www.yaml.org/spec/1.2/spec.html#id2761573
  680. */
  681. private static function getTimestampRegex(): string
  682. {
  683. return <<<EOF
  684. ~^
  685. (?P<year>[0-9][0-9][0-9][0-9])
  686. -(?P<month>[0-9][0-9]?)
  687. -(?P<day>[0-9][0-9]?)
  688. (?:(?:[Tt]|[ \t]+)
  689. (?P<hour>[0-9][0-9]?)
  690. :(?P<minute>[0-9][0-9])
  691. :(?P<second>[0-9][0-9])
  692. (?:\.(?P<fraction>[0-9]*))?
  693. (?:[ \t]*(?P<tz>Z|(?P<tz_sign>[-+])(?P<tz_hour>[0-9][0-9]?)
  694. (?::(?P<tz_minute>[0-9][0-9]))?))?)?
  695. $~x
  696. EOF;
  697. }
  698. /**
  699. * Gets a regex that matches a YAML number in hexadecimal notation.
  700. */
  701. private static function getHexRegex(): string
  702. {
  703. return '~^0x[0-9a-f_]++$~i';
  704. }
  705. }