Inline.php 32 KB

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